Add new entity to Steps

POST 
/Steps

Add new entity to Steps

Request

application/json

Body

required

New entity

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

Responses

201

Created entity

application/json

Schema

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

Example (from schema)

{
  "featureModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "iconUrl": "string",
  "type": {},
  "order": 0,
  "mainCameraPositionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "backgroundUrl": "string",
  "thirdPartyUrl": "string",
  "sendDataOnConfigurationUpdate": true,
  "visibleNodes": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "useStepImageAsConfigurationImage": true,
  "hideInOrderEntry": true,
  "hideInShowroom": true,
  "hideInShowroomOverview": true,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdDate": "2024-06-06T15:30:37.725Z",
  "updatedDate": "2024-06-06T15:30:37.725Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": "string",
  "creatorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "customField1": "string",
  "customField2": "string",
  "customField3": "string",
  "customField4": "string",
  "customField5": "string",
  "texts": [
    {
      "value": "string",
      "languageIso": "string",
      "stepId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": {},
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdDate": "2024-06-06T15:30:37.725Z",
      "updatedDate": "2024-06-06T15:30:37.725Z",
      "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "reference": "string",
      "creatorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "customField1": "string",
      "customField2": "string",
      "customField3": "string",
      "customField4": "string",
      "customField5": "string",
      "organization": {}
    }
  ],
  "organization": {}
}

default

error

application/json

Schema

Schema

error

object

required

code stringrequired

message stringrequired

target string

details

object[]

Array [

code stringrequired

message stringrequired

target string

]

innererror object

The structure of this object is service-specific

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      {
        "code": "string",
        "message": "string",
        "target": "string"
      }
    ],
    "innererror": {}
  }
}

Loading...