Patch Appearance Profile - Schedules

Schedules

Download API definition:

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

PATCH https://dev-api.bentley.com/schedules/{scheduleId}/appearance-profiles/{appearanceProfileId}

Update an Appearance Profile for a Schedule.

Appearance Profile

Appearance Profiles provide an indication of how a particular resource is used in a SYNCHRO Project, and allows the appearance (display, colour and transparency) of the resource to be changed as the resource is utilised.

Appearance Profile Actions

Appearance profile Action describes how assigned resources are displayed before, during and after the assigned Task.

Install

Not displayed

Displayed as active

Displayed

Remove

Displayed

Displayed as active

Not displayed

Temporary

Not displayed

Displayed as active

Not displayed

Maintain before Install

Not displayed

Displayed as active

Not displayed

Maintain after Install

Displayed

Displayed as active

Displayed

Neutral before Install

Not displayed

Neutral after Install

Displayed

Operation

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.

appearanceProfileId

Yes

The unique identifier of the Appearance Profile.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Entity to update the Appearance Profile.

Request body

Appearance Profile Update Request

action

AppearanceProfileAction, null

The action indicates the display status of a resource in relation to a task's lifecycle.

activeAppearance

ActiveAppearance, null

The Active Appearance describes how assigned resources change while the assigned Task is in progress.

endAppearance

Appearance, null

The appearance of assigned resources after the assigned Task has passed.

name

String, null

The name of the Appearance Profile.

parentId

String, null

The unique identifier of the parent Appearance Profile.

startAppearance

Appearance, null

The appearance of assigned resources before the assigned Task has started.

Example

json

{
    "action": "Install",
    "activeAppearance": null,
    "endAppearance": null,
    "name": "AppearanceProfileName",
    "parentId": null,
    "startAppearance": null
}

Response

Response 202 Accepted

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

json

{
    "appearanceProfile": {
        "id": "ae73d684-2878-424e-bab2-025eafbf766b"
    },
    "operation": {
        "id": "1604789f-68c4-46ba-b20d-8a19f8319362"
    },
    "_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": "InvalidValue",
            "message": "The 'action' property must not be Unknown.",
            "target": "action"
        }],
        "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 update an Appearance Profile.

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

Active Appearance

Properties describing how the appearance of an object changes while assigned Task is in progress.

color

ColorRGB

The color of the object.

finishTransparency

Int32

How transparent the object is in the end of the assigned Task. Value is in the range [0, 100], with 0 being completely opaque and 100 being completely transparent.

growthSimulation

ResourceGrowth

Growth simulation describes how the object grows while it is being installed or removed.

isEnabled

Boolean

User set property indicating if the appearance is enabled.

startTransparency

Int32

How transparent the object is in the start of the assigned Task. Value is in the range [0, 100], with 0 being completely opaque and 100 being completely transparent.

useOriginalColor

Boolean

Use the original color of the object.

useOriginalTransparency

Boolean

Use the original transparency of the object.

json

{
    "title": "Active Appearance",
    "type": "object",
    "properties": {
        "color": {
            "$ref": "#/components/schemas/ColorRGB",
            "description": "The color of the object."
        },
        "finishTransparency": {
            "type": "integer",
            "description": "How transparent the object is in the end of the assigned Task. Value is in the range [0, 100], with 0 being completely opaque and 100 being completely transparent.",
            "format": "int32"
        },
        "growthSimulation": {
            "$ref": "#/components/schemas/ResourceGrowth",
            "description": "Growth simulation describes how the object grows while it is being installed or removed."
        },
        "isEnabled": {
            "type": "boolean",
            "description": "User set property indicating if the appearance is enabled.",
            "default": true
        },
        "startTransparency": {
            "type": "integer",
            "description": "How transparent the object is in the start of the assigned Task. Value is in the range [0, 100], with 0 being completely opaque and 100 being completely transparent.",
            "format": "int32"
        },
        "useOriginalColor": {
            "type": "boolean",
            "description": "Use the original color of the object."
        },
        "useOriginalTransparency": {
            "type": "boolean",
            "description": "Use the original transparency of the object."
        }
    },
    "additionalProperties": false,
    "description": "Properties describing how the appearance of an object changes while assigned Task is in progress."
}

