-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
2366 lines (2356 loc) · 74.9 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Visier Data and Job Handling APIs
description: Visier APIs for data and job handling
version: 22222222.99201.1256
license:
name: Apache License, Version 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
x-api-status-urls: false
servers:
- url: https://{vanity-name}.api.visier.io
variables:
vanity-name:
default: vanity
tags:
- name: DataAndJobHandling
paths:
/v1/op/data-connector-credentials:
get:
tags:
- DataAndJobHandling
summary: Retrieve a list of all data connector credentials
operationId: DataAndJobHandling_DataConnectorCredentials
description: >-
Use this API to retrieve a list of the connector credentials in a
specified tenant. Connector credentials allow
Visier to retrieve data from your source systems through an integration user in the source system.
parameters:
- description: >-
The tenant code of a specific analytic tenant that you want to
retrieve for.
name: tenantCode
in: query
schema:
type: string
- description: The limit to retrieve.
name: limit
in: query
schema:
type: integer
format: int32
- description: >-
The index to start retrieving results from, also known as offset.
The index begins at 0.
name: start
in: query
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractorCredentialsAPIDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
post:
tags:
- DataAndJobHandling
summary: Create a connector credential
operationId: DataAndJobHandling_CreateConnectorCredential
description: >-
Use this API to create connector credentials for a specified tenant.
Connector credentials allow Visier to
retrieve data from your source systems through an integration user in the source system.
parameters:
- description: >-
The tenant code of a specific analytic tenant that you want to
create the credential for.
name: tenantCode
in: query
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DataProviderAuthInformationDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialCreationAPIResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/op/data-connectors:
get:
tags:
- DataAndJobHandling
summary: Retrieve a list of all data connectors
operationId: DataAndJobHandling_DataConnectors
description: >-
Use this API to retrieve a list of the data connectors in a specified
tenant. Data connectors are an alternative
to generating flat files and transferring them to Visier via SFTP.
parameters:
- description: >-
The tenant code of a specific analytic tenant that you want to
retrieve for.
name: tenantCode
in: query
schema:
type: string
- description: The limit to retrieve.
name: limit
in: query
schema:
type: integer
format: int32
- description: >-
The index to start retrieving results from, also known as offset.
The index begins at 0.
name: start
in: query
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ImportDefinitionsAPIDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/op/data-connectors/assignCredentials:
post:
tags:
- DataAndJobHandling
summary: Assign connector credentials to data connectors
operationId: DataAndJobHandling_AssignConnectorCredential
description: >-
This API allows you to assign a connector credential to a data
connector.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AssignConnectorCredentialRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AssignConnectorCredentialsResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/op/data-versions:
get:
tags:
- DataAndJobHandling
summary: Retrieve the latest enabled data versions for all analytic tenants
operationId: DataAndJobHandling_LatestEnabledDV
description: >-
If you discover any inconsistencies after running metric value
validation, you may want to find the data versions
causing inconsistencies so you can later disable them.
Use this API to retrieve up to five (5) of the latest enabled data versions for all your analytic tenants or a
single specified analytic tenant.
parameters:
- description: >-
The tenant code of a specific analytic tenant that you want to
retrieve data versions for.
Use this if you are only interested in the results for one analytic tenant.
name: tenantCode
in: query
schema:
type: string
- description: |-
The limit of analytic tenants to retrieve data versions for.
This parameter is not used if the tenantCode parameter is specified.
name: limit
in: query
schema:
type: integer
format: int32
- description: >-
The index to start retrieving results from, also known as offset.
The index begins at 0.
name: start
in: query
schema:
type: integer
format: int32
- description: >-
The number of latest enabled data versions to retrieve. The maximum
value is 5.
name: numberOfVersions
in: query
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MultipleTenantDataVersionsListDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/op/data-versions/disable:
put:
tags:
- DataAndJobHandling
summary: Disable data versions for a list of analytic tenants
operationId: DataAndJobHandling_DisableDV
description: >-
If you discover that a data version is not what is expected after
running metric value validation on a data load,
you may want to disable the data version for that processing job.
Use this API to disable the latest enabled data versions for affected analytic tenants or to disable a particular
data version for each analytic tenant.
Note: Disabling an older data version may not have an effect on the state of the solution.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DisableDVRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DisableDVResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/op/data/startExtractAndLoad:
post:
tags:
- DataAndJobHandling
summary: Trigger extraction jobs
operationId: DataAndJobHandling_StartExtraction
description: >-
Use this API to generate extraction jobs for a list of analytic tenants
or for the administrating tenant.
This API creates a dispatching job that generates one extraction job per tenant. The extraction jobs retrieve
data from your source systems through data connectors. The dispatching job is the "parent" of the extraction
jobs and its job ID is returned in the response.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StartExtractionRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/StartExtractionResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/op/data/startload:
post:
tags:
- DataAndJobHandling
summary: Start the data load for an analytic tenant
operationId: DataAndJobHandling_StartLoad
description: >-
This API starts the data load process for all analytic tenants included
in the specified data files uploaded
to the Visier SFTP server. On success, you receive a job ID that can be filtered and searched for within the
Jobs room in Visier. This job ID is associated with the receiving job, and related to all processing jobs that
spawn for each analytic tenant.
With the job ID, you can also call the next two APIs to retrieve the status of the receiving job and the status
list of all related processing jobs.
**Prerequisite:** You must first obtain Visier's public encryption key and upload the source data files to Visier's
SFTP server. Files must have a .zip.gpg extension, meaning the files are encrypted using the PGP protocol and compressed.
Visier provides SFTP server credentials and instructions. You can find the encryption key at https://www.visier.com/pgp/visier.public.pgp.asc.
After downloading the file, open the file in a text editor or by dragging it into your browser.
**Note:**
- To see the full status of all analytic tenant data loads, navigate to the Jobs room in a project.
- For performance and efficiency, Visier requires that the uncompressed batch file size is below 5 GB and that no
more than 5000 tenants are included in a batch.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DataLoadRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DataLoadResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/op/data/uploads:
get:
tags:
- DataAndJobHandling
summary: Retrieve data uploads
operationId: DataAndJobHandling_RetrieveDataUploads
description: >-
Use this API to retrieve the data uploads and whether they're included
in one of:
- A list of analytic tenants managed by you.
- A single specified analytic tenant.
- An upload job.
parameters:
- description: >-
The job ID of an upload job. Use this if you are interested in the
data uploads for a specific upload job.
name: uploadJobId
in: query
schema:
type: string
- description: >-
The tenant code of a specific analytic tenant that you want to
retrieve the data uploads for.
name: tenantCode
in: query
schema:
type: integer
format: int32
- description: >-
The limit of analytic tenants to retrieve data uploads for. This
parameter is not used if the tenantCode parameter is specified.
name: limit
in: query
schema:
type: integer
format: int32
- description: >-
The index to start retrieving results from, also known as offset.
The index begins at 0.
name: start
in: query
schema:
type: integer
format: int32
- description: >-
The maximum number of latest enabled data uploads to retrieve for
each analytic tenant. The maximum value is 5.
name: numberOfDataUploads
in: query
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TenantDataUploadsListResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/op/data/uploads/exclude:
put:
tags:
- DataAndJobHandling
summary: Exclude data uploads
operationId: DataAndJobHandling_ExcludeDataUplaods
description: >-
Use this API to exclude either a specified list of data uploads or all
data uploads for each analytic tenant.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExcludeDataUploadsRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TenantDataUploadsUpdateResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/op/data/uploads/include:
put:
tags:
- DataAndJobHandling
summary: Include data uploads
operationId: DataAndJobHandling_IncludeDataUploads
description: >-
Use this API to include either the specified list of data uploads or all
data uploads for each analytic tenant.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IncludeDataUploadsRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TenantDataUploadsUpdateResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/op/job-status/jobs:
get:
tags:
- DataAndJobHandling
summary: Retrieve the statuses of all jobs
operationId: DataAndJobHandling_JobStatus
description: Use this API to retrieve the list of statuses for all jobs.
parameters:
- description: The start time from which to retrieve job statuses.
name: startTime
in: query
schema:
type: string
- description: The end time from which to retrieve job statuses.
name: endTime
in: query
schema:
type: string
- description: The specific status to restrict the list of job to.
name: status
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ReceivingJobStatusResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/op/job-status/jobs/:jobId:
get:
tags:
- DataAndJobHandling
summary: Retrieve a specific job's status
operationId: DataAndJobHandling_JobIdStatus
description: >-
Use this API to retrieve the list of statuses for a specific job with id
`jobId`.
parameters:
- description: The unique ID of the job to retrieve the status for.
name: jobId
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ReceivingJobStatusResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/op/jobs/cancel:
post:
tags:
- DataAndJobHandling
summary: Cancel a list of jobs
operationId: DataAndJobHandling_CancelJobs
description: >-
Use this API to cancel a list of processing jobs, upload jobs, receiving
jobs, and extraction jobs.
Note: Receiving jobs with the Running status cannot be cancelled.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CancelJobBatchFromJobIdDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/JobCancellationResultsDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/op/jobs/dispatching-jobs/:jobId:
get:
tags:
- DataAndJobHandling
summary: Retrieve a dispatching job's status
operationId: DataAndJobHandling_DispatchingJobStatus
description: >-
Use this API to retrieve the status of a dispatching job, including its
job ID and the number of jobs it generated.
parameters:
- description: The ID of the job you want to retrieve.
name: jobId
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DispatchingJobStatusResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/op/jobs/dispatching-jobs/:jobId/extraction-jobs:
get:
tags:
- DataAndJobHandling
summary: Retrieve a dispatching job's extraction jobs with their statuses
operationId: DataAndJobHandling_ExtractionJobAndStatus
description: >-
Use this API to retrieve the statuses of extraction jobs associated with
a dispatching job. The dispatching job
is a "parent" to extraction jobs, which retrieve data from your source systems through data connectors.
parameters:
- description: The ID of the dispatching job that generated the extraction jobs.
name: dispatchingJobId
in: query
schema:
type: string
- description: >-
The tenant code of a specific analytic tenant that you want to
retrieve the extraction job status for.
Use this if you are only interested in the results for one analytic tenant.
name: tenantCode
in: query
schema:
type: string
- description: The limit of extraction job statuses to retrieve.
name: limit
in: query
schema:
type: integer
format: int32
- description: >-
The index to start retrieving results from, also known as offset.
The index begins at 0.
name: start
in: query
schema:
type: integer
format: int32
- description: The ID of the dispatching job you want to retrieve.
name: jobId
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractionJobAndStatusResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/op/jobs/dispatching-jobs/:jobId/processing-jobs:
get:
tags:
- DataAndJobHandling
summary: Retrieve a dispatching job's processing jobs with their statuses
operationId: DataAndJobHandling_ProcessingJobAndStatus
description: >-
Use this API to retrieve the statuses of processing jobs associated with
a dispatching job. The dispatching job
is a "parent" to extraction jobs, which in turn generate processing jobs and receiving jobs.
parameters:
- description: The ID of the dispatching job that generated the extraction jobs.
name: dispatchingJobId
in: query
schema:
type: string
- description: >-
The tenant code of a specific analytic tenant that you want to
retrieve the extraction job status for.
Use this if you are only interested in the results for one analytic tenant.
name: tenantCode
in: query
schema:
type: string
- description: The limit of extraction job statuses to retrieve.
name: limit
in: query
schema:
type: integer
format: int32
- description: >-
The index to start retrieving results from, also known as offset.
The index begins at 0.
name: start
in: query
schema:
type: integer
format: int32
- description: The ID of the dispatching job you want to retrieve.
name: jobId
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessingJobAndStatusResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/op/jobs/dispatching-jobs/:jobId/receiving-jobs:
get:
tags:
- DataAndJobHandling
summary: Retrieve a dispatching job's receiving jobs with their statuses
operationId: DataAndJobHandling_ReceivingJobAndStatus
description: >-
Use this API to retrieve the statuses of receiving jobs associated with
a dispatching job. The dispatching job
is a "parent" to extraction jobs, which in turn generate processing jobs and receiving jobs.
parameters:
- description: The ID of the dispatching job that generated the extraction jobs.
name: dispatchingJobId
in: query
schema:
type: string
- description: >-
The tenant code of a specific analytic tenant that you want to
retrieve the extraction job status for.
Use this if you are only interested in the results for one analytic tenant.
name: tenantCode
in: query
schema:
type: string
- description: The limit of extraction job statuses to retrieve.
name: limit
in: query
schema:
type: integer
format: int32
- description: >-
The index to start retrieving results from, also known as offset.
The index begins at 0.
name: start
in: query
schema:
type: integer
format: int32
- description: The ID of the dispatching job you want to retrieve.
name: jobId
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ReceivingJobAndStatusResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/op/jobs/processing-jobs/:receivingJobId:
get:
tags:
- DataAndJobHandling
summary: Retrieve processing job statuses by receiving job ID
operationId: DataAndJobHandling_ProcessingJobStatus
description: >-
Use this API to retrieve a list of statuses for all processing jobs
associated with the given receiving job ID.
Processing jobs deal with an individual analytic tenant's data load. A processing job is either triggered through
the UI or is one of many processing jobs spawned from a receiving job. When a processing job is triggered as part
of a set from an receiving job, it is associated to the receiving job through a Parent ID.
parameters:
- description: >-
The tenant code of the tenant you want to retrieve the processing
jobs for.
Use this if you are only interested in the results for one analytic tenant.
name: tenantCode
in: query
schema:
type: string
- description: The limit of processing jobs to retrieve per page.
name: limit
in: query
schema:
type: integer
format: int32
- description: >-
The index to start retrieving results from, also known as offset.
The index begins at 0.
name: start
in: query
schema:
type: integer
format: int32
- description: The receiving job ID
name: receivingJobId
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessingJobStatusResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/op/jobs/receiving-jobs/:receivingJobId:
get:
tags:
- DataAndJobHandling
summary: Retrieve a receiving job's status
operationId: DataAndJobHandling_ReceivingJobStatus
description: >-
After sending data to Visier, you may want to know the status of the
receiving job and the associated tenant
receiving jobs. A receiving job validates the transferred data and adds the transferred data to Visier's data
store.
Use this API to retrieve the receiving job status and summary of analytic tenant receiving jobs.
parameters:
- description: >-
If "true", returns the status of receiving jobs spawned by the
receiving job specified by jobId.
name: jobs
in: query
schema:
type: boolean
- description: >-
The tenant code of the tenant you want to retrieve the receiving
jobs for. Use this if you are only interested
in the results for one analytic tenant.
name: tenantCode
in: query
schema:
type: string
- description: >-
The index to start retrieving results from, also known as offset.
The index begins at 0.
name: start
in: query
schema:
type: integer
format: int32
- description: The number of job statuses to return per page.
name: limit
in: query
schema:
type: integer
format: int32
- description: The jobId provided after sending data to Visier.
name: receivingJobId
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ReceivingJobStatusResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/op/data-connector-credentials/:id:
delete:
tags:
- DataAndJobHandling
summary: Delete a connector credential
operationId: DataAndJobHandling_DeleteConnectorCredential
description: >-
Use this API to delete connector credentials from your tenants.
Credentials that are no longer valid
should be deleted.
parameters:
- description: The credentialId of the credential you want to delete.
name: id
in: query
schema:
type: string
- description: >-
The tenant code of the analytic tenant in which the credential
you're deleting.
name: tenantCode
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: >-
#/components/schemas/DataAndJobHandlingDeleteConnectorCredentialResponse
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
components:
schemas:
AdpAuthParamsDTO:
type: object
properties:
authCode:
type: string
AssignConnectorCredentialRequest:
type: object
properties:
connectors:
description: >-
A list of objects representing the data connectors to be assigned
with credentials.
type: array
items:
$ref: '#/components/schemas/Connector'
AssignConnectorCredentialsByTenantResponseDTO:
type: object
properties:
tenantCode:
description: The unique identifier associated with the tenant.
type: string
connectors:
description: >-
A list of objects representing the assigned credentials and
connectors.
type: array
items:
$ref: '#/components/schemas/AssignConnectorWithCredentialsResponseDTO'
status:
description: >-
The state of the credential assignment. Valid values are Succeed or
Failed.
enum:
- Unknown
- Succeed
- Failed
type: string
format: enum
message:
type: string
AssignConnectorCredentialsResponseDTO:
type: object
properties:
tenants:
description: >-
A list of objects representing the tenants and data connectors that
were assigned connector credentials.
type: array
items:
$ref: '#/components/schemas/AssignConnectorCredentialsByTenantResponseDTO'
AssignConnectorWithCredentialsResponseDTO:
type: object
properties:
connector:
$ref: '#/components/schemas/ConnectorInfoResponseDTO'
credential:
$ref: '#/components/schemas/AssignedCredentialInfoResponseDTO'
x-konfig-properties:
connector:
description: The data connector that was assigned a connector credential.
credential:
description: A connector credential that was assigned to a data connector
AssignedCredentialInfoResponseDTO:
type: object
properties:
credentialId:
description: The unique identifier associated with the user.
type: string
displayName:
description: >-
The user's username. This is typically the user's email, such as
john@visier.com.
type: string
message:
type: string
BambooAuthParamsDTO:
type: object
properties:
accessKey:
type: string
tenantDomainName:
type: string
BasicS3AuthParamsDTO:
type: object
properties:
bucketName:
type: string
bucketRegion:
type: string
accessKey:
type: string
secretKey:
type: string
path:
type: string
BigQueryAuthParamsDTO: