Admin

Check the status of a write operation

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.

get/v1/admin/write-status/{root_job_id}

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/v1/admin/write-status/{root_job_id}
  • Auth: HTTP bearer

Path parameters

root_job_idstring required

The job ID of the write job to check the status of

Response

Successful response

write_status'SUCCESS' | 'PARTIAL_SUCCESS' | 'FAILURE' | 'PENDING' required

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.

errorsstring[] required
created_record_idstring nullable required

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.

Changes

No recorded changes to this operation across all 1 revision of this API.