Get Code - Schedules | iTwin Platform

Schedules

Download API definition:

This API is a Technical Preview and is available for testing purposes only. Do not use in production.

Get Code

GET https://dev-api.bentley.com/schedules/{scheduleId}/codes/{codeId}

Gets the details of a Code.

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.

Code Categories

All codes belong to one of four categories.

Activity: Codes of this type can be assigned to Tasks.
Resources: Codes of this type can be assigned to Resources.
ResourceGroups: Codes of this type can be assigned to Resource Groups.
Costs: There is a single Cost Code in every project. The Code Values of this Code can be applied directly to a Cost.

Rate limits

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

Request parameters

scheduleId

Yes

The unique identifier of the Schedule.

codeId

Yes

The unique identifier of the code.

Request headers

If-None-Match

A header that makes the request conditional. If the ETag of the requested resource or resource collection matches the provided value, a 304 (Not Modified) response is returned. For more information see the official documentation.

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response 200 OK

json

{
    "code": {
        "category": "Resource",
        "id": "b1765057-fa96-4169-bd30-e60213dc45c1",
        "name": "Apartment Buildings"
    }
}

Response headers

ETag

A header that identifies a specific version of a resource or resource collection. For more information see the official documentation.

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 provided Code or Schedule is not available.

json

{
    "error": {
        "code": "CodeNotFound",
        "message": "Requested Code is not available.",
        "target": "codeId"
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

Code

Representation of a Code.

Code Category

Code categories help organize and classify codes. See the Code Categories section for details.

Cost

String

Activity

String

Resource

String

ResourceGroup

String

Unknown

String

json

{
    "title": "Code Category",
    "enum": [
        "Cost",
        "Activity",
        "Resource",
        "ResourceGroup",
        "Unknown"
    ],
    "type": "string",
    "description": "Code categories help organize and classify codes. See the [Code Categories](#code-categories) section for details."
}

Code Response

Container for Code object.

code

Code

Code Properties.

json

{
    "title": "Code Response",
    "type": "object",
    "properties": {
        "code": {
            "$ref": "#/components/schemas/Code",
            "description": "Code Properties."
        }
    },
    "additionalProperties": false,
    "description": "Container for Code object."
}

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?

Authentication

Code Categories

Rate limits

Request

Request parameters

Request headers

Response

Response 200 OK

Response headers

Response 304 Not Modified

Response 401 Unauthorized

Response 404 Not Found

Response 429 Too many requests

Response headers

Definitions

Code

Code Category

Code Response

Error

Error Response