-
Notifications
You must be signed in to change notification settings - Fork 5
/
data-cloud-integration-api.raml
591 lines (536 loc) · 18.1 KB
/
data-cloud-integration-api.raml
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
#%RAML 1.0
title: Data Cloud Integration API
version: 1.1.0
types:
CustomErrorMessage:
properties:
error:
type: object
properties:
description:
type: string
example: Request returned status code 409
message:
type: string
example: The request conflicts with current state of the target resource.
statusCode:
type: number
example: 409
reasonPhrase:
type: string
example: Conflict
MuleRecommendation:
type: string
example: There probably is already a job in queue for this specific object. If you have the job ID, you can try getting the job's details to verify its state. If the state appears as InProgress, you will have to wait until Data Cloud finishes the processing (JobComplete/Failed) to try this operation again.
DataCloudSuccessfulResponse:
properties:
accepted:
default: true
example: true
type: boolean
DataCloudBulkJob:
properties:
object:
type: string
example: customer
id:
type: string
example: "asjdfl-a2452-vcc453545"
operation:
type: string
example: upsert
sourceName:
type: string
example: runner_profiles
createdById:
type: string
example: "06521s54JF"
createdDate:
type: string
example: "2024-07-11T20:15:00.000000Z"
systemModstamp:
type: string
example: ""
state:
type: string
example: UploadComplete
contentType:
type: string
example: CSV
apiVersion:
type: string
example: v1
contentUrl:
type: string
example: "/api/v1/ingest/jobs/asjdfl-a2452-vcc453545/batches"
retries:
type: number
example: 0
totalProcessingTime:
type: number
example: 0
traits:
dataCloudApiParams:
queryParameters:
sourceApiName:
displayName: Ingestion API's name
description: |
You can find this value by taking a look at your Ingestion API settings (where you uploaded the YAML schema) in Salesforce.
example: MuleSoft_Ingestion_API
type: string
objectName:
displayName: Ingestion API's object name
description: |
You can find this value by taking a look at your Ingestion API settings. This should be one of the objects you uploaded from the YAML schema in Salesforce. You should also be able to find this from your Data Stream settings.
example: runner_profiles
type: string
bulkApiCustomErrorResponse:
responses:
409:
body:
application/json:
type: CustomErrorMessage
404:
body:
application/json:
type: CustomErrorMessage
/schema:
post:
displayName: Get YAML Schema for Ingestion API
queryParameters:
openapiversion?:
default: 3.0.3
example: 3.0.3
type: string
body:
application/json:
example:
strict: true
value:
customer:
id: 1
first_name: Alex
last_name: Martinez
email: [email protected]
address:
street: 415 Mission Street
city: San Francisco
state: CA
postalCode: "94105"
geo:
lat: 37.78916
lng: -122.39521
type: object
responses:
"200":
body:
application/raml+yaml:
example:
strict: true
value:
openapi: 3.0.3
components:
schemas:
customer:
type: object
properties:
id:
type: number
first_name:
type: string
last_name:
type: string
email:
type: string
street:
type: string
city:
type: string
state:
type: string
postalCode:
type: string
lat:
type: number
lng:
type: number
type: object
description: |
With this endpoint, you can send a JSON object to be transformed into the OpenAPI YAML schema. This is needed to create your Ingestion API and Data Stream in Data Cloud.
Because the Ingestion API doesn't accept nested objects on the schema, this endpoint will transform your multi-level object into the single-level needed for Data Cloud.
For example, the following input payload:
```json
{
"customer": {
"id": 1,
"first_name": "Alex",
"last_name": "Martinez",
"email": "[email protected]",
"address": {
"street": "415 Mission Street",
"city": "San Francisco",
"state": "CA",
"postalCode": "94105",
"geo": {
"lat": 37.78916,
"lng": -122.39521
}
}
}
}
```
would be flattened and transformed into the following output:
```json
{
"customer": {
"id": 1,
"first_name": "Alex",
"last_name": "Martinez",
"email": "[email protected]",
"street": "415 Mission Street",
"city": "San Francisco",
"state": "CA",
"postalCode": "94105",
"lat": 37.78916,
"lng": -122.39521
}
}
```
then, based on this new input, you will receive the YAML schema like the following:
> ⚠️ **Important**
>
> Take note of the object(s) name(s) from this YAML schema because you will use them for the insertion and deletion.
> For example, in the following YAML schema, the object name is `customer`.
```yaml
openapi: 3.0.3
components:
schemas:
customer:
type: object
properties:
id:
type: number
first_name:
type: string
last_name:
type: string
email:
type: string
street:
type: string
city:
type: string
state:
type: string
postalCode:
type: string
lat:
type: number
lng:
type: number
```
> Important: Make sure you set the `openapiversion` query parameter to set the version. Otherwise, the default of `3.0.3` will be outputted.
/query:
post:
displayName: Perform a SOQL Query
body:
text/plain:
example: SELECT * FROM MuleSoft_Ingestion_API_runner_p_38447E8E__dll LIMIT 100
type: string
responses:
"200":
body:
application/json:
items:
example:
strict: true
value:
DataSourceObject__c: MuleSoft_Ingestion_API_runner_profiles_38447E8E
DataSource__c: MuleSoft_Ingestion_API_996db928_2078_4e3a_9c67_1c80b32790aa
city__c: Toronto
created__c: 2017-07-21
email__c: [email protected]
first_name__c: Alex
gender__c: NB
last_name__c: Martinez
maid__c: 1
state__c: ON
type: object
description: |
Send your SOQL query in the body of the request on a `text/plain` format.
For example:
```sql
SELECT * FROM MuleSoft_Ingestion_API_runner_p_38447E8E__dll LIMIT 100
```
You will receive a JSON response.
For example, from the previous query, you'd receive a JSON Array with the results of the `SELECT`:
```json
[
{
"DataSourceObject__c": "MuleSoft_Ingestion_API_runner_profiles_38447E8E",
"DataSource__c": "MuleSoft_Ingestion_API_996db928_2078_4e3a_9c67_1c80b32790aa",
"city__c": "Toronto",
"created__c": "2017-07-21",
"email__c": "[email protected]",
"first_name__c": "Alex",
"gender__c": "NB",
"last_name__c": "Martinez",
"maid__c": 1.000000000000000000,
"state__c": "ON"
}
]
```
/insert:
post:
displayName: Insert new records through streaming
is:
- dataCloudApiParams
body:
application/json:
items:
example:
strict: true
value:
maid: 1
first_name: Alex
last_name: Martinez
email: [email protected]
gender: NB
city: Toronto
state: ON
created: 2017-07-21
type: object
responses:
"200":
body:
application/json:
type: DataCloudSuccessfulResponse
description: |
Make sure you add the following query parameters to let Data Cloud know more information of where you want to insert new records:
- `sourceApiName` i.e., `MuleSoft_Ingestion_API`
- `objectName` i.e., `runner_profiles`
Next, in the body of the request, make sure to use a JSON Array. Each Object inside this Array is a new record.
For example:
```json
[
{
"maid": 1,
"first_name": "Alex",
"last_name": "Martinez",
"email": "[email protected]",
"gender": "NB",
"city": "Toronto",
"state": "ON",
"created": "2017-07-21"
}
]
```
If everything ran smoothly, you will receive a `200 - OK` successful response.
> ℹ️ **Note**
>
> It may take a few minutes for your data to be updated in Data Cloud. You can manually check the records in Data Cloud or wait to attempt the `/query` from your MuleSoft API.
/delete:
delete:
displayName: Delete existing records through streaming
is:
- dataCloudApiParams
body:
application/json:
items:
type:
anyOf:
-
displayName: string
type: string
example: ID123
-
displayName: number
type: number
format: int
example: 123
uniqueItems: true
example:
[ 1, 2, 3 ]
responses:
"200":
body:
application/json:
type: DataCloudSuccessfulResponse
description: |
Make sure you add the following query parameters to let Data Cloud know more information of where you want to delete the records from:
- `sourceApiName` i.e., `MuleSoft_Ingestion_API`
- `objectName` i.e., `runner_profiles`
Next, in the body of the request, make sure to use a JSON Array. Each Object inside this Array is the ID of the record to delete.
For example:
```json
[
1
]
```
If everything ran smoothly, you will receive a `200 - OK` successful response.
> ℹ️ **Note**
>
> It may take a few minutes for your data to be updated in Data Cloud. You can manually check the records in Data Cloud or wait to attempt the `/query` from your MuleSoft API.
/bulk:
get:
displayName: Retrieve the information for all the jobs
responses:
200:
body:
application/json:
type: array
items:
type: DataCloudBulkJob
description: |
There is no need to send additional information with this call. The Mule application will use the Data Cloud credentials you have configured to make the call to your Data Cloud instance.
If the call was successful, you will receive a `200 - OK` successful response with the list of the Data Cloud jobs you have access to. If no jobs are available, you will receive an empty array `[]`.
For example:
```json
[
{
"object": "customer",
"id": "f3a58-8d22-4a72-a41d-083c3c",
"operation": "upsert",
"sourceName": "MuleSoft_Customers",
"createdById": "0000AD",
"createdDate": "2024-07-11T20:15:00.000000Z",
"systemModstamp": "",
"state": "UploadComplete",
"contentType": "CSV",
"apiVersion": "v1",
"contentUrl": "/api/v1/ingest/jobs/f3a58-8d22-4a72-a41d-083c3c/batches",
"retries": 0,
"totalProcessingTime": 0
}
]
```
/upsert:
post:
displayName: Insert unexisting records or update existing ones in bulk
is:
- dataCloudApiParams
- bulkApiCustomErrorResponse
body:
text/plain:
example: |
id,first_name,last_name,email,street,city,state,postalCode,lat,lng
1,Alex,Martinez,[email protected],415 Mission Street,San Francisco,CA,94105,37.78916,-122.39521
2,Akshata,Sawant,[email protected],415 Mission Street,San Francisco,CA,94105,37.78916,-122.39521
3,Danielle,Larregui,[email protected],415 Mission Street,San Francisco,CA,94105,37.78916,-122.39521
application/json:
items:
example:
strict: true
value:
maid: 1
first_name: Alex
last_name: Martinez
email: [email protected]
gender: NB
city: Toronto
state: ON
created: 2017-07-21
type: object
responses:
"200":
body:
application/json:
type: DataCloudBulkJob
description: |
Make sure you add the following query parameters to let Data Cloud know more information of where you want to insert new records:
- `sourceApiName` i.e., `MuleSoft_Ingestion_API`
- `objectName` i.e., `runner_profiles`
Next, in the body of the request, make sure to use a JSON or CSV format, using application/json or text/plain content type respectively. The headers on the first line (for CSV) or the field names (for JSON) have to match the names of the fields in Data Cloud.
For example:
```csv
maid,first_name,last_name,email,gender,city,state,created
1,Alex,Martinez,[email protected],NB,Toronto,ON,2017-07-21
```
or
```json
[
{
"maid": 1,
"first_name": "Alex",
"last_name": "Martinez",
"email": "[email protected]",
"gender": "NB",
"city": "Toronto",
"state": "ON",
"created": "2017-07-21"
}
]
```
If everything ran smoothly, you will receive a `200 - OK` successful response with the details of the Job.
For example:
```json
{
"object": "customer",
"id": "f3a58-8d22-4a72-a41d-083c3c",
"operation": "upsert",
"sourceName": "MuleSoft_Customers",
"createdById": "0000AD",
"createdDate": "2024-07-11T20:15:00.000000Z",
"systemModstamp": "",
"state": "UploadComplete",
"contentType": "CSV",
"apiVersion": "v1",
"contentUrl": "/api/v1/ingest/jobs/f3a58-8d22-4a72-a41d-083c3c/batches",
"retries": 0,
"totalProcessingTime": 0
}
```
> ℹ️ **Note**
>
> It may take a few minutes/hours for your data to be updated in Data Cloud. You can manually check the records in Data Cloud, attempt the `/query` from your MuleSoft API, or attempt the `GET /bulk/{id}` from your MuleSoft API.
/{id}:
uriParameters:
id:
type: string
example: "f3a58-8d22-4a72-a41d-083c3c"
delete:
displayName: Close/Abort and Delete an existing bulk job
is:
- bulkApiCustomErrorResponse
responses:
"200":
body:
application/json:
type: DataCloudSuccessfulResponse
description: |
Deletes an existing bulk job based on its ID. Only the Job ID is needed, nothing else.
If the given job is still open (in an `Open` state), it will be aborted first in order to delete it. If the job has already been closed (`UploadComplete` state) and it's already in the queue, you will have to wait until it finishes processing in Data Cloud before attempting to delete again - you will receive a 409 error if this is the case.
If everything ran smoothly, you will receive a `200 - OK` successful response.
get:
displayName: Retrieve the information for a bulk job
is:
- dataCloudApiParams
- bulkApiCustomErrorResponse
responses:
"200":
body:
application/json:
type: DataCloudBulkJob
description: |
Make sure you add the following query parameters to let Data Cloud know more information of where you want to insert new records:
- `sourceApiName` i.e., `MuleSoft_Ingestion_API`
- `objectName` i.e., `runner_profiles`
If everything ran smoothly, you will receive a `200 - OK` successful response with the details of the Job.
For example:
```json
{
"object": "customer",
"id": "f3a58-8d22-4a72-a41d-083c3c",
"operation": "upsert",
"sourceName": "MuleSoft_Customers",
"createdById": "0000AD",
"createdDate": "2024-07-11T20:15:00.000000Z",
"systemModstamp": "",
"state": "UploadComplete",
"contentType": "CSV",
"apiVersion": "v1",
"contentUrl": "/api/v1/ingest/jobs/f3a58-8d22-4a72-a41d-083c3c/batches",
"retries": 0,
"totalProcessingTime": 0
}
```