| Code | Description |
|---|---|
| 401 | Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource. |
| 403 | Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource. |
| 404 | Not Found. The requested resource could not be found. |
| 422 | Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors. |
| 500 | Internal Server Error. An unexpected condition was encountered. |
response:
{
"page": 1,
"per_page": 50,
"total_pages": 1,
"total_entries": 1,
"entries": [
{
"id": 429,
"request_id": "2e2b36a6-e6f7-42ae-a388-e53bfa2626be",
"entity": "Category",
"status": "complete",
"percent_completed": 1,
"operation": "insert",
"created_at": "2016-05-30T14:55:57.316+10:00",
"updated_at": "2016-05-30T14:55:58.671+10:00",
"created_by": "test@fusionfactory.com",
"error_count": 0,
"result": "Success"
}
]
}
status:
request_received - job request received but not yet scheduled to run
fail_to_receive - the job payload/format is not acceptable
ready_to_process - job is scheduled to process
processing - job is being processed
fail_to_process - exception happened during processing the job
canceled - job aborted
complete - job processing is completed
result:
Success - job completed without error
Failure - job completed with error or the job status is fail_to_receive or fail_to_process
Pending - result not yet available (job not completed)
| Param name | Description |
|---|---|
|
per_page optional |
Number of objects in one response. Default is 50 Validations:
|
|
page optional |
Page number. Default is 1 Validations:
|
|
id optional |
ID of the job Validations:
|
|
request_id optional |
Request ID of the job Validations:
|
|
created_by optional |
The submitter of the job Validations:
|
|
created_time_from optional |
ISO_8601 format 2016-05-30T05:13:26Z Validations:
|
|
created_time_to optional |
ISO_8601 format 2016-05-30T05:13:26Z Validations:
|
|
updated_time_from optional |
ISO_8601 format 2016-05-30T05:13:26Z Validations:
|
|
updated_time_to optional |
ISO_8601 format 2016-05-30T05:13:26Z Validations:
|