Skip to main content

Get entities from Steps

GET 
/Steps

Get entities from Steps

Request​

Query Parameters

    $top integer

    Show only the first n items

    $skip integer

    Skip the first n items

    $search string

    Search items by search phrases

    $filter string

    Filter items by property values

    $count boolean

    Include count of items

    $orderby string[]

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

    Order items by property values

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

Schema

    value

    object[]

  • Array [

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