Summary information about an asynchronous background job (for example, a folder deletion).
{ },}{ "accountId": "YOUR_ACCOUNT_ID", "attempts": 2, "created": 1615680311115, "error": { "code": "error_code", "message": "Error message." }, "jobId": "01ARZ3NDEKTSV4RRFFQ69G5FAV", "jobType": "DeleteFileBatchJob", "lastUpdated": 1615680311115, "status": "Cancelled", "summary": { "deletions": [ "/file/to/delete.jpg" ] }}Your account ID.
This is visible on the settings page:
https://upload.io/dashboard/settings
Example: "A623uY2"
Type: String
Length: 7
Required: Yes
The total number of completed attempts at running the job, both failed and successful.
Type: Number
Required: Yes
The time this job was created in epoch milliseconds (since midnight 1 January 1970, UTC).
Example: 1615680311115
Type: Integer
Minimum: 0
Required: Yes
Machine-readable error code.
Example: "error_code"
Type: String
Min Length: 1
Max Length: 255
Required: Yes
Additional machine-readable details relating to the error.
Required: No
Human-readable error message.
Example: "Error message."
Type: String
Min Length: 1
Required: Yes
The job's unique ID.
Example: "01ARZ3NDEKTSV4RRFFQ69G5FAV"
Type: String
Length: 26
Required: Yes
The type of the job.
Example: "DeleteFileBatchJob"
Type: String
Allowed Values: "CopyFileBatchJob", "CopyFolderBatchJob", "DeleteFileBatchJob", "DeleteFolderBatchJob"
Required: Yes
The time this job was created, or the last time the status / attempts fields were updated, in epoch milliseconds (since midnight 1 January 1970, UTC).
Example: 1615680311115
Type: Integer
Minimum: 0
Required: Yes
The job's status.
Type: String
Allowed Values: "Cancelled", "Cancelling", "Created", "Failed", "Pending", "Rollback", "Running", "Succeeded"
Required: Yes
The payload and jobType together define the work the job will perform / has performed.
Type: JsonObject
Required: Yes
This website uses cookies. By continuing you are consenting to the use of cookies per our cookie policy.
This website requires a modern web browser -- the latest versions of these browsers are supported: