POST api/Variables

Creates a variable.

Request Information

URI Parameters

None.

Body Parameters

The variable model to create with.

Name	Type	Additional information
Id	globally unique identifier	None.
Name	string	Required String length: inclusive between 0 and 250
Description	string	None.
ComplianceNumber	string	None.
ExpiryDate	date	None.
CreationDate	date	None.
DataType	TemplateVariableDtoDataType	None.
DefaultValue	string	None.
IsRequired	boolean	None.
MinimumValueExpression	string	String length: inclusive between 0 and 50
MaximumValueExpression	string	String length: inclusive between 0 and 50
GetFromProfile	boolean	None.
ProfileField	string	None.
GetFromProfileAddress	boolean	None.
AddressEditOption	TemplateVariableAddressEditOptionDto	None.
EditState	TemplateVariableEditStateDto	None.
Options	Collection of TemplateVariableOptionDto	None.
TemplateId	globally unique identifier	Required
SortIndex	integer	None.
StepId	globally unique identifier	None.
EditorTypeId	globally unique identifier	None.
EditorType	EditorTypeDto	None.
FolderId	globally unique identifier	None.
Conditionals	Collection of ConditionalDto	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "c9c0de67-297e-4065-9df4-5470b0d17b46",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "ComplianceNumber": "sample string 4",
  "ExpiryDate": "2025-12-11T17:26:30.2840348Z",
  "CreationDate": "2025-12-11T17:26:30.2840348Z",
  "DataType": 0,
  "DefaultValue": "sample string 6",
  "IsRequired": true,
  "MinimumValueExpression": "sample string 8",
  "MaximumValueExpression": "sample string 9",
  "GetFromProfile": true,
  "ProfileField": "sample string 11",
  "GetFromProfileAddress": true,
  "AddressEditOption": 0,
  "EditState": 0,
  "Options": [
    {
      "Id": "9e7f0cab-f688-498f-b18b-81a8b510ffcd",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "PictureUrl": "sample string 4",
      "CreationDate": "2025-12-11T17:26:30.2840348Z",
      "VariableId": "3008ad0b-d0b3-439a-9fb9-1f544734a98e",
      "Conditionals": [
        {
          "Id": "0e579f4d-8d1a-41ef-bec7-82db0b39bbff",
          "SourceVariableId": "56d5704e-51ed-4c35-bb2b-9c43ce7e5ef6",
          "Operator": 0,
          "Value": "sample string 3",
          "StepId": "3bed9f6b-ab75-40ae-8853-ba0058342f5f",
          "VariableId": "1babec04-7995-41bc-9126-7efb53119e0a",
          "OptionId": "f829d7a3-6988-4f77-8128-327ad8a0a1ab"
        },
        {
          "Id": "0e579f4d-8d1a-41ef-bec7-82db0b39bbff",
          "SourceVariableId": "56d5704e-51ed-4c35-bb2b-9c43ce7e5ef6",
          "Operator": 0,
          "Value": "sample string 3",
          "StepId": "3bed9f6b-ab75-40ae-8853-ba0058342f5f",
          "VariableId": "1babec04-7995-41bc-9126-7efb53119e0a",
          "OptionId": "f829d7a3-6988-4f77-8128-327ad8a0a1ab"
        }
      ],
      "SortIndex": 7,
      "EnableCompliance": true,
      "ComplianceReference": "sample string 9",
      "ExpiryDate": "2025-12-11T17:26:30.2840348Z"
    },
    {
      "Id": "9e7f0cab-f688-498f-b18b-81a8b510ffcd",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "PictureUrl": "sample string 4",
      "CreationDate": "2025-12-11T17:26:30.2840348Z",
      "VariableId": "3008ad0b-d0b3-439a-9fb9-1f544734a98e",
      "Conditionals": [
        {
          "Id": "0e579f4d-8d1a-41ef-bec7-82db0b39bbff",
          "SourceVariableId": "56d5704e-51ed-4c35-bb2b-9c43ce7e5ef6",
          "Operator": 0,
          "Value": "sample string 3",
          "StepId": "3bed9f6b-ab75-40ae-8853-ba0058342f5f",
          "VariableId": "1babec04-7995-41bc-9126-7efb53119e0a",
          "OptionId": "f829d7a3-6988-4f77-8128-327ad8a0a1ab"
        },
        {
          "Id": "0e579f4d-8d1a-41ef-bec7-82db0b39bbff",
          "SourceVariableId": "56d5704e-51ed-4c35-bb2b-9c43ce7e5ef6",
          "Operator": 0,
          "Value": "sample string 3",
          "StepId": "3bed9f6b-ab75-40ae-8853-ba0058342f5f",
          "VariableId": "1babec04-7995-41bc-9126-7efb53119e0a",
          "OptionId": "f829d7a3-6988-4f77-8128-327ad8a0a1ab"
        }
      ],
      "SortIndex": 7,
      "EnableCompliance": true,
      "ComplianceReference": "sample string 9",
      "ExpiryDate": "2025-12-11T17:26:30.2840348Z"
    }
  ],
  "TemplateId": "52744b39-7322-4a9b-9569-a1bb818fb866",
  "SortIndex": 14,
  "StepId": "139ed619-97a3-4118-afc5-8806e2a9ed0b",
  "EditorTypeId": "fd66bf1e-70e7-4abd-b335-c01b02bdc54a",
  "EditorType": {
    "Id": "abf97932-9ee8-41f4-9789-7f9393c09bcb",
    "Name": "sample string 2",
    "CreationDate": "2025-12-11T17:26:30.2840348Z",
    "DataType": 0
  },
  "FolderId": "d850e8af-e78f-4025-afe5-ea31c61b82f7",
  "Conditionals": [
    {
      "Id": "0e579f4d-8d1a-41ef-bec7-82db0b39bbff",
      "SourceVariableId": "56d5704e-51ed-4c35-bb2b-9c43ce7e5ef6",
      "Operator": 0,
      "Value": "sample string 3",
      "StepId": "3bed9f6b-ab75-40ae-8853-ba0058342f5f",
      "VariableId": "1babec04-7995-41bc-9126-7efb53119e0a",
      "OptionId": "f829d7a3-6988-4f77-8128-327ad8a0a1ab"
    },
    {
      "Id": "0e579f4d-8d1a-41ef-bec7-82db0b39bbff",
      "SourceVariableId": "56d5704e-51ed-4c35-bb2b-9c43ce7e5ef6",
      "Operator": 0,
      "Value": "sample string 3",
      "StepId": "3bed9f6b-ab75-40ae-8853-ba0058342f5f",
      "VariableId": "1babec04-7995-41bc-9126-7efb53119e0a",
      "OptionId": "f829d7a3-6988-4f77-8128-327ad8a0a1ab"
    }
  ]
}

