-
Notifications
You must be signed in to change notification settings - Fork 0
/
marketo-identity.yaml
9363 lines (9363 loc) · 283 KB
/
marketo-identity.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
swagger: '2.0'
info:
description: Marketo Rest API
version: '1.0'
title: Marketo Rest API
termsOfService: https://www.marketo.com/company/legal/
contact:
name: Marketo Developer Relations
url: http://developers.marketo.com
email: developerfeedback@marketo.com
license:
name: API License Agreement
url: http://developers.marketo.com/api-license/
host: localhost:8080
basePath: /
schemes:
- https
tags:
- name: Leads
description: Leads Controller
- name: Sales Persons
description: Sales Persons Controller
- name: Activities
description: Activities Controller
- name: Bulk Import Custom Objects
description: Bulk Import Custom Objects Controller
- name: Bulk Import Program Members
description: Bulk Import Program Members Controller
- name: Campaigns
description: Campaigns Controller
- name: Opportunities
description: Opportunities Controller
- name: Custom Objects
description: Custom Objects Controller
- name: Usage
description: Stats Controller
- name: Bulk Import Leads
description: Bulk Import Leads Controller
- name: Static Lists
description: Lists Controller
- name: Bulk Export Activities
description: Bulk Export Activities Controller
- name: Named Account Lists
description: Named Account Lists Controller
- name: Bulk Export Leads
description: Bulk Export Leads Controller
- name: Bulk Export Program Members
description: Bulk Export Program Members Controller
- name: Bulk Export Custom Objects
description: Bulk Export Custom Objects Controller
- name: Companies
description: Companies Controller
- name: Named Accounts
description: Named Accounts Controller
- name: Program Members
description: Program Members Controller
paths:
/bulk/v1/activities/export.json:
get:
tags:
- Bulk Export Activities
summary: Get Export Activity Jobs
description: >-
Returns a list of export jobs that were created in the past 7 days.
Required Permissions: Read-Only Activity
operationId: getExportActivitiesUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: status
in: query
description: Comma separated list of statuses to filter on.
required: false
type: array
items:
type: string
collectionFormat: multi
enum:
- created
- queued
- processing
- cancelled
- completed
- failed
- name: batchSize
in: query
description: The batch size to return. The max and default value is 300.
required: false
type: integer
format: int32
- name: nextPageToken
in: query
description: >-
A token will be returned by this endpoint if the result set is
greater than the batch size and can be passed in a subsequent call
through this parameter. See Paging Tokens for more info.
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResponseOfExportResponseWithToken'
/bulk/v1/activities/export/create.json:
post:
tags:
- Bulk Export Activities
summary: Create Export Activity Job
description: >-
Create export job for search criteria defined via "filter" parameter.
Request returns the "exportId" which is passed as a parameter in
subsequent calls to Bulk Export Activities endpoints. Use Enqueue Export
Activity Job endpoint to queue the export job for processing. Use Get
Export Activity Job Status endpoint to retrieve status of export job.
Required Permissions: Read-Only Activity
operationId: createExportActivitiesUsingPOST
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: exportActivityRequest
description: >-
exportActivityRequest<br><br>ColumnHeaderNames: A JSON object
containing key-value pairs of field and column header
names.<br><br>Example:<br><code>"columnHeaderNames":{<br>
"primaryAttributeValueId":"Attribute ID",<br>
"primaryAttributeValue":"Attribute Value",<br>
"attributes":"Secondary Attributes"<br>}</code><br>
required: false
schema:
$ref: '#/definitions/ExportActivityRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResponseOfExportResponse'
/bulk/v1/activities/export/{exportId}/cancel.json:
post:
tags:
- Bulk Export Activities
summary: Cancel Export Activity Job
description: 'Cancel export job. Required Permissions: Read-Only Activity'
operationId: cancelExportActivitiesUsingPOST
consumes:
- application/json
produces:
- application/json
parameters:
- name: exportId
in: path
description: Id of export batch job.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResponseOfExportResponse'
/bulk/v1/activities/export/{exportId}/enqueue.json:
post:
tags:
- Bulk Export Activities
summary: Enqueue Export Activity Job
description: >-
Enqueue export job. This will place export job in queue, and will start
the job when computing resources become available. The export job must
be in "Created" state. Use Get Export Activity Job Status endpoint to
retrieve status of export job. Required Permissions: Read-Only Activity
operationId: enqueueExportActivitiesUsingPOST
consumes:
- application/json
produces:
- application/json
parameters:
- name: exportId
in: path
description: Id of export batch job.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResponseOfExportResponse'
/bulk/v1/activities/export/{exportId}/file.json:
get:
tags:
- Bulk Export Activities
summary: Get Export Activity File
description: >-
Returns the file content of an export job. The export job must be in
"Completed" state. Use Get Export Activity Job Status endpoint to
retrieve status of export job. Required Permissions: Read-Only
Activity<br><br>The file format is specified by calling the Create
Export Activity Job endpoint. The following is an example of the default
file format ("CSV"). Note that the "attributes" field is formatted as
JSON.<br><br><code>marketoGUID,leadId,activityDate,activityTypeId,campaignId,primaryAttributeValueId,primaryAttributeValue,
attributes</code><br><code>122323,6,2013-09-26T06:56:35+0000,12,11,6,Owyliphys
Iledil,[{"name":"Source Type","value":"Web page visit"}]</code>
operationId: getExportActivitiesFileUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: exportId
in: path
description: Id of export batch job.
required: true
type: string
- name: Range
in: header
description: >-
To support partial retrieval of extracted data, the HTTP header
"Range" of type "bytes" may be specified. See RFC 2616 "Range
Retrieval Requests" for more information. If the header is not set,
the entire contents will be returned.
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ObservableOfInputStreamRangeContent'
/bulk/v1/activities/export/{exportId}/status.json:
get:
tags:
- Bulk Export Activities
summary: Get Export Activity Job Status
description: >-
Returns status of an export job. Job status is available for 30 days
after Completed or Failed status was reached. Required Permissions:
Read-Only Activity
operationId: getExportActivitiesStatusUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: exportId
in: path
description: Id of export batch job.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResponseOfExportResponse'
/bulk/v1/customobjects/{apiName}/import.json:
post:
tags:
- Bulk Import Custom Objects
summary: Import Custom Objects
description: >-
Imports a file containing data records into the target instance.
Required Permissions: Read-Write Custom Object
operationId: importCustomObjectUsingPOST
consumes:
- multipart/form-data
produces:
- application/json
parameters:
- name: apiName
in: path
description: API Name of the custom object for the import batch job.
required: true
type: string
- name: format
in: query
description: Import file format.
required: true
type: string
enum:
- csv
- tsv
- ssv
- name: file
in: formData
description: File containing the data records to import.
required: true
type: file
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResponseOfImportCustomObjectResponse'
/bulk/v1/customobjects/{apiName}/import/{batchId}/failures.json:
get:
tags:
- Bulk Import Custom Objects
summary: Get Import Custom Object Failures
description: >-
Returns the list of failures for the import batch job. Required
Permissions: Read-Write Custom Object
operationId: getImportCustomObjectFailuresUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: apiName
in: path
description: API Name of the custom object for the import batch job.
required: true
type: string
- name: batchId
in: path
description: Id of the import batch job.
required: true
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ObservableOfInputStreamContent'
/bulk/v1/customobjects/{apiName}/import/{batchId}/status.json:
get:
tags:
- Bulk Import Custom Objects
summary: Get Import Custom Object Status
description: >-
Returns the status of an import batch job. Required Permissions:
Read-Write Custom Object
operationId: getImportCustomObjectStatusUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: apiName
in: path
description: API Name of the custom object for the import batch job.
required: true
type: string
- name: batchId
in: path
description: Id of the import batch job.
required: true
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResponseOfImportCustomObjectResponse'
/bulk/v1/customobjects/{apiName}/import/{batchId}/warnings.json:
get:
tags:
- Bulk Import Custom Objects
summary: Get Import Custom Object Warnings
description: >-
Returns the list of warnings for the import batch job. Required
Permissions: Read-Write Custom Object
operationId: getImportCustomObjectWarningsUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: apiName
in: path
description: API Name of the custom object for the import batch job.
required: true
type: string
- name: batchId
in: path
description: Id of the import batch job.
required: true
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ObservableOfInputStreamContent'
/bulk/v1/program/{programId}/members/import.json:
post:
tags:
- Bulk Import Program Members
summary: Import Program Members
description: >-
Imports a file containing data records into the target instance.
Required Permissions: Read-Write Lead
operationId: importProgramMemberUsingPOST
consumes:
- multipart/form-data
produces:
- application/json
parameters:
- name: programId
in: path
description: Id of the program to add members to.
required: true
type: string
- name: programMemberStatus
in: query
description: Program member status for members being added.
required: true
type: string
- name: format
in: query
description: Import file format.
required: true
type: string
enum:
- CSV
- TSV
- SSV
- name: file
in: formData
description: File containing the data records to import.
required: true
type: file
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResponseOfImportProgramMemberResponse'
/bulk/v1/program/members/import/{batchId}/failures.json:
get:
tags:
- Bulk Import Program Members
summary: Get Import Program Member Failures
description: >-
Returns the list of failures for the import batch job. Required
Permissions: Read-Write Lead
operationId: getImportProgramMemberFailuresUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: batchId
in: path
description: Id of the import batch job.
required: true
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ObservableOfInputStreamContent'
/bulk/v1/program/members/import/{batchId}/status.json:
get:
tags:
- Bulk Import Program Members
summary: Get Import Program Member Status
description: >-
Returns the status of an import batch job. Required Permissions:
Read-Write Lead
operationId: getImportProgramMemberStatusUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: batchId
in: path
description: Id of the import batch job.
required: true
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResponseOfImportProgramMemberResponse'
/bulk/v1/program/members/import/{batchId}/warnings.json:
get:
tags:
- Bulk Import Program Members
summary: Get Import Program Member Warnings
description: >-
Returns the list of warnings for the import batch job. Required
Permissions: Read-Write Lead
operationId: getImportProgramMemberWarningsUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: batchId
in: path
description: Id of the import batch job.
required: true
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ObservableOfInputStreamContent'
/bulk/v1/leads.json:
post:
tags:
- Bulk Import Leads
summary: Import Leads
description: >-
Imports a file containing data records into the target instance.
Required Permissions: Read-Write Lead
operationId: importLeadUsingPOST
consumes:
- multipart/form-data
produces:
- application/json
parameters:
- name: format
in: query
description: Import file format.
required: true
type: string
enum:
- csv
- tsv
- ssv
- name: lookupField
in: query
description: >-
Field to use for deduplication. Custom fields (string, email,
integer), and the following field types are supported: id, cookies,
email, twitterId, facebookId, linkedInId, sfdcAccountId,
sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, sfdcOpptyId. Default is
email.<br>Note: You can use id for update only operations.
required: false
type: string
- name: partitionName
in: query
description: Name of the lead partition to import to.
required: false
type: string
- name: listId
in: query
description: Id of the static list to import into.
required: false
type: integer
format: int32
- name: file
in: formData
description: File containing the data records to import.
required: true
type: file
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResponseOfImportLeadResponse'
/bulk/v1/leads/batch/{batchId}.json:
get:
tags:
- Bulk Import Leads
summary: Get Import Lead Status
description: >-
Returns the status of an import batch job. Required Permissions:
Read-Write Lead
operationId: getImportLeadStatusUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: batchId
in: path
description: Id of the import batch job.
required: true
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResponseOfImportLeadResponse'
/bulk/v1/leads/batch/{batchId}/failures.json:
get:
tags:
- Bulk Import Leads
summary: Get Import Lead Failures
description: >-
Returns the list of failures for the import batch job. Required
Permissions: Read-Write Lead
operationId: getImportLeadFailuresUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: batchId
in: path
description: Id of the import batch job.
required: true
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ObservableOfInputStreamContent'
/bulk/v1/leads/batch/{batchId}/warnings.json:
get:
tags:
- Bulk Import Leads
summary: Get Import Lead Warnings
description: >-
Returns the list of warnings for the import batch job. Required
Permissions: Read-Write Lead
operationId: getImportLeadWarningsUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: batchId
in: path
description: Id of the import batch job.
required: true
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ObservableOfInputStreamContent'
/bulk/v1/leads/export.json:
get:
tags:
- Bulk Export Leads
summary: Get Export Lead Jobs
description: >-
Returns a list of export jobs that were created in the past 7 days.
Required Permissions: Read-Only Lead
operationId: getExportLeadsUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: status
in: query
description: Comma separated list of statuses to filter on.
required: false
type: array
items:
type: string
collectionFormat: multi
enum:
- created
- queued
- processing
- cancelled
- completed
- failed
- name: batchSize
in: query
description: The batch size to return. The max and default value is 300.
required: false
type: integer
format: int32
- name: nextPageToken
in: query
description: >-
A token will be returned by this endpoint if the result set is
greater than the batch size and can be passed in a subsequent call
through this parameter. See Paging Tokens for more info.
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResponseOfExportResponseWithToken'
/bulk/v1/leads/export/create.json:
post:
tags:
- Bulk Export Leads
summary: Create Export Lead Job
description: >-
Create export job for search criteria defined via "filter" parameter.
Request returns the "exportId" which is passed as a parameter in
subsequent calls to Bulk Export Leads endpoints. Use Enqueue Export Lead
Job endpoint to queue the export job for processing. Use Get Export Lead
Job Status endpoint to retrieve status of export job. Required
Permissions: Read-Only Lead
operationId: createExportLeadsUsingPOST
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: exportLeadRequest
description: >-
exportLeadRequest<br><br>ColumnHeaderNames: A JSON object containing
key-value pairs of field and column header
names.<br><br>Example:<br><code>"columnHeaderNames":{<br>
"firstName":"First Name",<br> "lastName":"Last Name",<br>
"email":"Email Address"<br>}</code><br>
required: false
schema:
$ref: '#/definitions/ExportLeadRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResponseOfExportResponse'
/bulk/v1/leads/export/{exportId}/cancel.json:
post:
tags:
- Bulk Export Leads
summary: Cancel Export Lead Job
description: 'Cancel export job. Required Permissions: Read-Only Lead'
operationId: cancelExportLeadsUsingPOST
consumes:
- application/json
produces:
- application/json
parameters:
- name: exportId
in: path
description: Id of export batch job.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResponseOfExportResponse'
/bulk/v1/leads/export/{exportId}/enqueue.json:
post:
tags:
- Bulk Export Leads
summary: Enqueue Export Lead Job
description: >-
Enqueue export job. This will place export job in queue, and will start
the job when computing resources become available. The export job must
be in "Created" state. Use Get Export Lead Job Status endpoint to
retrieve status of export job. Required Permissions: Read-Only Lead
operationId: enqueueExportLeadsUsingPOST
consumes:
- application/json
produces:
- application/json
parameters:
- name: exportId
in: path
description: Id of export batch job.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResponseOfExportResponse'
/bulk/v1/leads/export/{exportId}/file.json:
get:
tags:
- Bulk Export Leads
summary: Get Export Lead File
description: >-
Returns the file content of an export job. The export job must be in
"Completed" state. Use Get Export Lead Job Status endpoint to retrieve
status of export job. Required Permissions: Read-Only Lead<br><br>The
file format is specified by calling the Create Export Lead Job endpoint.
The following is an example of the default file format
("CSV").<br><br><code>firstName,lastName,email</code><br><code>Marvin,Gaye,marvin.gaye@motown.com</code>
operationId: getExportLeadsFileUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: exportId
in: path
description: Id of export batch job.
required: true
type: string
- name: Range
in: header
description: >-
To support partial retrieval of extracted data, the HTTP header
"Range" of type "bytes" may be specified. See RFC 2616 "Range
Retrieval Requests" for more information. If the header is not set,
the entire contents will be returned.
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ObservableOfInputStreamRangeContent'
/bulk/v1/leads/export/{exportId}/status.json:
get:
tags:
- Bulk Export Leads
summary: Get Export Lead Job Status
description: >-
Returns status of an export job. Job status is available for 30 days
after Completed or Failed status was reached. Required Permissions:
Read-Only Lead
operationId: getExportLeadsStatusUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: exportId
in: path
description: Id of export batch job.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResponseOfExportResponse'
/bulk/v1/customobjects/{apiName}/export.json:
get:
tags:
- Bulk Export Custom Objects
summary: Get Export Custom Object Jobs
description: >-
Returns a list of export jobs that were created in the past 7 days.
Required Permissions: Read-Only Custom Object
operationId: getExportCustomObjectsUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: apiName
in: path
description: API Name of the custom object for the export batch job.
required: true
type: string
- name: status
in: query
description: Comma separated list of statuses to filter on.
required: false
type: array
items:
type: string
collectionFormat: multi
enum:
- created
- queued
- processing
- cancelled
- completed
- failed
- name: batchSize
in: query
description: The batch size to return. The max and default value is 300.
required: false
type: integer
format: int32
- name: nextPageToken
in: query
description: >-
A token will be returned by this endpoint if the result set is
greater than the batch size and can be passed in a subsequent call
through this parameter. See Paging Tokens for more info.
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResponseOfExportResponseWithToken'
/bulk/v1/customobjects/{apiName}/export/create.json:
post:
tags:
- Bulk Export Custom Objects
summary: Create Export Custom Object Job
description: >-
Create export job for search criteria defined via "filter" parameter.
Request returns the "exportId" which is passed as a parameter in
subsequent calls to Bulk Export Custom Object endpoints. Use Enqueue
Export Custom Object Job endpoint to queue the export job for
processing. Use Get Export Custom Object Job Status endpoint to retrieve
status of export job. Required Permissions: Read-Only Custom Object
operationId: createExportCustomObjectsUsingPOST
consumes:
- application/json
produces:
- application/json
parameters:
- name: apiName
in: path
description: API Name of the custom object for the export batch job.
required: true
type: string
- in: body
name: exportCustomObjectRequest
description: >-
exportCustomObjectRequest<br><br>ColumnHeaderNames: A JSON object
containing key-value pairs of custom object attributes and column
header names.<br><br>Example:<br><code>"columnHeaderNames":{<br>
"attrName1":"value1",<br> "attrName2":"value2",<br>
"attrName3":"value3"<br>}</code><br>
required: false
schema:
$ref: '#/definitions/ExportCustomObjectRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResponseOfExportResponse'
/bulk/v1/customobjects/{apiName}/export/{exportId}/cancel.json:
post:
tags:
- Bulk Export Custom Objects
summary: Cancel Export Custom Object Job
description: 'Cancel export job. Required Permissions: Read-Only Custom Object'
operationId: cancelExportCustomObjectsUsingPOST
consumes:
- application/json
produces:
- application/json
parameters:
- name: apiName
in: path
description: API Name of the custom object for the export batch job.
required: true
type: string
- name: exportId
in: path
description: Id of export batch job.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResponseOfExportResponse'
/bulk/v1/customobjects/{apiName}/export/{exportId}/enqueue.json:
post:
tags:
- Bulk Export Custom Objects
summary: Enqueue Export Custom Object Job
description: >-
Enqueue export job. This will place export job in queue, and will start
the job when computing resources become available. The export job must
be in "Created" state. Use Get Export Custom Object Job Status endpoint
to retrieve status of export job. Required Permissions: Read-Only Custom
Object
operationId: enqueueExportCustomObjectsUsingPOST
consumes:
- application/json
produces:
- application/json
parameters:
- name: apiName
in: path
description: API Name of the custom object for the export batch job.
required: true
type: string
- name: exportId
in: path
description: Id of export batch job.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResponseOfExportResponse'
/bulk/v1/customobjects/{apiName}/export/{exportId}/file.json:
get:
tags:
- Bulk Export Custom Objects
summary: Get Export Custom Object File
description: >-
Returns the file content of an export job. The export job must be in
"Completed" state. Use Get Export Custom Object Job Status endpoint to
retrieve status of export job. Required Permissions: Read-Only Custom
Object<br><br>The file format is specified by calling the Create Export
Custom Object Job endpoint. The following is an example of the default
file format
("CSV").<br><br><code>leadId,marketoGUID,itemName</code><br><code>11,c93f0494-bbd9-44e8-9c0e-dae9b525073f,Hoka
One One Mach 4</code>
operationId: getExportCustomObjectsFileUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: apiName
in: path
description: API Name of the custom object for the export batch job.
required: true
type: string
- name: exportId
in: path
description: Id of export batch job.
required: true