Admin

Check the status of a write operation

GET
Query for the status of a write operation created via the API. The status of the write operation, as well as any encountered errors, is provided.

Path parameters

root_job_idstringRequired

Response

This endpoint returns an object
write_status
enum

The status for the write operation. “SUCCESS” means that the write operation was seen as a complete success and the data has been written. “PARTIAL_SUCCESS” means that a portion of the write operation succeeded, but it was not fully successful. “FAILURE” means that the write operation completely failed.”PENDING” means that the write operation is pending completion of any status.

Allowed values: SUCCESSPARTIAL_SUCCESSFAILUREPENDING
errors
list of strings

For “PARTIAL_SUCCESS” and “FAILURE” statuses, an array of error messages provided by the PMS may be present. This array could be incomplete if the PMS does not provide error messages.

created_record_id
stringOptional
The ID may be null if the job didn't run correctly or if the given PMS does not generate a new record ID for create operations. Due to varying PMS workflow requirements, some Propexo jobs will spawn other jobs. This will return the first ID created in the process and could be related to a different model than expected. This is not intended to be a complete solution and could have gaps.
GET
1curl https://api.propexo.com/v1/admin/write-status/root_job_id \
2 -H "Authorization: Bearer <token>"
200Retrieved
1{
2 "write_status": "SUCCESS",
3 "errors": [
4 "errors"
5 ],
6 "created_record_id": "created_record_id"
7}