POST api/Steps

Creates a step.

Request Information

URI Parameters

None.

Body Parameters

The step model to create with.

StepDto
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Name

string

Required

String length: inclusive between 0 and 250

Description

string

None.

CreationDate

date

Required

ProductId

globally unique identifier

Required

SortIndex

integer

None.

Conditionals

Collection of ConditionalDto

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "fc66f97b-bf3c-4ddf-a656-4fa13ed608f3",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "CreationDate": "2025-12-11T17:27:22.2054906Z",
  "ProductId": "ab95d365-cac0-46de-8c3f-4d15ce6bc92b",
  "SortIndex": 1,
  "Conditionals": [
    {
      "Id": "ce3db2f3-565a-4a4f-9b25-4c547d5e8c56",
      "SourceVariableId": "357947f7-ee15-45eb-911c-f7aefadb89b9",
      "Operator": 0,
      "Value": "sample string 3",
      "StepId": "b21b0436-ede3-42cc-b8a8-5972843244a5",
      "VariableId": "fe026be5-ca6c-4c0d-bee9-9b3d3ba81968",
      "OptionId": "c8bc592f-1987-463d-bbec-38699a4528db"
    },
    {
      "Id": "ce3db2f3-565a-4a4f-9b25-4c547d5e8c56",
      "SourceVariableId": "357947f7-ee15-45eb-911c-f7aefadb89b9",
      "Operator": 0,
      "Value": "sample string 3",
      "StepId": "b21b0436-ede3-42cc-b8a8-5972843244a5",
      "VariableId": "fe026be5-ca6c-4c0d-bee9-9b3d3ba81968",
      "OptionId": "c8bc592f-1987-463d-bbec-38699a4528db"
    }
  ]
}

application/xml, text/xml

Sample:
<StepDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Template.Models">
  <Conditionals>
    <ConditionalDto>
      <Id>ce3db2f3-565a-4a4f-9b25-4c547d5e8c56</Id>
      <Operator>Equals</Operator>
      <OptionId>c8bc592f-1987-463d-bbec-38699a4528db</OptionId>
      <SourceVariableId>357947f7-ee15-45eb-911c-f7aefadb89b9</SourceVariableId>
      <StepId>b21b0436-ede3-42cc-b8a8-5972843244a5</StepId>
      <Value>sample string 3</Value>
      <VariableId>fe026be5-ca6c-4c0d-bee9-9b3d3ba81968</VariableId>
    </ConditionalDto>
    <ConditionalDto>
      <Id>ce3db2f3-565a-4a4f-9b25-4c547d5e8c56</Id>
      <Operator>Equals</Operator>
      <OptionId>c8bc592f-1987-463d-bbec-38699a4528db</OptionId>
      <SourceVariableId>357947f7-ee15-45eb-911c-f7aefadb89b9</SourceVariableId>
      <StepId>b21b0436-ede3-42cc-b8a8-5972843244a5</StepId>
      <Value>sample string 3</Value>
      <VariableId>fe026be5-ca6c-4c0d-bee9-9b3d3ba81968</VariableId>
    </ConditionalDto>
  </Conditionals>
  <CreationDate>2025-12-11T17:27:22.2054906+00:00</CreationDate>
  <Description>sample string 3</Description>
  <Id>fc66f97b-bf3c-4ddf-a656-4fa13ed608f3</Id>
  <Name>sample string 2</Name>
  <ProductId>ab95d365-cac0-46de-8c3f-4d15ce6bc92b</ProductId>
  <SortIndex>1</SortIndex>
</StepDto>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'StepDto'.

Response Information

Resource Description

globally unique identifier

Response Formats

application/json, text/json

Sample:
"dfdcf494-4498-4964-af11-d6ef95569ec6"

application/xml, text/xml

Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">dfdcf494-4498-4964-af11-d6ef95569ec6</guid>