DROID External Ingestion onboarding requires the implementation of 2 endpoints by the DROID data producer for External Batch Ingestion. These endpoints should adhere to the SPI contract outlined below.
The scan endpoint is designed to retrieve the list of identifiers to initiate calls.
💡 JSON schemas for the endpoint can be found here.
Incoming scan requests will be sent by Wrench, with the ASAP issuer being micros/wrench.
string
successful operation
1
2
3
4
5
6
7
curl --request POST \
--url '/v2/scan' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"pageToken": "<string>"
}'1
2
3
4
5
6
{
"entityIds": [
"<string>"
],
"pageToken": "<string>"
}The query endpoint on your service is called for each set of identifiers and will return the payloads for those identifiers.
💡 JSON schemas for the endpoint can be found here.
Incoming query requests will be sent by Wrench, with the ASAP issuer being micros/wrench.
string
array<string>
Requiredsuccessful operation
1
2
3
4
5
6
7
8
9
10
curl --request POST \
--url '/v2/query' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"wrenchJobId": "<string>",
"entityIds": [
"<string>"
]
}'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
{
"operationStatusResults": {
"SUCCESS": [
"<string>"
],
"DELETE_SUCCESS": [
"<string>"
],
"RETRYABLE_FAILURE": [
"<string>"
],
"PERMANENT_FAILURE": [
"<string>"
],
"VALIDATION_FAILURE": [
"<string>"
],
"PROCESSING_ERROR": [
"<string>"
],
"SKIPPED": [
"<string>"
],
"MESSAGE_QUEUE_FAILURE": [
"<string>"
],
"NOT_FOUND": [
"<string>"
]
},
"entities": [
{
"entityId": "<string>",
"entityType": "<string>",
"version": 174,
"lastUpdateMillis": 73,
"deleted": true,
"content": "<string>"
}
],
"timestamp": 48
}Rate this page: