Create Schedule - Schedules

Schedules

Download API definition:

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

POST https://dev-api.bentley.com/schedules/

Creates a Schedule.

The isNextGen value should always be true as v6.5 schedule creation is currently not supported.

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 headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.

Schedule Create Request

iModelId

String, null

The unique identifier of the iModel linked to the Schedule.

iTwinId

String

The unique identifier of the iTwin.

name

String

The name of the Schedule.

Example

json

{
    "iModelId": "047d77dd-e593-4099-9c5d-e5d6467336a4",
    "iTwinId": "bfe4d22d-027c-45d4-b3cc-50ecfa4b1bd7",
    "name": "My Schedule"
}

Response 201 Created

Created

json

{
    "schedule": {
        "iModelId": "047d77dd-e593-4099-9c5d-e5d6467336a4",
        "iTwinId": "bfe4d22d-027c-45d4-b3cc-50ecfa4b1bd7",
        "id": "a8ec5a39-595d-45dc-abf4-e6dc4e1ed707",
        "isNextGen": true,
        "name": "My Schedule",
        "type": "v10"
    }
}

Response headers

Location

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

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": "MissingRequiredProperty",
                "message": "A required property is missing or empty.",
                "target": "name"
            },
            {
                "code": "InvalidValue",
                "message": "Provided 'iTwinId' value is not valid. Requested iTwin is not available.",
                "target": "iTwinId"
            }
        ],
        "message": "The request contains invalid properties."
    }
}

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 403 Forbidden

User is not authorized to create a Schedule.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

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

Schedule

Representation of a Schedule

iModelId

String, null

The unique identifier of the iModel.

iTwinId

String

The unique identifier of the iTwin.

String

The unique identifier of the Schedule.

isNextGen

Boolean

Specifies whether the schedule is of v10 type.

name

String

The name of the Schedule.

type

ScheduleType

The type of the Schedule.

json

{
    "type": "object",
    "properties": {
        "iModelId": {
            "type": "string",
            "description": "The unique identifier of the iModel.",
            "nullable": true
        },
        "iTwinId": {
            "type": "string",
            "description": "The unique identifier of the iTwin."
        },
        "id": {
            "type": "string",
            "description": "The unique identifier of the Schedule."
        },
        "isNextGen": {
            "type": "boolean",
            "description": "Specifies whether the schedule is of v10 type."
        },
        "name": {
            "type": "string",
            "description": "The name of the Schedule."
        },
        "type": {
            "$ref": "#/components/schemas/ScheduleType",
            "description": "The type of the Schedule."
        }
    },
    "additionalProperties": false,
    "description": "Representation of a Schedule"
}

Schedule Create Request

Properties of the Schedule to be created.

iModelId

String, null

The unique identifier of the iModel linked to the Schedule.

iTwinId

String

The unique identifier of the iTwin.

name

String

The name of the Schedule.

json

{
    "title": "Schedule Create Request",
    "type": "object",
    "properties": {
        "iModelId": {
            "type": "string",
            "description": "The unique identifier of the iModel linked to the Schedule.",
            "nullable": true
        },
        "iTwinId": {
            "type": "string",
            "description": "The unique identifier of the iTwin."
        },
        "name": {
            "minLength": 1,
            "type": "string",
            "description": "The name of the Schedule."
        }
    },
    "additionalProperties": false,
    "description": "Properties of the Schedule to be created."
}

Schedule Response

Container for Schedule object.

schedule

Schedule

Schedule Properties.

json

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

Schedule Type

The type of Schedule. This value determines the type of functionality possible in the API. See the Schedule Types section for details.

v6.5

String

v10

String

Unknown

String

json

{
    "title": "Schedule Type",
    "enum": [
        "v6.5",
        "v10",
        "Unknown"
    ],
    "type": "string",
    "description": "The type of Schedule. This value determines the type of functionality possible in the API. See the [Schedule Types](#scheduletypes) section for details."
}

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?

V10 Endpoint

Authentication

Rate limits

Request

Request headers

Request body

Schedule Create Request

Example

Response

Response 201 Created

Response headers

Response 400 Bad Request

Response 401 Unauthorized

Response 403 Forbidden

Response 429 Too many requests

Response headers

Definitions

Schedule

Schedule Create Request

Schedule Response

Schedule Type

DetailedError

Detailed Error Response

Error

Error Response