Skip to content

Latest commit

 

History

History
13 lines (9 loc) · 11 KB

File metadata and controls

13 lines (9 loc) · 11 KB

BulkDataPropertyJson

Data Record envelope

Fields

Field Type Required Description Example
pathParams Map<String, String> Key-value pairs where a key identifies a labeled placeholders in the url (e.g. "/endpoint/{entityId}") and a value represents the value to substitute. Necessary if the target endpoint has path parameters. Values must NOT be null. {
"id": "11111111-0dc3-487b-953e-86d6abbdf7d3"
}
queryParams Map<String, String> Query params specific to this data record to pass to the target endpoint. Entries merge with, and overlaps override, job-level queryParams. Values must NOT be null. {
"param1": "param1Value",
"param2": "param2Value"
}
headers Map<String, String> Headers specific to this data record to pass to the target endpoint. Entries merge with, and overlaps override, job-level headers. Values must NOT be null. {
"header1": "header1Value",
"header2": "header2Value"
}
dataRecord Map<String, BulkDataRecordJson> ✔️ Arbitrary container to hold a JSON payload. The payload is the data you're sending, or the reply received when fetching results. For the request, this data must be structured in the way the API you're running a bulk job for accepts. For example, to bulk create sessions, you structure each of the dataRecord entries based on the format of the Create Session endpoint. {
"event": {
"id": "04ca6ae2-0dc3-487b-953e-86d6abbdf7d3"
},
"title": "Day 1 Keynote Session",
"start": "2020-02-03T13:00:00.000Z",
"end": "2020-02-07T17:00:00.000Z",
"status": "Active"
}