Get Job - Library | iTwin Platform

Library

Download API definition:

GET https://api.bentley.com/library/jobs/{id}

Retrieves job from user's organization context, a job contains information required to track long running activity, e.g., UploadComponent.

Notes

Job Status values are:

-Success -Error -InProgress -Queued -Aborted -Canceled -PendingCancel

Authentication

Requires Authorization header with valid Bearer token for scope itwin-platform.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Authorization

User must be an Organization Administrator for the Organization or have Read permission assigned at the organization level.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.

Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.

Request

Request parameters

Yes

Id of the Job.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.

Response

Response 200 OK

json

{
    "job": {
        "id": "2517774384832714834_eeaaacbf-b364-4105-b57b-228ad5fd8929",
        "displayName": "revit2021.rfa",
        "jobSize": 4784128,
        "progress": 100,
        "status": "Success",
        "error": null,
        "type": "Upload",
        "_links": {
            "component": {
                "href": "https://api.bentley.com/Library/components/298a2e18-f47e-4d26-9fc9-d53b25d9ea58"
            }
        }
    }
}

Response 401 Unauthorized

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

json

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 404 Not Found

This response indicates that the specified job not found.

json

{
    "error": {
        "code": "JobNotFound",
        "message": "Requested Job is not available."
    }
}

Response 429 Too many requests

This response indicates that the user has sent too many requests in a given amount of time.

json

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

retry-after

The number of requests exceeds the rate-limit for the client subscription.

Definitions

Job (response)

Retrieved job response containing job.

job

Job

Full representation of the job.

json

{
    "description": "Retrieved job response containing job.",
    "title": "Job (response)",
    "type": "object",
    "properties": {
        "job": {
            "description": "Full representation of the job.",
            "$ref": "#/components/schemas/Job"
        }
    },
    "additionalProperties": false
}

Job status

Indicates the state of the job.

Queued

String

InProgress

String

Success

String

Error

String

Aborted

String

Canceled

String

PendingCancel

String

json

{
    "type": "string",
    "description": "Indicates the state of the job.",
    "enum": [
        "Queued",
        "InProgress",
        "Success",
        "Error",
        "Aborted",
        "Canceled",
        "PendingCancel"
    ],
    "title": "Job status"
}

Job type

Type of the job, e.g., Upload (UploadComponent).

Upload

String

json

{
    "type": "string",
    "description": "Type of the job, e.g., Upload (UploadComponent).",
    "enum": [
        "Upload"
    ],
    "title": "Job type"
}

Job

A job represents information required to track a background long running activity, e.g., UploadComponent

String

Id of the job.

displayName

String

Display name of the job.

error

String

Error description in case status is an error.

jobSize

Integer

Size of the job, e.g., file size in case of upload component.

progress

Double

Percentage progress of the job.

Job status

Job-status

Indicates the state of the job.

Job type

Job-type

Type of the job, e.g., Upload (UploadComponent).

_links

JobLinks

Contains the hyperlinks to the related data of the job.

json

{
    "type": "object",
    "description": "A job represents information required to track a background long running activity, e.g., UploadComponent",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the job."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the job."
        },
        "error": {
            "type": "string",
            "description": "Error description in case status is an error."
        },
        "jobSize": {
            "type": "integer",
            "description": "Size of the job, e.g., file size in case of upload component."
        },
        "progress": {
            "type": "number",
            "format": "double",
            "description": "Percentage progress of the job."
        },
        "status": {
            "type": "string",
            "description": "Indicates the state of the job.",
            "enum": [
                "Queued",
                "InProgress",
                "Success",
                "Error",
                "Aborted",
                "Canceled",
                "PendingCancel"
            ],
            "title": "Job status",
            "$ref": "#/components/schemas/Job-status"
        },
        "type": {
            "type": "string",
            "description": "Type of the job, e.g., Upload (UploadComponent).",
            "enum": [
                "Upload"
            ],
            "title": "Job type",
            "$ref": "#/components/schemas/Job-type"
        },
        "_links": {
            "$ref": "#/components/schemas/JobLinks",
            "description": "Contains the hyperlinks to the related data of the job."
        }
    },
    "additionalProperties": false
}

Job Links

Hyperlinks to related data which complements this entity.

component

Link

Link to component entity created as part of this job.

json

{
    "type": "object",
    "title": "Job Links",
    "description": "Hyperlinks to related data which complements this entity.",
    "properties": {
        "component": {
            "$ref": "#/components/schemas/Link",
            "description": "Link to component entity created as part of this job."
        }
    },
    "additionalProperties": false
}

Link

href

String

json

{
    "type": "object",
    "properties": {
        "href": {
            "type": "string"
        }
    },
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

json

{
    "type": "object",
    "description": "Contains error information.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        }
    },
    "required": [
        "code",
        "message"
    ],
    "additionalProperties": true
}

Error Response

Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.

error

Error

Error information.

json

{
    "type": "object",
    "title": "Error Response",
    "description": "Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.",
    "properties": {
        "error": {
            "description": "Error information.",
            "$ref": "#/components/schemas/Error"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Was this page helpful?