This section outlines the steps to validate the presence of an active long-running operation on a particular object definition.
HTTP responses
HTTP response status code | Interpretation |
200 OK | The result can be If If |
400 Bad Request | One or more validation errors occurred. The ID path parameter is invalid or it doesn't exist. |
401 Unauthorized | Invalid or missing API key secret and/or tenant |
403 Forbidden | The user is not allowed to check this object definition for a potential long-running operation |
To check for an ongoing long-running action on an existing object definition, make a GET request to the /object-definitions/{id}/long-running endpoint specifying:
Resource/endpoint destination URL. Replace the path parameter {id} with the ID of the object definition that you want to have checked.
The header for your API request
To check whether a long-running process is active on the object definition with the id 640b3d7d4a28b925fcf8b8b2, we will pass a GET request to the URI https://public-api.eu.bluedolphin.app/v1/object-definitions/640b3d7d4a28b925fcf8b8b2/long-running.
curl -L 'https://public-api.eu.bluedolphin.app/v1/object-definitions/640b3d7d4a28b925fcf8b8b2/long-running' \ -H 'x-api-key: YOURAPIKEYSECRET' \ -H 'tenant: yourtenantname' \ -H 'Content-Type: application/json' \ -d ''
A successful call returns a response with a 200 OK HTTP status code and the following body, meaning there is no active long-running process for this definition:
{
"result": false
}In case there is an active long-running process for this definition, a response with a 200 OK HTTP status code and the following body is returned:
{
"result": true
}