2121: Submit data request

Owned by Nick Jensen
Feb 01, 2018
1 min read

Submit a new data request for an entity

Endpoint ID:2121
Method:

POST

URL:

/permissions/entity/id/{entityID}/datarequest/{dataRequestID}

/permissions/entity/ext-key/{ext-key}/{ext-type}/datarequest/{dataRequestID}



entityID

Rubiq master ID that uniquely identifies the entity

ext-keyExternal key that uniquely identifies the entity

ext-typeType of external key

dataRequestIDA GUID string identifier for the type of data request the entity is requesting
Request body:

JSON data containing the data request details

Required fields

sourceIDThe GUID string identifier of the data request source
{
    "sourceID": "26f2da92-c9ca-4a82-90f0-8a8a43534239"
}

Response body: 

{
    "id": 49,
    "dataRequestID": "ee017cd4-35bd-48d4-9eca-2361740acf2b",
    "state": "Completed",
    "source": "f9198a1c-19b7-4572-870a-810debf80326",
    "requested": "2018-01-31T07:20:16.1061196+13:00",
    "started": "2018-01-31T07:20:16.1896302+13:00",
    "completed": "2018-01-31T07:20:16.2646398+13:00"
}
Status codes:201The data request was submitted

404

The entity or data request were not found.

The following subcodes may be returned:

404.1Entity not found
404.2External entity reference could not be found
404.4Data request not found

412


412.1The source or entity type are not allowed for this type of data request