Use of the Supplier Data API with Pagination processCancellationRequest Endpoint
The Supplier Data API with Pagination uses the PATCH method to send a JSON request to your site. The request cancels a specific process that is in In Progress status for a specific supplier from an external system.
|
Method |
Endpoint |
Description |
|---|---|---|
|
PATCH |
{{runtime_URL}}/supplierdatapagination/v4/prod/vendors/{vendorId}/processes/{wid}?realm=myRealm} |
Cancels a specific process that is in in-progress status for a specific supplier. |
For example, the following URL cancels a specific process, {wId} for a specific supplier, {vendorId} in myRealm:
PATCH{{runtime_URL}}/supplierdatapagination/v4/prod/vendors/{vendorId}/processes/{wid}?realm=myRealm
Refer to Supplier Data API with Pagination Header Parameters for information on header parameters and Supplier Data API with Pagination Query and Filter Parameters for information on query and filter parameters.
The following example shows a sample request:
{
"processCancellationRequest": {
"internalComment": "cancel this process",
"externalComment": "cancel this process",
"initiatorUniqueName": "testuser",
"initiatorPasswordAdapter": "PasswordAdapter",
"deleted": true
}
}
The following example shows a sample response:
{
"status": "OK",
"statusCode": 202,
"errorMessages": [
{
"errorType": "",
"message": "",
"cause": "",
"resolution": "",
"errorCode": 0
}
]
}