Admin

Check the status of a write operation

GET
https://api.propexo.com/v1/admin/write-status/:root_job_id
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_id
string

Response

This endpoint return 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.
GET
/v1/admin/write-status/:root_job_id
curl https://api.propexo.com/v1/admin/write-status/root_job_id \
-H "Authorization: Bearer <token>"
Response
{
"write_status": "SUCCESS",
"errors": [
"errors"
]
}