POST api/Workflows

Request Information

URI Parameters

None.

Body Parameters

Workflow
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Status

string

None.

DefinitionId

globally unique identifier

None.

Name

string

None.

FriendlyUrl

string

None.

ActivatedById

globally unique identifier

None.

ActivatedTime

date

None.

ArchivedById

globally unique identifier

None.

ArchivedTime

date

None.

LastModified

date

None.

IsArchived

boolean

None.

RetrieveDataOnInstantiation

boolean

None.

ShowCancelButton

boolean

None.

CheckApplicationType

boolean

None.

CompleteOnlyOnce

boolean

None.

ApplicableFrom

date

None.

ApplicableTo

date

None.

ExpiryDate

date

None.

Steps

Collection of WorkflowStep

None.

Request Formats

application/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'WorkflowAPI.Models.WorkflowField'. Path 'Steps[0].Fields[0].Fields'.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'WorkflowAPI.Models.WorkflowField'. Path 'Steps[0].Fields[0].Fields'.

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[WorkflowAPI.Models.WorkflowField, WorkflowAPI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[WorkflowAPI.Models.WorkflowField, WorkflowAPI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.