Get Several Data Change Requests
This API allows retrieving several data change requests by the provided URIs.
Request:
POST {TenantURL}/changeRequests/_byUris| Parameter | Name | Required | Description |
|---|---|---|---|
| Headers |
Authorization
|
Yes | Information about authentication access token in format
Bearer <access_token> |
| Body | Yes | JSON with the properties described below |
| Name | Required | Description |
|---|---|---|
select
|
No |
Comma-separated list of properties from data change request
structure that should be returned in a response. Allows you to
return a partial entity object. Example: select =
|
exclude
|
No | JSON array of properties to exclude from the resulting JSON. The opposite of the select parameter. Intended for the case in which an object contains a list of different attributes and it is more convenient to specify the attributes that should not be included in the result JSON. |
uris
|
Yes | JSON array of data change request URIs. |
showConflicts
|
No | The data change request will be checked for conflicts such as
conflict and conflictDetails
properties with the type of the conflict, and additional information
will be present in all conflicted change request items. The default is
false. |
showObjectsInfo
|
No |
If this is set to |
showObjectsMetadata |
No | If this parameter is set to true, information about
objects participating in the data change request is also available. For
referenced entities, only objectURI fields are
corrected. The default value is false. |
Response
JSON array representing data change requests in the same order as the incoming URIs. If for any URI there is no data change request (or user has no access to that data change request) then empty element in the array will be at the appropriate place.
Request
POST {TenantURL}/changeRequests/_byUris
Body:
{
"select": "uri,createdTime,updatedTime,state",
"exclude": "changes,createdBy,updatedBy",
"uris": [
"changeRequests/0000OVV",
"changeRequests/YPKz9aB",
"changeRequests/MPkqNAm"
]
}Response
[
{
"uri": "changeRequests/0000OVV",
"createdTime": 1445452647170,
"updatedTime": 1445452647170,
"state": "AWAITING_REVIEW"
},
{},
{
"uri": "changeRequests/MPkqNAm",
"createdTime": 1445452647170,
"updatedTime": 1445452647170,
"state": "APPLIED"
}
]