Accelerate the Value of Data

Search Data Change Requests

The Search DCR API allows to search Data Change Request by users (createdBy field) and/or URIs of the affected objects.

The search filter must contain at least one equals or in condition for createdBy or objectURI properties. Otherwise, an error CHANGE_REQUEST_SEARCH_FILTER_INCORRECT is returned.
Note: The search and filtering actions are supported only for createdBy and objectURI parameters (URIs of affected objects in the Data Change Request). Data change requests which are allowed to be viewed by the user according to the permissions are only returned.

Request:

 GET {TenantURL}/changeRequests 
Table 1. Parameters

Parameter

Name

Required

Details

Headers Authorization Yes Information about authentication access token in format "Bearer <accessToken>" (see details in Auth API).
Query filter Yes

Enables data change request filtering by a condition. Format for filter query parameter:

filter=({Condition Type}[AND/OR {Condition Type}]*)

Only the following conditions are supported:

  • equals(property, 'value') - exact match condition

  • in(property,'value1,value2,...') - returns data change requests which have property value contained in the specified values list

Search by the following properties is supported:

  • createdBy

  • objectURI

Note:
  • Search is case sensitive.
  • Empty filter is not allowed.
max No

Positive Integer value to identify the maximum number of data change requests to return in a response. Can be used to organize pagination in combination with the offset parameter.

Default value is 10 .

offset No

Positive Integer value to identify the starting element in a result set to be returned in a response. Can be used to organize pagination in combination with the max parameter.

Default value is 0.

Response

JSON array of the data change request objects from a tenant matching the filter request.

Data Change Request

GET {tenantUrl}/changeRequests?filter=in(createdBy,'User')
and in
(objectURI,'entities/00005KL')&offset=0&max=5
[{
  "URI": "changeRequests/0000OVV",
  "createdBy": "User",
  "createdTime": 1445452647170,
  "updatedBy": "User",
  "updatedTime": 1445452647170,
  "changes": {
    "entities/00005KL": [{
      "id": "0000jon",
      "type": "INSERT_ATTRIBUTE",
      "createdTime": 1445452647560,
      "createdBy": "User",
      "attributePath": "ProductMetrics/3/ExternalID",
      "newValue": {
        "value": "NewId"
      },
      "crosswalk": {
        "type": "configuration/sources/Veeva",
        "value": "e1"
      }
    }
   ]
  }
 }
]