Get Resource - Schedules | iTwin Platform

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

{
    "resource": {
        "description": "A box",
        "email": "",
        "id": "385c7013-1fb9-4ee5-92a9-4af73a0c5a29",
        "leadTime": 500,
        "name": "Box 1",
        "parentId": null,
        "renewable": false,
        "type": "Material",
        "unitType": "Box",
        "url": "https://example.com",
        "userDefinedId": "Custom Id 001",
        "wholeUnits": true
    }
}

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

json

{
    "error": {
        "code": "ResourceNotFound",
        "message": "Requested Resource is not available.",
        "target": "resourceId"
    }
}

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

Resource

Representation of a Resource.

description

String

The description of the resource.

String

An email address associated with the resource. Only allowed for resources of Human type.

String

The unique identifier of the Resource.

leadTime

Int32

The notification period required prior to supply the Resource. The value is a timestamp of seconds.

name

String

The name of the Resource.

parentId

String, null

The unique identifier of the parent Resource.

renewable

Boolean

A Renewable Resource will be released after the Task completion and can be reused on another Task. The available quantity of a non-renewable Resource decreases as it is used up by the Task.

type

ResourceType

The type of the Resource.

unitType

ResourceUnitType

The type of units that are used to describe the resource. Only available for resources of Material and Location type.

url

String, null

A URL associated with the Resource.

userDefinedId

String, null

A unique Resource Id defined by the user.

wholeUnits

Boolean

A boolean value specifying whether the resource units must be in whole numbers.

json

{
    "title": "Resource",
    "type": "object",
    "properties": {
        "description": {
            "type": "string",
            "description": "The description of the resource."
        },
        "email": {
            "type": "string",
            "description": "An email address associated with the resource. Only allowed for resources of Human type."
        },
        "id": {
            "type": "string",
            "description": "The unique identifier of the Resource."
        },
        "leadTime": {
            "type": "integer",
            "description": "The notification period required prior to supply the Resource. The value is a timestamp of seconds.",
            "format": "int32"
        },
        "name": {
            "type": "string",
            "description": "The name of the Resource."
        },
        "parentId": {
            "type": "string",
            "description": "The unique identifier of the parent Resource.",
            "nullable": true
        },
        "renewable": {
            "type": "boolean",
            "description": "A Renewable Resource will be released after the Task completion and can be reused on another Task. The available quantity of a non-renewable Resource decreases as it is used up by the Task."
        },
        "type": {
            "$ref": "#/components/schemas/ResourceType",
            "description": "The type of the Resource."
        },
        "unitType": {
            "$ref": "#/components/schemas/ResourceUnitType",
            "description": "The type of units that are used to describe the resource. Only available for resources of Material and Location type."
        },
        "url": {
            "type": "string",
            "description": "A URL associated with the Resource.",
            "nullable": true
        },
        "userDefinedId": {
            "type": "string",
            "description": "A unique Resource Id defined by the user.",
            "nullable": true
        },
        "wholeUnits": {
            "type": "boolean",
            "description": "A boolean value specifying whether the resource units must be in whole numbers."
        }
    },
    "additionalProperties": false,
    "description": "Representation of a Resource."
}

Resource Response

Container for Resource object.

resource

Resource

Resource Properties.

json

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

Resource Type

The type of a Resource.

Material

String

Location

String

Equipment

String

Human

String

Unknown

String

json

{
    "title": "Resource Type",
    "enum": [
        "Material",
        "Location",
        "Equipment",
        "Human",
        "Unknown"
    ],
    "type": "string",
    "description": "The type of a Resource."
}

Resource Unit Type

The possible unit types for resources.

CubicFeet

String

CubicMeter

String

Liter

String

Millimeter

String

Meter

String

Feet

String

Each

String

Pair

String

Dozen

String

Gross

String

SqFoot

String

SqYard

String

SqMeter

String

Pound

String

Gram

String

Kilo

String

Bag

String

Box

String

Bucket

String

Bundle

String

Card

String

Carton

String

Coil

String

Pack

String

Pegs

String

Length

String

Outer

String

Pallet

String

Roll

String

Sachet

String

Set

String

Sheet

String

Ton

String

Person

String

Item

String

CubicYard

String

MetricTon

String

Hour

String

LinearMeter

String

Unknown

String

json

{
    "title": "Resource Unit Type",
    "enum": [
        "CubicFeet",
        "CubicMeter",
        "Liter",
        "Millimeter",
        "Meter",
        "Feet",
        "Each",
        "Pair",
        "Dozen",
        "Gross",
        "SqFoot",
        "SqYard",
        "SqMeter",
        "Pound",
        "Gram",
        "Kilo",
        "Bag",
        "Box",
        "Bucket",
        "Bundle",
        "Card",
        "Carton",
        "Coil",
        "Pack",
        "Pegs",
        "Length",
        "Outer",
        "Pallet",
        "Roll",
        "Sachet",
        "Set",
        "Sheet",
        "Ton",
        "Person",
        "Item",
        "CubicYard",
        "MetricTon",
        "Hour",
        "LinearMeter",
        "Unknown"
    ],
    "type": "string",
    "description": "The possible unit types for resources."
}

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

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

Resource

Resource Response

Resource Type

Resource Unit Type

Error

Error Response