Skip to main content

Get entity from Steps by key

GET 
/Steps(:id)

Get entity from Steps by key

Request​

Path Parameters

    id uuidrequired

    Possible values: Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

    key: id of Step

Query Parameters

    $select string[]

    Possible values: [featureModelId, iconUrl, type, order, mainCameraPositionId, backgroundUrl, thirdPartyUrl, sendDataOnConfigurationUpdate, visibleNodes, useStepImageAsConfigurationImage, hideInOrderEntry, hideInShowroom, hideInShowroomOverview, id, createdDate, updatedDate, organizationId, reference, creatorId, customField1, customField2, customField3, customField4, customField5, texts, organization]

    Select properties to be returned

    $expand string[]

    Possible values: [*, texts, organization]

    Expand related entities

Responses​

Retrieved entity

Schema

    featureModelId uuid
    iconUrl string
    type
    order int32

    Possible values: >= -2147483648 and <= 2147483647

    mainCameraPositionId uuid
    backgroundUrl string
    thirdPartyUrl string
    sendDataOnConfigurationUpdate boolean
    visibleNodes uuid[]

    Possible values: Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

    useStepImageAsConfigurationImage boolean
    hideInOrderEntry boolean
    hideInShowroom boolean
    hideInShowroomOverview boolean
    id uuid
    createdDate date-time
    updatedDate date-time
    organizationId uuid
    reference string
    creatorId uuid
    customField1 string
    customField2 string
    customField3 string
    customField4 string
    customField5 string

    texts

    object[]

  • Array [

    • value string
    languageIso string

    Possible values: <= 3 characters

    stepId uuid
    type
    id uuid
    createdDate date-time
    updatedDate date-time
    organizationId uuid
    reference string
    creatorId uuid
    customField1 string
    customField2 string
    customField3 string
    customField4 string
    customField5 string
    organization

  • ]

    • organization
Loading...