Create New Data Change Request
This API creates an empty data change request.
The changeRequests
endpoint is needed just to get a unique change request ID. This ID can be used (changeRequestId={ID}
) in endpoints for objects modification such as POST {{RdmApiUrl}}/changeRequests/{{RdmTenant}}
. The changes will be added to the data change request with ID which was specified instead of applying directly to the objects.
Request
POST {{RdmApiUrl}}/changeRequests/{{RdmTenant}}
Parameter | Name | Required | Details |
---|---|---|---|
Headers | Authorization
| Yes | Information about authentication access token in format "Bearer <accessToken> " (see details in Auth API). |
{
"tenantId": "rdm_tenant_name",
"changes":
{
"rdm_tenant_name/Country/CA": [
{
"type": "UPDATE_FIELD",
"path": "startDate",
"newValue": 1564666468,
"oldValue": 0
},
{
"type": "UPDATE_PARENTS",
"path": "parents",
"newValue": ["rdm/lookupTypes/Continent/NA"],
"oldValue": []
}
]
},
"externalInfo":
{
"customProperty1": "custom property",
"anotherCustomProperty": "very important and smart property",
"nestedCustomProperty":
{
"integerValue": 1,
"booleanValue": false
}
}
}
Response
{
"tenantId": "rdm_tenant_name",
"createdBy": "user",
"createDate": 1600773974316,
"updatedBy": "user",
"updateDate": 1600773974316,
"version": 1,
"changes":
{
"rdm_tenant_name/Country/CA": [
{
"id": "c28549c7-af97-4659-b406-9e3873af4fa4",
"type": "UPDATE_FIELD",
"path": "startDate",
"newValue": 1564666468,
"oldValue": 0
},
{
"id": "97549200-23f4-47bd-b4a9-1a1cb3896b5e",
"type": "UPDATE_PARENTS",
"path": "parents",
"newValue": ["rdm/lookupTypes/Continent/NA"],
"oldValue": []
}
]
},
"externalInfo":
{
"customProperty1": "custom property",
"anotherCustomProperty": "very important and smart property",
"nestedCustomProperty":
{
"integerValue": 1,
"booleanValue": false
}
}
}