AsyncResponse

Response body from an API endpoint that performs work asynchronously (i.e. does not complete the work immediately).

Structure

{
  "jobDocs": String,
  "jobId": String,
  "jobType": String,
  "jobUrl": String
}

Example

{
  "jobDocs": "https://www.bytescale.com/docs/job-api/GetJob",
  "jobId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "jobType": "ExampleJob",
  "jobUrl": "https://api.bytescale.com/v2/accounts/FW25aki/jobs/ExampleJob/01ARZ3NDEKTSV4RRFFQ69G5FAV"
}

Properties

jobDocs Required

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"

jobId Required

Unique ID for the job.

Example: "01ARZ3NDEKTSV4RRFFQ69G5FAV"

Type: String

Length: 26

jobType Required

Type of the job.

Example: "ExampleJob"

Type: String

Allowed Values: "AntivirusJob", "CopyFileBatchJob", "CopyFolderBatchJob", "DeleteFileBatchJob", "DeleteFolderBatchJob", "ProcessAudioJob", "ProcessImageJob", "ProcessVideoJob", "ResetCacheJob"

jobUrl Required

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

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:

UI Widgets

SDKs

Processing APIs

Core APIs

Data Types

More Resources

AsyncResponse

Structure

Example

Properties

jobDocs Required

jobId Required

jobType Required

jobUrl Required

Used by

You are using an outdated browser.