Get Resource Status Items - Schedules

Schedules

Download API definition:

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

GET https://dev-api.bentley.com/schedules/{scheduleId}/resource-status-items[?name][&statusSetId][&$top][&$continuationToken]

Gets all Resource Status Items of a Schedule.

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.

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.

name

Gets resource status items with specified name or part of it.

statusSetId

Gets resource status items with specified status set Id.

$top

The $top system query option requests the number of items in the queried collection to be included in the result. When $top parameter is not provided default is set to 100. $top value cannot exceed 10000.

$continuationToken

A token used for pagination to retrieve the next set of results. It indicates where the previous page of results ended, allowing you to fetch the subsequent batch of data.

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

{
    "resourceStatusItems": [{
            "color": "#00ffff",
            "id": "0295daca-ad3e-4224-b028-6c25e0c87d40",
            "isVisible": true,
            "name": "Status 1",
            "statusSetId": "40b718e6-8760-4a1b-9959-aebd980e4bbb",
            "transparency": 0,
            "useOriginalTransparency": true
        },
        {
            "color": "#ff0000",
            "id": "0b4e0dd6-0700-43eb-af10-a7bdd6fa6e3f",
            "isVisible": true,
            "name": "Status 2",
            "statusSetId": "6e086edd-462c-4283-995f-f3810c67e3f3",
            "transparency": 50,
            "useOriginalTransparency": false
        }
    ],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/resource-status-items?$top=2"
        },
        "next": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/resource-status-items?$top=2&$continuationToken=eyJQcmltYXJ5U2tpcFRva2VuIjoiMDAwNGE5MDAtM2UxYy00NGNlLThhMzktYWUxZWRlY2M1MWY0IiwiU2Vjb25kYXJ5U2tpcFRva2VuIjpudWxsfQ=="
        }
    }
}

Response headers

Continuation-Token

A token used for pagination to retrieve the next set of results. It indicates where the previous page of results ended, allowing you to fetch the subsequent batch of data.

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

json

{
    "error": {
        "code": "ScheduleNotFound",
        "message": "Requested Schedule is not available.",
        "target": "scheduleId"
    }
}

Response 422 Unprocessable Entity

The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax).

json

{
    "error": {
        "code": "InvalidSchedulesRequest",
        "details": [{
                "code": "InvalidValue",
                "message": "Top value is not positive, or exceeds maximum page size.",
                "target": "$top"
            },
            {
                "code": "InvalidValue",
                "message": "Provided continuation token is invalid.",
                "target": "$continuationToken"
            }
        ],
        "message": "The request contains invalid properties."
    }
}

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

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

json

{
    "type": "object",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink to the specific entity."
        }
    },
    "additionalProperties": false,
    "description": "Hyperlink container."
}

Paging Links

URLs for redoing the current request and/or getting the next page of results if applicable.

self

Link

Relative URL for redoing the current request.

Link, null

Relative URL for getting the next page of results.

json

{
    "title": "Paging Links",
    "type": "object",
    "properties": {
        "self": {
            "$ref": "#/components/schemas/Link",
            "description": "Relative URL for redoing the current request."
        },
        "next": {
            "$ref": "#/components/schemas/Link",
            "description": "Relative URL for getting the next page of results.",
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "URLs for redoing the current request and/or getting the next page of results if applicable."
}

Resource Status Item

Representation of a Resource Status Item.

color

String

The color the Resources with this Status Item should appear.

String

The unique identifier of the Resource Status Item.

isVisible

Boolean

Specifies whether Resources with this Status Item should be visible.

name

String

The name of the Resource Status Item.

statusSetId

String

The unique identifier of the Resource Status Set.

transparency

Int32

The transparency the Resources with this Status Item should appear when Use Original Transparency is false.

useOriginalTransparency

Boolean

When true, the Resources with this Status Item are shown using normal transparency.

json

{
    "title": "Resource Status Item",
    "type": "object",
    "properties": {
        "color": {
            "type": "string",
            "description": "The color the Resources with this Status Item should appear.",
            "example": "#00ff00"
        },
        "id": {
            "type": "string",
            "description": "The unique identifier of the Resource Status Item."
        },
        "isVisible": {
            "type": "boolean",
            "description": "Specifies whether Resources with this Status Item should be visible."
        },
        "name": {
            "type": "string",
            "description": "The name of the Resource Status Item."
        },
        "statusSetId": {
            "type": "string",
            "description": "The unique identifier of the Resource Status Set."
        },
        "transparency": {
            "type": "integer",
            "description": "The transparency the Resources with this Status Item should appear when Use Original Transparency is false.",
            "format": "int32"
        },
        "useOriginalTransparency": {
            "type": "boolean",
            "description": "When true, the Resources with this Status Item are shown using normal transparency."
        }
    },
    "additionalProperties": false,
    "description": "Representation of a Resource Status Item."
}

Resource Status Items Response

List of Resource Status Items.

resourceStatusItems

ResourceStatusItem[]

A list of Resource Status Items.

_links

PagingLinks

Contains the hyperlinks to the current and next pages of results.

json

{
    "title": "Resource Status Items Response",
    "type": "object",
    "properties": {
        "resourceStatusItems": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/ResourceStatusItem"
            },
            "description": "A list of Resource Status Items."
        },
        "_links": {
            "$ref": "#/components/schemas/PagingLinks",
            "description": "Contains the hyperlinks to the current and next pages of results."
        }
    },
    "additionalProperties": false,
    "description": "List of Resource Status Items."
}

DetailedError

Contains error information and an array of more specific errors.

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.

details

Error[]

Optional array of more specific errors.

json

{
    "type": "object",
    "description": "Contains error information and an array of more specific errors.",
    "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
        },
        "details": {
            "type": "array",
            "description": "Optional array of more specific errors.",
            "items": {
                "$ref": "#/components/schemas/Error"
            }
        }
    },
    "required": [
        "code",
        "message",
        "details"
    ],
    "additionalProperties": true
}

Detailed 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

DetailedError

Error Detailed information.

json

{
    "type": "object",
    "title": "Detailed 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 Detailed information.",
            "$ref": "#/components/schemas/DetailedError"
        }
    },
    "required": [
        "error"
    ],
    "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

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 422 Unprocessable Entity

Response 429 Too many requests

Response headers

Definitions

Link

Paging Links

Resource Status Item

Resource Status Items Response

DetailedError

Detailed Error Response

Error

Error Response