Apply Data Change Request
This API applies (commits) all changes inside a data change request to real entities and relationships.
By default, a data change request can be applied only if all attributes which are
going to be updated by this change request have not been changed in real objects
since they had been added to this request. Otherwise items inside change request
related to the attributes which have been changed/removed in the real object will be
marked as 'conflict'. User will have to manually resolve all conflicts by removing
and optionally re-adding items into the data change request. Also, it will be
possible to execute 'ignoreConflicts' apply (with
ignoreConflicts=true parameter)- all changes will be applied
'as is' in this case.
For example, there is a change request with only one item: update
"FirstName" in entity AAA from 'Alex' to
'Alexey. If the value of the "FirstName" attribute
of entity AAA is still 'Alex, we will be able to apply this change
request. But if 'Alex' has been changed to 'Aleks' or
removed, we will have a conflict.
Request
POST {TenantURL}/changeRequests/_byUris/_apply|
Parameter |
Name |
Required |
Details |
|---|---|---|---|
| Headers |
Authorization
|
Yes | Information about authentication access token in format "Bearer
<accessToken>" (see details in Auth APID
). |
| Path |
id
|
Yes | ID of a data change request. |
| Query |
ignoreConflicts
|
No |
If this parameter is set to true , the data change request will be applied even if there are conflicting changes. Default value is false . |
Response
Information about the status of the request
Example
Request
POST {TenantURL}/changeRequests/0000OVV/_applyResponse
{"status":"success"}