Create Resource - Schedules

Operations, also known as LROs (Long Running Operations), are time-consuming tasks that would not be completed in the appropriate timeframe for a single request response. Endpoints that use operations return an operation id that can be used on a separate endpoint to track the progress of the task that is being handled.

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.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Request body

Resource Create Request

description

String, null

The description of the resource.

String, null

An email address associated with the resource. Only allowed for resources of Human type.

String

The unique identifier of the Resource.

name

String

The name of the Resource.

parentId

String, null

The unique identifier of the parent Resource.

type

ResourceType

The type of the Resource.

url

String, null

A URL associated with the Resource.

userDefinedId

String, null

A unique Resource Id defined by the user.

Example

json

{
    "description": "A box",
    "email": "",
    "id": "385c7013-1fb9-4ee5-92a9-4af73a0c5a29",
    "name": "Box 1",
    "parentId": null,
    "type": "Material",
    "url": "https://example.com",
    "userDefinedId": "Custom Id 001"
}

Response

Response 202 Accepted

This response indicates that the requested long-running operation was Accepted.

json

{
    "operation": {
        "id": "1604789f-68c4-46ba-b20d-8a19f8319362"
    },
    "resource": {
        "id": "385c7013-1fb9-4ee5-92a9-4af73a0c5a29"
    },
    "_links": {
        "operationLocation": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/operations/1604789f-68c4-46ba-b20d-8a19f8319362"
        }
    }
}

Response headers

Operation-Id

The unique identifier of the Operation.

Operation-Location

URL to the Operations endpoint with pre-entered Operation ID.

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": "MissingRequiredProperty",
                "message": "A required property is missing or empty.",
                "target": "type"
            },
            {
                "code": "InvalidValue",
                "message": "The 'email' property is only allowed for resources with Human type.",
                "target": "email"
            }
        ],
        "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 403 Forbidden

User is not authorized to create a Resource.

json

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

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 409 Conflict

This response indicates that a changeset with provided Id already exists or provided Schedule is not initialized.

json

{
    "error": {
        "code": "ScheduleNotInitialized",
        "message": "Provided Schedule is not initialized. Current Schedule state: 'Processing'."
    }
}

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

Operation Create Response Properties

Contains the id of the created long-running operation.

String, null

The unique identifier of the Operation.

json

{
    "title": "Operation Create Response Properties",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "The unique identifier of the Operation.",
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Contains the id of the created long-running operation."
}

Operation Location

Contains the URL to the Operations endpoint to check the information about a long-running operation.

operationLocation

Link

URL to the Operations endpoint with pre-entered Operation ID.

json

{
    "title": "Operation Location",
    "type": "object",
    "properties": {
        "operationLocation": {
            "$ref": "#/components/schemas/Link",
            "description": "URL to the Operations endpoint with pre-entered Operation ID."
        }
    },
    "additionalProperties": false,
    "description": "Contains the URL to the Operations endpoint to check the information about a long-running operation."
}

Resource Create Request

Properties of the Resource to be created.

description

String, null

The description of the resource.

String, null

An email address associated with the resource. Only allowed for resources of Human type.

String

The unique identifier of the Resource.

name

String

The name of the Resource.

parentId

String, null

The unique identifier of the parent Resource.

type

ResourceType

The type of the Resource.

url

String, null

A URL associated with the Resource.

userDefinedId

String, null

A unique Resource Id defined by the user.

json

{
    "title": "Resource Create Request",
    "type": "object",
    "properties": {
        "description": {
            "type": "string",
            "description": "The description of the resource.",
            "nullable": true
        },
        "email": {
            "type": "string",
            "description": "An email address associated with the resource. Only allowed for resources of Human type.",
            "nullable": true
        },
        "id": {
            "type": "string",
            "description": "The unique identifier of the Resource."
        },
        "name": {
            "type": "string",
            "description": "The name of the Resource."
        },
        "parentId": {
            "type": "string",
            "description": "The unique identifier of the parent Resource.",
            "nullable": true
        },
        "type": {
            "$ref": "#/components/schemas/ResourceType",
            "description": "The type of the Resource."
        },
        "url": {
            "type": "string",
            "description": "A URL associated with the Resource.",
            "nullable": true
        },
        "userDefinedId": {
            "type": "string",
            "description": "A unique Resource Id defined by the user.",
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Properties of the Resource to be created."
}

Resource Create Response

Contains properties of the created long-running operation, and a link to this operation.

operation

OperationCreateResponseProperties

Contains properties of the created long-running operation.

resource

ResourceCreateResponseProperties

Properties of the Resource to be created.

_links

OperationLocationLink

Contains the hyperlink to the Operations endpoint to check the operation information.

json

{
    "title": "Resource Create Response",
    "type": "object",
    "properties": {
        "operation": {
            "$ref": "#/components/schemas/OperationCreateResponseProperties",
            "description": "Contains properties of the created long-running operation."
        },
        "resource": {
            "$ref": "#/components/schemas/ResourceCreateResponseProperties",
            "description": "Properties of the Resource to be created."
        },
        "_links": {
            "$ref": "#/components/schemas/OperationLocationLink",
            "description": "Contains the hyperlink to the Operations endpoint to check the operation information."
        }
    },
    "additionalProperties": false,
    "description": "Contains properties of the created long-running operation, and a link to this operation.",
    "x-codegen-extends-class": "OperationCreateResponse"
}

Resource Create Response Properties

Contains properties of the Resource that is queued for creation.

String

The unique identifier of the Resource.

json

{
    "title": "Resource Create Response Properties",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "The unique identifier of the Resource."
        }
    },
    "additionalProperties": false,
    "description": "Contains properties of the Resource that is queued for creation."
}

Resource Type

The type of a Resource.

Material

String

Location

String

Equipment

String

Human

String

Unknown

String

json

{
    "title": "Resource Type",
    "enum": [
        "Material",
        "Location",
        "Equipment",
        "Human",
        "Unknown"
    ],
    "type": "string",
    "description": "The type of a Resource."
}

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?