application/xml, text/xml

Sample:

<VariableDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Template.Models">
  <AddressEditOption>Default</AddressEditOption>
  <ComplianceNumber>sample string 4</ComplianceNumber>
  <Conditionals>
    <ConditionalDto>
      <Id>0e579f4d-8d1a-41ef-bec7-82db0b39bbff</Id>
      <Operator>Equals</Operator>
      <OptionId>f829d7a3-6988-4f77-8128-327ad8a0a1ab</OptionId>
      <SourceVariableId>56d5704e-51ed-4c35-bb2b-9c43ce7e5ef6</SourceVariableId>
      <StepId>3bed9f6b-ab75-40ae-8853-ba0058342f5f</StepId>
      <Value>sample string 3</Value>
      <VariableId>1babec04-7995-41bc-9126-7efb53119e0a</VariableId>
    </ConditionalDto>
    <ConditionalDto>
      <Id>0e579f4d-8d1a-41ef-bec7-82db0b39bbff</Id>
      <Operator>Equals</Operator>
      <OptionId>f829d7a3-6988-4f77-8128-327ad8a0a1ab</OptionId>
      <SourceVariableId>56d5704e-51ed-4c35-bb2b-9c43ce7e5ef6</SourceVariableId>
      <StepId>3bed9f6b-ab75-40ae-8853-ba0058342f5f</StepId>
      <Value>sample string 3</Value>
      <VariableId>1babec04-7995-41bc-9126-7efb53119e0a</VariableId>
    </ConditionalDto>
  </Conditionals>
  <CreationDate>2025-12-11T17:26:30.2840348+00:00</CreationDate>
  <DataType>Bool</DataType>
  <DefaultValue>sample string 6</DefaultValue>
  <Description>sample string 3</Description>
  <EditState>Editable</EditState>
  <EditorType>
    <CreationDate>2025-12-11T17:26:30.2840348+00:00</CreationDate>
    <DataType>Bool</DataType>
    <Id>abf97932-9ee8-41f4-9789-7f9393c09bcb</Id>
    <Name>sample string 2</Name>
  </EditorType>
  <EditorTypeId>fd66bf1e-70e7-4abd-b335-c01b02bdc54a</EditorTypeId>
  <ExpiryDate>2025-12-11T17:26:30.2840348+00:00</ExpiryDate>
  <FolderId>d850e8af-e78f-4025-afe5-ea31c61b82f7</FolderId>
  <GetFromProfile>true</GetFromProfile>
  <GetFromProfileAddress>true</GetFromProfileAddress>
  <Id>c9c0de67-297e-4065-9df4-5470b0d17b46</Id>
  <IsRequired>true</IsRequired>
  <MaximumValueExpression>sample string 9</MaximumValueExpression>
  <MinimumValueExpression>sample string 8</MinimumValueExpression>
  <Name>sample string 2</Name>
  <Options>
    <TemplateVariableOptionDto>
      <ComplianceReference>sample string 9</ComplianceReference>
      <Conditionals>
        <ConditionalDto>
          <Id>0e579f4d-8d1a-41ef-bec7-82db0b39bbff</Id>
          <Operator>Equals</Operator>
          <OptionId>f829d7a3-6988-4f77-8128-327ad8a0a1ab</OptionId>
          <SourceVariableId>56d5704e-51ed-4c35-bb2b-9c43ce7e5ef6</SourceVariableId>
          <StepId>3bed9f6b-ab75-40ae-8853-ba0058342f5f</StepId>
          <Value>sample string 3</Value>
          <VariableId>1babec04-7995-41bc-9126-7efb53119e0a</VariableId>
        </ConditionalDto>
        <ConditionalDto>
          <Id>0e579f4d-8d1a-41ef-bec7-82db0b39bbff</Id>
          <Operator>Equals</Operator>
          <OptionId>f829d7a3-6988-4f77-8128-327ad8a0a1ab</OptionId>
          <SourceVariableId>56d5704e-51ed-4c35-bb2b-9c43ce7e5ef6</SourceVariableId>
          <StepId>3bed9f6b-ab75-40ae-8853-ba0058342f5f</StepId>
          <Value>sample string 3</Value>
          <VariableId>1babec04-7995-41bc-9126-7efb53119e0a</VariableId>
        </ConditionalDto>
      </Conditionals>
      <CreationDate>2025-12-11T17:26:30.2840348+00:00</CreationDate>
      <EnableCompliance>true</EnableCompliance>
      <ExpiryDate>2025-12-11T17:26:30.2840348+00:00</ExpiryDate>
      <Id>9e7f0cab-f688-498f-b18b-81a8b510ffcd</Id>
      <Name>sample string 2</Name>
      <PictureUrl>sample string 4</PictureUrl>
      <SortIndex>7</SortIndex>
      <Value>sample string 3</Value>
      <VariableId>3008ad0b-d0b3-439a-9fb9-1f544734a98e</VariableId>
    </TemplateVariableOptionDto>
    <TemplateVariableOptionDto>
      <ComplianceReference>sample string 9</ComplianceReference>
      <Conditionals>
        <ConditionalDto>
          <Id>0e579f4d-8d1a-41ef-bec7-82db0b39bbff</Id>
          <Operator>Equals</Operator>
          <OptionId>f829d7a3-6988-4f77-8128-327ad8a0a1ab</OptionId>
          <SourceVariableId>56d5704e-51ed-4c35-bb2b-9c43ce7e5ef6</SourceVariableId>
          <StepId>3bed9f6b-ab75-40ae-8853-ba0058342f5f</StepId>
          <Value>sample string 3</Value>
          <VariableId>1babec04-7995-41bc-9126-7efb53119e0a</VariableId>
        </ConditionalDto>
        <ConditionalDto>
          <Id>0e579f4d-8d1a-41ef-bec7-82db0b39bbff</Id>
          <Operator>Equals</Operator>
          <OptionId>f829d7a3-6988-4f77-8128-327ad8a0a1ab</OptionId>
          <SourceVariableId>56d5704e-51ed-4c35-bb2b-9c43ce7e5ef6</SourceVariableId>
          <StepId>3bed9f6b-ab75-40ae-8853-ba0058342f5f</StepId>
          <Value>sample string 3</Value>
          <VariableId>1babec04-7995-41bc-9126-7efb53119e0a</VariableId>
        </ConditionalDto>
      </Conditionals>
      <CreationDate>2025-12-11T17:26:30.2840348+00:00</CreationDate>
      <EnableCompliance>true</EnableCompliance>
      <ExpiryDate>2025-12-11T17:26:30.2840348+00:00</ExpiryDate>
      <Id>9e7f0cab-f688-498f-b18b-81a8b510ffcd</Id>
      <Name>sample string 2</Name>
      <PictureUrl>sample string 4</PictureUrl>
      <SortIndex>7</SortIndex>
      <Value>sample string 3</Value>
      <VariableId>3008ad0b-d0b3-439a-9fb9-1f544734a98e</VariableId>
    </TemplateVariableOptionDto>
  </Options>
  <ProfileField>sample string 11</ProfileField>
  <SortIndex>14</SortIndex>
  <StepId>139ed619-97a3-4118-afc5-8806e2a9ed0b</StepId>
  <TemplateId>52744b39-7322-4a9b-9569-a1bb818fb866</TemplateId>
</VariableDto>

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 'VariableDto'.

Response Information

Resource Description

None.