Get Resource Status History Item - Schedules

Schedules

Download API definition:

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

Get Resource Status History Item

GET https://dev-api.bentley.com/schedules/{scheduleId}/resources/status-history/{statusHistoryItemId}

Get the details of a Resource Status History Item.

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.

statusHistoryItemId

Yes

The unique identifier of the Resource Status History Item.

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

{
    "statusHistoryItem": {
        "date": "2020-07-20T11:16:00Z",
        "id": "e8b741ca-8c90-4f48-8ddc-d04ba32dbbf8",
        "isCritical": false,
        "note": "Some note 1",
        "recordDate": "2020-08-13T11:16:00Z",
        "resourceId": "ffef8819-4bcd-404a-ba33-3a7c0b59679e",
        "statusCategoryId": "554043bf-c4e6-4cf0-85d8-8316c2ce808c",
        "statusItemId": "61486342-a67e-44f6-8126-ce6e33b6c3be"
    }
}

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 Status History Item or Schedule is not available.

json

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

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 Status History Item

Representation of a Resource Status History Item.

date

Date-time

The date the Status change actually occurred.

String

The unique identifier of the Resource Status History Item.

isCritical

Boolean

Is Resource Status History Item critical. Can be used to indicate a critical interrupt status, e.g. major delay.

note

String

An optional comment about the Status.

recordDate

Date-time

The current date when the Status was updated.

resourceId

String

The unique identifier of the Resource.

statusCategoryId

String

The unique identifier of the Resource Status Category.

statusItemId

String

The unique identifier of the Resource Status Item.

json

{
    "title": "Resource Status History Item",
    "type": "object",
    "properties": {
        "date": {
            "type": "string",
            "description": "The date the Status change actually occurred.",
            "format": "date-time"
        },
        "id": {
            "type": "string",
            "description": "The unique identifier of the Resource Status History Item."
        },
        "isCritical": {
            "type": "boolean",
            "description": "Is Resource Status History Item critical. Can be used to indicate a critical interrupt status, e.g. major delay."
        },
        "note": {
            "type": "string",
            "description": "An optional comment about the Status."
        },
        "recordDate": {
            "type": "string",
            "description": "The current date when the Status was updated.",
            "format": "date-time"
        },
        "resourceId": {
            "type": "string",
            "description": "The unique identifier of the Resource."
        },
        "statusCategoryId": {
            "type": "string",
            "description": "The unique identifier of the Resource Status Category."
        },
        "statusItemId": {
            "type": "string",
            "description": "The unique identifier of the Resource Status Item."
        }
    },
    "additionalProperties": false,
    "description": "Representation of a Resource Status History Item."
}

Resource Status History Item Response

Container for Resource Status History Item object.

statusHistoryItem

ResourceStatusHistoryItem

Resource Status History Item properties.

json

{
    "title": "Resource Status History Item Response",
    "type": "object",
    "properties": {
        "statusHistoryItem": {
            "$ref": "#/components/schemas/ResourceStatusHistoryItem",
            "description": "Resource Status History Item properties."
        }
    },
    "additionalProperties": false,
    "description": "Container for Resource Status History Item 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

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 Status History Item

Resource Status History Item Response

Error

Error Response