Get Rules - 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 https://dev-api.bentley.com/schedules/{scheduleId}/rules[?$top][&$continuationToken][&$deltaToken]

Gets all Rules of a Schedule.

Rules

Rules (production rates) can be assigned to Tasks. When used in conjunction with Physical Quantity and Physical Quantity Units, Task durations can be calculated based on Rules and Physical Quantity when Duration type is set to "Physical quantity dependent".

V10 Endpoint

This endpoint is only supported by v10 schedules. The schedule type can be identified by querying the /schedules/{scheduleId} endpoint.

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

Request parameters

scheduleId

Yes

The unique identifier of the Schedule.

$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.

$deltaToken

A token used for pagination to retrieve only those items which changed since the generation of the token. Delta token is generated on the last page.

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.

Response

Response 200 OK

json

{
    "rules": [{
        "deleted": false,
        "description": "Road",
        "id": "0d514705-f736-4555-998a-71323c837735",
        "parentId": null,
        "rate": 14.5,
        "unit": "Meter",
        "userDefinedId": "RUL00010"
    }, {
        "deleted": false,
        "description": "Concrete",
        "id": "ade94407-fa8d-4d86-9471-32e8506ac2d8",
        "parentId": "fb4c1e95-16d0-4b06-8f49-8e31e6425386",
        "rate": 4.25,
        "unit": "CubicMeter",
        "userDefinedId": "RUL00020"
    }],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/rules?$top=2"
        },
        "next": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/rules?$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.

Delta-Token

A token used for pagination to retrieve only those items which changed since the generation of the token. Delta token is generated on the last page.

ETag

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

Response 304 Not Modified

Not Modified

Response 400 Bad Request

The 400 (Bad Request) 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 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 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 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."
        }
    },
    "description": "Hyperlink container.",
    "additionalProperties": false
}

Rule

Representation of a Rule.

String

The unique identifier of the Rule.

rate

Double

The rate describes the production rate of unit per hour of the rule.

unit

All of: ResourceUnitType

The unit used to measure the Physical Quantity assigned to the Rule.

deleted

Boolean, null

Is this Rule deleted.

parentId

String, null

The unique identifier of the parent Rule.

description

String

The description of the Rule.

userDefinedId

String

A unique Rule Id defined by the user.

json

{
    "type": "object",
    "title": "Rule",
    "properties": {
        "id": {
            "type": "string",
            "description": "The unique identifier of the Rule."
        },
        "rate": {
            "type": "number",
            "format": "double",
            "description": "The rate describes the production rate of unit per hour of the rule."
        },
        "unit": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ResourceUnitType"
                }
            ],
            "description": "The unit used to measure the Physical Quantity assigned to the Rule."
        },
        "deleted": {
            "type": "boolean",
            "nullable": true,
            "description": "Is this Rule deleted."
        },
        "parentId": {
            "type": "string",
            "nullable": true,
            "description": "The unique identifier of the parent Rule."
        },
        "description": {
            "type": "string",
            "description": "The description of the Rule."
        },
        "userDefinedId": {
            "type": "string",
            "description": "A unique Rule Id defined by the user."
        }
    },
    "description": "Representation of a Rule.",
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "target": {
            "type": "string",
            "nullable": true,
            "description": "The target of the error."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information.",
    "additionalProperties": true
}

Paging Links

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

Link

self

Link

json

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

DetailedError

Contains error information and an array of more specific errors.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

details

Error[]

Optional array of more specific errors.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message",
        "details"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "target": {
            "type": "string",
            "nullable": true,
            "description": "The target of the error."
        },
        "details": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Error"
            },
            "description": "Optional array of more specific errors."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information and an array of more specific errors.",
    "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",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "$ref": "#/components/schemas/Error",
            "description": "Error information."
        }
    },
    "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.",
    "additionalProperties": false
}

Rules Response

List of Rules.

rules

Rule[]

A list of Rules.

_links

All of: PagingLinks

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

json

{
    "type": "object",
    "title": "Rules Response",
    "properties": {
        "rules": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Rule"
            },
            "description": "A list of Rules."
        },
        "_links": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PagingLinks"
                }
            ],
            "description": "Contains the hyperlinks to the current and next pages of results."
        }
    },
    "description": "List of Rules.",
    "additionalProperties": false
}

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

{
    "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",
    "title": "Resource Unit Type",
    "description": "The possible unit types for resources."
}

Detailed Error Response

error

DetailedError

Error Detailed information.

json

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

Was this page helpful?