Data Types

JobSummary

Summary information about an asynchronous background job (for example, a folder deletion).

Structure

{
"accountId": String,
"attempts": Number,
"created": Integer,
"code": String,
"details": Object,
"message": String
},
"jobId": String,
"jobType": String,
"lastUpdated": Integer,
"status": String
}

Example

{
"accountId": "YOUR_ACCOUNT_ID",
"attempts": 2,
"created": 1615680311115,
"error": {
"code": "error_code",
"message": "Error message."
},
"jobId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"jobType": "BatchFileDeletionJob",
"lastUpdated": 1615680311115,
"payload": {
"deletions": [
"/file/to/delete.jpg"
]
},
"status": "Cancelled"
}

Properties

accountId

Your account ID.

This is visible on the settings page:

https://upload.io/dashboard/settings

Type: String

Length: 7

Example: "A623uY2"

Required: Yes

attempts

The number of times the job has been executed. Once the job has been successfully executed, no further attempts will be made.

Type: Number

Required: Yes

created

The time this job was created in epoch milliseconds (since midnight 1 January 1970, UTC).

Type: Integer

Minimum: 0

Example: 1615680311115

Required: Yes

error.code

Machine-readable error code.

Type: String

Min Length: 1

Max Length: 255

Example: "error_code"

Required: Yes

error.details

Additional machine-readable details relating to the error.

Required: No

error.message

Human-readable error message.

Type: String

Min Length: 1

Example: "Error message."

Required: Yes

jobId

The job's unique ID.

Type: String

Length: 26

Example: "01ARZ3NDEKTSV4RRFFQ69G5FAV"

Required: Yes

jobType

The type of the job.

Type: String

Allowed Values: "BatchFileDeletionJob", "BatchFolderDeletionJob"

Example: "BatchFileDeletionJob"

Required: Yes

lastUpdated

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).

Type: Integer

Minimum: 0

Example: 1615680311115

Required: Yes

payload

The payload and jobType together define the work the job will perform / has performed.

Type: JsonObject

Required: Yes

status

The job's status.

Type: String

Allowed Values: "Cancelled", "Cancelling", "Failed", "Pending", "Rollback", "Running", "Succeeded"

Required: Yes

Used by

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported: