Summary information about an asynchronous background job (for example, a folder deletion).
{ },}{ "accountId": "YOUR_ACCOUNT_ID", "created": 1615680311115, "error": { "code": "error_code", "message": "Error message." }, "jobDocs": "https://www.bytescale.com/docs/job-api/GetJob", "jobId": "01ARZ3NDEKTSV4RRFFQ69G5FAV", "jobType": "ExampleJob", "jobUrl": "https://api.bytescale.com/v2/accounts/FW25aki/jobs/ExampleJob/01ARZ3NDEKTSV4RRFFQ69G5FAV", "lastUpdated": 1615680311115, "status": "Cancelled", "summary": { "deletions": [ "/file/to/delete.jpg" ] }}Your account ID.
This is visible on the settings page:
https://www.bytescale.com/dashboard/settings
Example: "A623uY2"
Type: String
Length: 7
The time this job was created in epoch milliseconds (since midnight 1 January 1970, UTC).
Example: 1615680311115
Type: Integer
Minimum: 0
Machine-readable error code.
Example: "error_code"
Type: String
Min Length: 1
Max Length: 255
Additional machine-readable details relating to the error.
Human-readable error message.
Example: "Error message."
Type: String
Min Length: 1
Link to the documentation that describes how to get a job's status from its job ID.
Type: String
Value: "https://www.bytescale.com/docs/job-api/GetJob"
Unique ID for the job.
Example: "01ARZ3NDEKTSV4RRFFQ69G5FAV"
Type: String
Length: 26
Type of the job.
Example: "ExampleJob"
Type: String
Allowed Values: "AntivirusJob", "CopyFileBatchJob", "CopyFolderBatchJob", "DeleteFileBatchJob", "DeleteFolderBatchJob", "ProcessAudioJob", "ProcessVideoJob"
URL for the job's status.
You can GET this URL to retrieve the job's status.
You must authorize your GET request with a secret_* API key when accessing the URL.
Example: "https://api.bytescale.com/v2/accounts/FW25aki/jobs/ExampleJob/01ARZ3NDEKTSV4RRFFQ69G5FAV"
Type: String
Min Length: 1
Max Length: 255
The time this job was updated in epoch milliseconds (since midnight 1 January 1970, UTC).
Example: 1615680311115
Type: Integer
Minimum: 0
The job's status.
Type: String
Allowed Values: "Cancelled", "Cancelling", "Created", "Failed", "Pending", "Rollback", "Running", "Succeeded"
The summary and jobType together define the work the job will perform / has performed.
Type: JsonObject
This website uses cookies. By continuing you are consenting to the use of cookies per our Cookie Policy. Our Terms of Service were updated on October 20 2023.
This website requires a modern web browser -- the latest versions of these browsers are supported: