Update Appearance Profile - Schedules

Schedules

Download API definition:

This API 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.

V10 Endpoint

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

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.

Request body

Appearance Profile Update Request

name

String, null

The name of the Appearance Profile.

action

AppearanceProfileAction

parentId

String, null

The unique identifier of the parent Appearance Profile.

endAppearance

Appearance

startAppearance

Appearance

activeAppearance

ActiveAppearance

Example

json

{
    "action": "Maintain",
    "activeAppearance": null,
    "endAppearance": null,
    "name": "UpdatedAppearanceProfileName",
    "parentId": "ae73d684-2878-424e-bab2-025eafbf766b",
    "startAppearance": null
}

Response

Response 200 OK

json

{
    "appearanceProfile": {
        "action": "Maintain",
        "activeAppearance": {
            "color": "#00ff00",
            "finishTransparency": 53,
            "growthSimulation": {
                "adjustForTaskPercentComplete": true,
                "direction": {
                    "x": 0.37139067,
                    "y": 0.557086,
                    "z": 0.74278134
                },
                "mode": "Custom",
                "pauseDuringNonWorkingTime": true,
                "simulateAsRemove": false
            },
            "isEnabled": true,
            "startTransparency": 15,
            "useOriginalColor": true,
            "useOriginalTransparency": false
        },
        "createdOn": "2025-01-29T11:19:00.0000000+00:00",
        "deleted": false,
        "endAppearance": {
            "color": "#00ced1",
            "isEnabled": true,
            "transparency": 0,
            "useOriginalColor": false,
            "useOriginalTransparency": true
        },
        "id": "3defd13b-ab0a-49fa-b3ba-37dd8b9532f1",
        "name": "UpdatedAppearanceProfileName",
        "parentId": "ae73d684-2878-424e-bab2-025eafbf766b",
        "startAppearance": {
            "color": "#00ff00",
            "isEnabled": true,
            "transparency": 0,
            "useOriginalColor": false,
            "useOriginalTransparency": true
        }
    }
}

Response headers

ETag

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

Operation-Id

The unique identifier of the Operation.

Operation-Location

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

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

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
}

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
}

Color RGB

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

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

Appearance

The appearance of an object.

color

ColorRGB

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

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

Resource Growth

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

mode

GrowthSimulationMode

direction

Vector3d

simulateAsRemove

Boolean

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

pauseDuringNonWorkingTime

Boolean

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

adjustForTaskPercentComplete

Boolean

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

json

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

Active Appearance

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

color

ColorRGB

isEnabled

Boolean

User set property indicating if the appearance is enabled.

growthSimulation

ResourceGrowth

useOriginalColor

Boolean

Use the original color of the object.

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.

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.

useOriginalTransparency

Boolean

Use the original transparency of the object.

json

{
    "type": "object",
    "title": "Active Appearance",
    "properties": {
        "color": {
            "$ref": "#/components/schemas/ColorRGB"
        },
        "isEnabled": {
            "type": "boolean",
            "default": true,
            "description": "User set property indicating if the appearance is enabled."
        },
        "growthSimulation": {
            "$ref": "#/components/schemas/ResourceGrowth"
        },
        "useOriginalColor": {
            "type": "boolean",
            "description": "Use the original color of the object."
        },
        "startTransparency": {
            "type": "integer",
            "format": "int32",
            "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."
        },
        "finishTransparency": {
            "type": "integer",
            "format": "int32",
            "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."
        },
        "useOriginalTransparency": {
            "type": "boolean",
            "description": "Use the original transparency of the object."
        }
    },
    "description": "Properties describing how the appearance of an object changes while assigned Task is in progress.",
    "additionalProperties": false
}

Appearance Profile

Representation of an Appearance Profile.

String

The unique identifier of the Appearance Profile.

name

String, null

The name of the Appearance Profile.

action

AppearanceProfileAction

deleted

Boolean, null

Is this Appearance Profile deleted.

parentId

String, null

The unique identifier of the parent Appearance Profile.

createdOn

Date, null

The date on which the Appearance Profile was created.

endAppearance

Appearance

startAppearance

Appearance

activeAppearance

ActiveAppearance

json

{
    "type": "object",
    "title": "Appearance Profile",
    "properties": {
        "id": {
            "type": "string",
            "description": "The unique identifier of the Appearance Profile."
        },
        "name": {
            "type": "string",
            "nullable": true,
            "description": "The name of the Appearance Profile."
        },
        "action": {
            "$ref": "#/components/schemas/AppearanceProfileAction"
        },
        "deleted": {
            "type": "boolean",
            "nullable": true,
            "description": "Is this Appearance Profile deleted."
        },
        "parentId": {
            "type": "string",
            "nullable": true,
            "description": "The unique identifier of the parent Appearance Profile."
        },
        "createdOn": {
            "type": "string",
            "format": "date",
            "nullable": true,
            "description": "The date on which the Appearance Profile was created."
        },
        "endAppearance": {
            "$ref": "#/components/schemas/Appearance"
        },
        "startAppearance": {
            "$ref": "#/components/schemas/Appearance"
        },
        "activeAppearance": {
            "$ref": "#/components/schemas/ActiveAppearance"
        }
    },
    "description": "Representation of an Appearance Profile.",
    "additionalProperties": false
}

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

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

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
}

Operation Location

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

operationLocation

Link

json

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

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

{
    "enum": [
        "Install",
        "Temporary",
        "Remove",
        "Maintain",
        "Neutral",
        "Unknown"
    ],
    "type": "string",
    "title": "Appearance Profile Action",
    "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 Update Request

Properties of the Appearance Profile to be updated.

name

String, null

The name of the Appearance Profile.

action

AppearanceProfileAction

parentId

String, null

The unique identifier of the parent Appearance Profile.

endAppearance

Appearance

startAppearance

Appearance

activeAppearance

ActiveAppearance

json

{
    "type": "object",
    "title": "Appearance Profile Update Request",
    "properties": {
        "name": {
            "type": "string",
            "nullable": true,
            "minLength": 1,
            "description": "The name of the Appearance Profile."
        },
        "action": {
            "$ref": "#/components/schemas/AppearanceProfileAction"
        },
        "parentId": {
            "type": "string",
            "nullable": true,
            "description": "The unique identifier of the parent Appearance Profile."
        },
        "endAppearance": {
            "$ref": "#/components/schemas/Appearance"
        },
        "startAppearance": {
            "$ref": "#/components/schemas/Appearance"
        },
        "activeAppearance": {
            "$ref": "#/components/schemas/ActiveAppearance"
        }
    },
    "description": "Properties of the Appearance Profile to be updated.",
    "additionalProperties": false
}

Appearance Profile Create Response

Contains properties of the created Appearance Profile.

_links

OperationLocationLink

operation

OperationCreateResponseProperties

appearanceProfile

AppearanceProfile

json

{
    "type": "object",
    "title": "Appearance Profile Create Response",
    "properties": {
        "_links": {
            "$ref": "#/components/schemas/OperationLocationLink"
        },
        "operation": {
            "$ref": "#/components/schemas/OperationCreateResponseProperties"
        },
        "appearanceProfile": {
            "$ref": "#/components/schemas/AppearanceProfile"
        }
    },
    "description": "Contains properties of the created Appearance Profile.",
    "additionalProperties": false
}

Operation Create Response Properties

Contains the id of the created long-running operation.

String, null

The unique identifier of the Operation.

json

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

Appearance Profile Operation Response

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

_links

OperationLocationLink

operation

OperationCreateResponseProperties

appearanceProfile

AppearanceProfileOperationResponseProperties

json

{
    "type": "object",
    "title": "Appearance Profile Operation Response",
    "properties": {
        "_links": {
            "$ref": "#/components/schemas/OperationLocationLink"
        },
        "operation": {
            "$ref": "#/components/schemas/OperationCreateResponseProperties"
        },
        "appearanceProfile": {
            "$ref": "#/components/schemas/AppearanceProfileOperationResponseProperties"
        }
    },
    "description": "Contains properties of the created long-running operation, and a link to this operation.",
    "additionalProperties": false,
    "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

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

Was this page helpful?