Appearance

The appearance of an object.

color

ColorRGB

The color of the object.

isEnabled

Boolean

User set property indicating if the appearance is enabled.

transparency

Int32

How transparent the object is. Value is in the range [0, 100], with 0 being completely opaque and 100 being completely transparent.

useOriginalColor

Boolean

Use the original color of the object.

useOriginalTransparency

Boolean

Use the original transparency of the object.

json

{
    "title": "Appearance",
    "type": "object",
    "properties": {
        "color": {
            "$ref": "#/components/schemas/ColorRGB",
            "description": "The color of the object."
        },
        "isEnabled": {
            "type": "boolean",
            "description": "User set property indicating if the appearance is enabled.",
            "default": true
        },
        "transparency": {
            "type": "integer",
            "description": "How transparent the object is. Value is in the range [0, 100], with 0 being completely opaque and 100 being completely transparent.",
            "format": "int32"
        },
        "useOriginalColor": {
            "type": "boolean",
            "description": "Use the original color of the object."
        },
        "useOriginalTransparency": {
            "type": "boolean",
            "description": "Use the original transparency of the object."
        }
    },
    "additionalProperties": false,
    "description": "The appearance of an object."
}

Appearance Profile Action

Appearance Profile Action indicates the display status of a resource in relation to a task's lifecycle. See the Appearance Profile Actions section for details.

Install

String

Temporary

String

Remove

String

Maintain

String

Neutral

String

Unknown

String

json

{
    "title": "Appearance Profile Action",
    "enum": [
        "Install",
        "Temporary",
        "Remove",
        "Maintain",
        "Neutral",
        "Unknown"
    ],
    "type": "string",
    "description": "Appearance Profile Action indicates the display status of a resource in relation to a task's lifecycle. See the [Appearance Profile Actions](#appearance-profile-actions) section for details."
}

Appearance Profile Operation Response

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

appearanceProfile

AppearanceProfileOperationResponseProperties

Properties of the Appearance Profile to be created or updated.

operation

OperationCreateResponseProperties

Contains properties of the created long-running operation.

_links

OperationLocationLink

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

json

