Get iTwin job - Access Control

Access Control

Download API definition:

GET https://api.bentley.com/accesscontrol/itwins/{id}/jobs/{jobId}

Retrieves the specified iTwin job for the specified iTwin.

By default this operation will only return the status of the iTwin job. To find the specific errors of the iTwin job, include return=representation in the Prefer header.

Status

Active: iTwin job is stil in progress.
Completed: iTwin job completed without error.
PartialCompleted: iTwin job completed with some actions failing. To find the specific errors of the iTwin job, include return=representation in the Prefer header.
Failed: iTwin job completed with all actions failing. To find the specific errors of the iTwin job, include return=representation in the Prefer header.

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 have the {permission} permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

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.

Request

Request parameters

Yes

jobId

Yes

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

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

Response

Response 200 OK

json

{
    "id": "fb936e1f-5a60-4fe0-8237-e7afbf47512b",
    "itwinId": "6c9aba19-76f5-4a21-a4df-a8512df2201e",
    "status": "Active"
}

Response headers

Prefer

Indicates a level of details in the response. This operation supports return=representation and return=minimal preferences.

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 403 Forbidden

The user has insufficient permissions for the requested operation.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

Response 404 Not Found

This response indicates that iTwin or job with specified ID was not found.

json

{
    "error": {
        "code": "ItwinNotFound",
        "message": "Requested iTwin 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

iTwin Job (prefer return=minimal)

String

The job id.

itwinId

String

The id of the iTwin

description

String

A description of your Group.

status

iTwinJobStatus

json

{
    "type": "object",
    "title": "iTwin Job (prefer return=minimal)",
    "properties": {
        "id": {
            "type": "string",
            "description": "The job id."
        },
        "itwinId": {
            "type": "string",
            "description": "The id of the iTwin"
        },
        "description": {
            "type": "string",
            "description": "A description of your Group."
        },
        "status": {
            "$ref": "#/components/schemas/iTwinJobStatus"
        }
    },
    "additionalProperties": false
}

iTwin Job (prefer return=representation)

String

The job id.

itwinId

String

The id of the iTwin

status

iTwinJobStatus

errors

ErrorResponse[]

List of errors.

json

{
    "type": "object",
    "title": "iTwin Job (prefer return=representation)",
    "properties": {
        "id": {
            "type": "string",
            "description": "The job id."
        },
        "itwinId": {
            "type": "string",
            "description": "The id of the iTwin"
        },
        "status": {
            "$ref": "#/components/schemas/iTwinJobStatus"
        },
        "errors": {
            "type": "array",
            "description": "List of errors.",
            "items": {
                "$ref": "#/components/schemas/ErrorResponse"
            }
        }
    },
    "additionalProperties": false
}

iTwinJobStatus

The status of the job.

Active

String

Completed

String

PartialCompleted

String

Failed

String

json

{
    "type": "string",
    "enum": [
        "Active",
        "Completed",
        "PartialCompleted",
        "Failed"
    ],
    "description": "The status of the job."
}

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?