Yoobic Jobs API
The Jobs endpoint allows you to query the status of your asynchronous jobs, whether they are queued, running, completed, or expired.The `id` required to request status is returned from your requests that are queued asynchronously on enabled endpoints.### Fields| Field | Type | Required | Readonly | OrderBy | Description ||----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------||`job_id` | string | x | x | | Unique id of the inventory ||`name` | string | | x | | Job name suffixed with a UUID ||`progress` | number | | x | | Between 0-1, the progress of a job, 1 being complete ||`lastFinishedAt` | date | | x | | The date the job finished ||`data.stats.execution_time_milliseconds` | number | | x | | How long the job ran in milliseconds ||`data.stats.execution_time` | number | | x | | How long the job ran in words ||`data.stats.errors` | number | | x | | Number of errors in the run ||`data.stats.success` | number | | x | | Number of successes in the run ||`data.input` | object | | x | | Request parameters supplied to the job (see below details for export/import) ||`data.output` | object | | x | | Response parameters of the job (see below details for export/import) |#### Fields Export| Field | Type | Required | Readonly | OrderBy | Description ||----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------||`data.input.filter` | object | | x | | The filter object passed to the request ||`data.input.modelName`| string | | x | | The endpoint's entity name ||`data.input.type` | string | | x | | The exported file type (csv/xlsx) ||`data.output.errors` | array | | x | | General error or errors that may have occurred for this export job ||`data.output.data.download_url` | string | | x | | The exported file ||`data.output.data.expires_at` | string | | x | | The date at which the file will no longer be available for download |#### Fields Import| Field | Type | Required | Readonly | OrderBy | Description ||----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------||`data.input.originalFilename` | string | | x | | The file passed to the request ||`data.input.modelName`| string | | x | | The endpoint's entity name ||`data.input.type` | string | | x | | The imported file type (csv/xlsx) ||`data.output.error.download_url` | string | | x | | The file containing all errors (if any) ||`data.output.error.expires_at` | date | | x | | The date at which the file will no longer be available for download |
Yoobic Jobs API is one of 41 APIs that Yoobic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Jobs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.
This API exposes 1 operation across 1 path. It is described by OpenAPI 3.0.0.
Requests are made against a single base URL, https://.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Yoobic Jobs API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
The Jobs endpoint allows you to query the status of your asynchronous jobs, whether they are queued, running, completed, or expired. The id required to request status is returned…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Yoobic 12
Other APIs Yoobic publishes across the network.