{
    "title": "Appearance Profile Operation Response",
    "type": "object",
    "properties": {
        "appearanceProfile": {
            "$ref": "#/components/schemas/AppearanceProfileOperationResponseProperties",
            "description": "Properties of the Appearance Profile to be created or updated."
        },
        "operation": {
            "$ref": "#/components/schemas/OperationCreateResponseProperties",
            "description": "Contains properties of the created long-running operation."
        },
        "_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"
}

Appearance Profile Operation Response Properties

Contains properties of the Appearance Profile that is queued for creation or update.

String

The unique identifier of the Appearance Profile.

json

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

Appearance Profile Update Request

Properties of the Appearance Profile to be updated.

action

AppearanceProfileAction, null

The action indicates the display status of a resource in relation to a task's lifecycle.

activeAppearance

ActiveAppearance, null

The Active Appearance describes how assigned resources change while the assigned Task is in progress.

endAppearance

Appearance, null

The appearance of assigned resources after the assigned Task has passed.

name

String, null

The name of the Appearance Profile.

parentId

String, null

The unique identifier of the parent Appearance Profile.

startAppearance

Appearance, null

The appearance of assigned resources before the assigned Task has started.

json

{
    "title": "Appearance Profile Update Request",
    "type": "object",
    "properties": {
        "action": {
            "$ref": "#/components/schemas/AppearanceProfileAction",
            "description": "The action indicates the display status of a resource in relation to a task's lifecycle.",
            "nullable": true
        },
        "activeAppearance": {
            "$ref": "#/components/schemas/ActiveAppearance",
            "description": "The Active Appearance describes how assigned resources change while the assigned Task is in progress.",
            "nullable": true
        },
        "endAppearance": {
            "$ref": "#/components/schemas/Appearance",
            "description": "The appearance of assigned resources after the assigned Task has passed.",
            "nullable": true
        },
        "name": {
            "minLength": 1,
            "type": "string",
            "description": "The name of the Appearance Profile.",
            "nullable": true
        },
        "parentId": {
            "type": "string",
            "description": "The unique identifier of the parent Appearance Profile.",
            "nullable": true
        },
        "startAppearance": {
            "$ref": "#/components/schemas/Appearance",
            "description": "The appearance of assigned resources before the assigned Task has started.",
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Properties of the Appearance Profile to be updated."
}

Color RGB

Growth Simulation Mode

The direction of Growth Simulation.

BottomTop

String

TopBottom

String

LeftRight

String

RightLeft

String

FrontBack

String

BackFront

String

Custom

String

None

String

Unknown

String

json

{
    "title": "Growth Simulation Mode",
    "enum": [
        "BottomTop",
        "TopBottom",
        "LeftRight",
        "RightLeft",
        "FrontBack",
        "BackFront",
        "Custom",
        "None",
        "Unknown"
    ],
    "type": "string",
    "description": "The direction of Growth Simulation."
}

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 Growth

A representation of how an object grows while it is installed or removed.

adjustForTaskPercentComplete

Boolean

When this value is enabled the Growth Simulation is affected by the Task percent complete.

direction

Vector3d

The direction vector of installation or removal. Should be used when the Mode property is set to 'Custom'.

mode

GrowthSimulationMode

The direction enum of installation or removal.

pauseDuringNonWorkingTime

Boolean

When this value is enabled the Growth Simulation will be paused during non working hours.

simulateAsRemove

Boolean

When this value is enabled the Growth Simulation will appear as if the object is being removed.

json

{
    "title": "Resource Growth",
    "type": "object",
    "properties": {
        "adjustForTaskPercentComplete": {
            "type": "boolean",
            "description": "When this value is enabled the Growth Simulation is affected by the Task percent complete."
        },
        "direction": {
            "$ref": "#/components/schemas/Vector3d",
            "description": "The direction vector of installation or removal. Should be used when the Mode property is set to 'Custom'."
        },
        "mode": {
            "$ref": "#/components/schemas/GrowthSimulationMode",
            "description": "The direction enum of installation or removal."
        },
        "pauseDuringNonWorkingTime": {
            "type": "boolean",
            "description": "When this value is enabled the Growth Simulation will be paused during non working hours."
        },
        "simulateAsRemove": {
            "type": "boolean",
            "description": "When this value is enabled the Growth Simulation will appear as if the object is being removed."
        }
    },
    "additionalProperties": false,
    "description": "A representation of how an object grows while it is installed or removed."
}

Vector 3D

A 3D vector.

Double

The normalized X axis of the vector. The value is in the range [0, 1].

Double

The normalized Y axis of the vector. The value is in the range [0, 1].

Double

The normalized Z axis of the vector. The value is in the range [0, 1].

json

{
    "title": "Vector 3D",
    "type": "object",
    "properties": {
        "x": {
            "type": "number",
            "description": "The normalized X axis of the vector. The value is in the range [0, 1].",
            "format": "double"
        },
        "y": {
            "type": "number",
            "description": "The normalized Y axis of the vector. The value is in the range [0, 1].",
            "format": "double"
        },
        "z": {
            "type": "number",
            "description": "The normalized Z axis of the vector. The value is in the range [0, 1].",
            "format": "double"
        }
    },
    "additionalProperties": false,
    "description": "A 3D vector."
}

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?