POST api/WorkflowDefinitions

Creates a workflow definition.

Request Information

URI Parameters

None.

Body Parameters

The workflow definition model to create with.

Name	Type	Additional information
Id	globally unique identifier	None.
CreationDate	date	None.
DeletedDate	date	None.
Description	string	None.
Name	string	Required String length: inclusive between 0 and 250
PublishDate	date	None.
TenantId	globally unique identifier	None.
WorkflowDefinitionCode	globally unique identifier	None.
Version	string	String length: inclusive between 0 and 50
WfdPath	string	String length: inclusive between 0 and 500
XsdPath	string	String length: inclusive between 0 and 500
InputModuleName	string	String length: inclusive between 0 and 50
OutputModuleName	string	String length: inclusive between 0 and 50
CommandParameters	string	String length: inclusive between 0 and 500
XsdFileData	Collection of byte	None.
WfdFileData	Collection of byte	None.
Fonts	Collection of FontDto	None.
SchemaId	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "d3bb91e6-58f5-4857-803d-98c9e2332355",
  "CreationDate": "2026-01-11T17:52:33.9427061Z",
  "DeletedDate": "2026-01-11T17:52:33.9427061Z",
  "Description": "sample string 3",
  "Name": "sample string 4",
  "PublishDate": "2026-01-11T17:52:33.9427948Z",
  "TenantId": "01679e89-6ea7-41ea-a652-d08f062f6a90",
  "WorkflowDefinitionCode": "01349976-df1d-47c1-b8d1-19083c6649ea",
  "Version": "sample string 7",
  "WfdPath": "sample string 8",
  "XsdPath": "sample string 9",
  "InputModuleName": "sample string 10",
  "OutputModuleName": "sample string 11",
  "CommandParameters": "sample string 12",
  "XsdFileData": "QEA=",
  "WfdFileData": "QEA=",
  "Fonts": [
    {
      "Id": "416efdc1-9be4-4d63-b6c7-e04c85751141",
      "Name": "sample string 2",
      "CreationDate": "2026-01-11T17:52:33.9427948Z"
    },
    {
      "Id": "416efdc1-9be4-4d63-b6c7-e04c85751141",
      "Name": "sample string 2",
      "CreationDate": "2026-01-11T17:52:33.9427948Z"
    }
  ],
  "SchemaId": "7c4d8a8e-3337-43c2-a350-b0db8ce32604"
}

application/xml, text/xml

Sample:

<WorkflowDefinitionDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Template.Models">
  <CommandParameters>sample string 12</CommandParameters>
  <CreationDate>2026-01-11T17:52:33.9427061+00:00</CreationDate>
  <DeletedDate>2026-01-11T17:52:33.9427061+00:00</DeletedDate>
  <Description>sample string 3</Description>
  <Fonts>
    <FontDto>
      <CreationDate>2026-01-11T17:52:33.9427948+00:00</CreationDate>
      <Id>416efdc1-9be4-4d63-b6c7-e04c85751141</Id>
      <Name>sample string 2</Name>
    </FontDto>
    <FontDto>
      <CreationDate>2026-01-11T17:52:33.9427948+00:00</CreationDate>
      <Id>416efdc1-9be4-4d63-b6c7-e04c85751141</Id>
      <Name>sample string 2</Name>
    </FontDto>
  </Fonts>
  <Id>d3bb91e6-58f5-4857-803d-98c9e2332355</Id>
  <InputModuleName>sample string 10</InputModuleName>
  <Name>sample string 4</Name>
  <OutputModuleName>sample string 11</OutputModuleName>
  <PublishDate>2026-01-11T17:52:33.9427948+00:00</PublishDate>
  <SchemaId>7c4d8a8e-3337-43c2-a350-b0db8ce32604</SchemaId>
  <TenantId>01679e89-6ea7-41ea-a652-d08f062f6a90</TenantId>
  <Version>sample string 7</Version>
  <WfdFileData>QEA=</WfdFileData>
  <WfdPath>sample string 8</WfdPath>
  <WorkflowDefinitionCode>01349976-df1d-47c1-b8d1-19083c6649ea</WorkflowDefinitionCode>
  <XsdFileData>QEA=</XsdFileData>
  <XsdPath>sample string 9</XsdPath>
</WorkflowDefinitionDto>

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

Response Information

Resource Description

globally unique identifier

Response Formats

application/json, text/json

Sample:

"6fca8507-2b7a-45a9-9a0b-48e223a224f3"

application/xml, text/xml

Sample:

<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">6fca8507-2b7a-45a9-9a0b-48e223a224f3</guid>