• External Ingestion Batch Endpoint
    • Other operations
    Platform
    DROID / Reference / DROID REST SPI

    External Ingestion Batch Endpoint

    Postman Collection
    OpenAPI

    DROID External Ingestion onboarding will require the implementation of 2 endpoints by the DROID data provider for External Batch Ingestion. These will be developed in the nature of the SPI contract outlined below.

    • A Scan endpoint: A list endpoint to return all item ids with pagination and
    • A Query endpoint: A bulk get endpoint to return the payloads of the requested ids
    POST

    /scan

    The scan endpoint is to retrieve the list of identifiers to initiate calls for. 💡 - Json Schemas for the endpoint can be found here.

    Request

    Request bodyapplication/json

    Incoming Scan Requests will be sent by wrench with the ASAP Issuer Being micros/wrench.

    pageToken

    string

    Responses

    successful operation

    application/json

    object
    POST/scan
    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>" }'
    200Response
    1 2 3 4 5 6 { "entityIds": [ "<string>" ], "pageToken": "<string>" }
    POST

    /query

    The query endpoint on your service is called for each set of identifiers. It will return the payloads of the identifiers.

    💡 - Json Schemas for the endpoint can be found here.

    Request

    Request bodyapplication/json

    Incoming Query Requests will also be sent by wrench with the ASAP Issuer Being micros/wrench.

    wrenchJobId

    string

    entityIds

    array<string>

    Required

    Responses

    successful operation

    application/json

    object
    POST/query
    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>" ] }'
    200Response
    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: