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

Get Appearance Profile

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

Gets the details of an Appearance Profile.

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.

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

Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.

Request parameters

scheduleId

Yes

The unique identifier of the Schedule.

appearanceProfileId

Yes

The unique identifier of the Appearance Profile.

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

json

{
    "appearanceProfile": {
        "action": "Install",
        "activeAppearance": {
            "color": "#00ff00",
            "finishTransparency": 53,
            "growthSimulation": {
                "adjustForTaskPercentComplete": true,
                "direction": {
                    "x": 0.37139067,
                    "y": 0.557086,
                    "z": 0.74278134
                },
                "mode": "Custom",
                "pauseDuringNonWorkingTime": true,
                "simulateAsRemove": false
            },
            "startTransparency": 15,
            "useOriginalColor": true,
            "useOriginalTransparency": false
        },
        "createdOn": "2025-01-29T11:19:00Z",
        "endAppearance": {
            "color": "#00ced1",
            "transparency": 0,
            "useOriginalColor": false,
            "useOriginalTransparency": true
        },
        "id": "3defd13b-ab0a-49fa-b3ba-37dd8b9532f1",
        "name": "Custom Profile 1",
        "parentId": null,
        "startAppearance": {
            "color": "#00ff00",
            "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.

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 Appearance Profile or Schedule is not available.

json

{
    "error": {
        "code": "AppearanceProfileNotFound",
        "message": "Requested Appearance Profile is not available.",
        "target": "appearanceProfileId"
    }
}

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.

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

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

Representation of an Appearance Profile.

action

AppearanceProfileAction

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

activeAppearance

ActiveAppearance

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

createdOn

Date, null

The date on which the Appearance Profile was created.

endAppearance

Appearance

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

String

The unique identifier of the Appearance Profile.

name

String, null

The name of the Appearance Profile.

parentId

String, null

The unique identifier of the parent Appearance Profile.

startAppearance

Appearance

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

json

{
    "title": "Appearance Profile",
    "type": "object",
    "properties": {
        "action": {
            "$ref": "#/components/schemas/AppearanceProfileAction",
            "description": "The action property indicates the display status of a resource in relation to a task's lifecycle."
        },
        "activeAppearance": {
            "$ref": "#/components/schemas/ActiveAppearance",
            "description": "The Active Appearance describes how assigned resources change while the assigned Task is in progress."
        },
        "createdOn": {
            "type": "string",
            "description": "The date on which the Appearance Profile was created.",
            "format": "date",
            "nullable": true
        },
        "endAppearance": {
            "$ref": "#/components/schemas/Appearance",
            "description": "The appearance of assigned resources after the assigned Task has passed."
        },
        "id": {
            "type": "string",
            "description": "The unique identifier of the Appearance Profile."
        },
        "name": {
            "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."
        }
    },
    "additionalProperties": false,
    "description": "Representation of an Appearance Profile."
}

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 Response

Container for Appearance Profile object.

appearanceProfile

AppearanceProfile

Appearance Profile properties.

json

{
    "title": "Appearance Profile Response",
    "type": "object",
    "properties": {
        "appearanceProfile": {
            "$ref": "#/components/schemas/AppearanceProfile",
            "description": "Appearance Profile properties."
        }
    },
    "additionalProperties": false,
    "description": "Container for Appearance Profile object."
}

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

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

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

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",
    "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?

Authentication

Appearance Profile Actions

Rate limits

Request

Request parameters

Request headers

Response

Response 200 OK

Response headers

Response 304 Not Modified

Response 401 Unauthorized

Response 404 Not Found

Response 429 Too many requests

Response headers

Definitions

Active Appearance

Appearance

Appearance Profile

Appearance Profile Action

Appearance Profile Response

Color RGB

Growth Simulation Mode

Resource Growth

Vector 3D

Error

Error Response