Get Rule - 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/{ruleId}

Gets the details of a Rule.

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

ruleId

Yes

The unique identifier of the Rule.

scheduleId

Yes

The unique identifier of the Schedule.

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

Response 200 OK

json

{
    "rule": {
        "deleted": false,
        "description": "Road",
        "id": "0d514705-f736-4555-998a-71323c837735",
        "parentId": null,
        "rate": 14.5,
        "unit": "Meter",
        "userDefinedId": "RUL00010"
    }
}

Response headers

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 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 Rule 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

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
}

Rule Response

Container for Rule object.

rule

All of: Rule

Rule Properties.

json

{
    "type": "object",
    "title": "Rule Response",
    "properties": {
        "rule": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Rule"
                }
            ],
            "description": "Rule Properties."
        }
    },
    "description": "Container for Rule object.",
    "additionalProperties": false
}

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
}

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."
}

Was this page helpful?