Skip to main content

Get entity from Steps by key

GET 
https://api.elfsquad.io/data/1/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, isElfsquadViewer, 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
    featureModelIduuid
    iconUrlstring
    type
    orderint32

    Possible values: >= -2147483648 and <= 2147483647

    mainCameraPositionIduuid
    backgroundUrlstring
    thirdPartyUrlstring
    sendDataOnConfigurationUpdateboolean
    visibleNodesuuid[]

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

    useStepImageAsConfigurationImageboolean
    hideInOrderEntryboolean
    hideInShowroomboolean
    hideInShowroomOverviewboolean
    isElfsquadViewerboolean
    iduuid
    createdDatedate-time
    updatedDatedate-time
    organizationIduuid
    referencestring
    creatorIduuid
    customField1string
    customField2string
    customField3string
    customField4string
    customField5string
    texts object[]
  • Array [
    • valuestring
    languageIsostring

    Possible values: <= 3 characters

    stepIduuid
    type
    iduuid
    createdDatedate-time
    updatedDatedate-time
    organizationIduuid
    referencestring
    creatorIduuid
    customField1string
    customField2string
    customField3string
    customField4string
    customField5string
    organization
  • ]
    • organization
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.elfsquad.io/data/1");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://api.elfsquad.io/data/1
Parameters
— pathrequired
— query
— query
ResponseClear

Click the Send API Request button above and see the response here!