Check the status of a write operation | Propexo

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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

root_job_idstringRequired

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

Response

Successful response

write_statusenum

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:

errorslist of strings

created_record_idstring or null

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.

Errors

400

Bad Request Error

Bearer authentication of the form Bearer <token>, where token is your auth token.

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

1	{
2	"write_status": "PARTIAL_SUCCESS",
3	"errors": [
4	"Failed to update record 12345 due to validation error on field 'email'."
5	],
6	"created_record_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890"
7	}

1	{
2	"write_status": "PARTIAL_SUCCESS",
3	"errors": [
4	"Failed to update record 12345 due to validation error on field 'email'."
5	],
6	"created_record_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890"
7	}

$	curl https://api.propexo.com/v1/admin/write-status/root_job_id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"