POST api/Lookup/GetAvailableWorkflowSteps

Get a list of available workflow steps for an activity

Request Information

URI Parameters

None.

Body Parameters

specify activity

ActivityIdArgumentModel
NameDescriptionTypeAdditional information
CombinedActivityId

Get or set combined activity id

 string

None.
FormName

Gets or sets the optional FormName. The FormName is used to limit the number of fields returned from GetActivity.

 string

None.
TicketId

Gets or sets the ticket id

 string

None.
Culture

Gets or sets culture, if not specified we will use culture set on user.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "CombinedActivityId": "sample string 1",
  "FormName": "sample string 2",
  "TicketId": "sample string 3",
  "Culture": "sample string 4"
}

application/xml, text/xml

Sample: 
<ActivityIdArgumentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rostov.Models">
  <Culture>sample string 4</Culture>
  <TicketId>sample string 3</TicketId>
  <CombinedActivityId>sample string 1</CombinedActivityId>
  <FormName>sample string 2</FormName>
</ActivityIdArgumentModel>

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

Response Information

Resource Description

AvailableWorkflowStepsReturnModel
NameDescriptionTypeAdditional information
Items

Gets or sets the list of available steps

 Collection of WorkflowStepDefinition

None.
CombinedPerformanceId

Gets or sets the performance id. If performance monitoring is not turned on this property will not be present or set to null

 string

Json null value handling: Ignore

Response Formats

application/json, text/json

Sample: 
{
  "Items": [
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "EarliestPossibleStartTime": "2026-11-11T19:51:38.8718417+01:00",
      "MinumumRequisitionZone": 1,
      "CostLinesMustBeCompleted": true,
      "RequisitionLinesMustBeRegisteredAsCostlines": true,
      "IsAssignedGroupRequired": true,
      "IsAssignedResourceRequired": true,
      "IsDefault": true,
      "TemplateFields": [
        {
          "AttributeName": "sample string 1",
          "AttributeAction": 0,
          "AttributeType": 0,
          "AttributeTransaction": "sample string 2",
          "AttributeData": {}
        },
        {
          "AttributeName": "sample string 1",
          "AttributeAction": 0,
          "AttributeType": 0,
          "AttributeTransaction": "sample string 2",
          "AttributeData": {}
        }
      ],
      "SchedulesMustBeSet": true
    },
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "EarliestPossibleStartTime": "2026-11-11T19:51:38.8718417+01:00",
      "MinumumRequisitionZone": 1,
      "CostLinesMustBeCompleted": true,
      "RequisitionLinesMustBeRegisteredAsCostlines": true,
      "IsAssignedGroupRequired": true,
      "IsAssignedResourceRequired": true,
      "IsDefault": true,
      "TemplateFields": [
        {
          "AttributeName": "sample string 1",
          "AttributeAction": 0,
          "AttributeType": 0,
          "AttributeTransaction": "sample string 2",
          "AttributeData": {}
        },
        {
          "AttributeName": "sample string 1",
          "AttributeAction": 0,
          "AttributeType": 0,
          "AttributeTransaction": "sample string 2",
          "AttributeData": {}
        }
      ],
      "SchedulesMustBeSet": true
    }
  ],
  "CombinedPerformanceId": "sample string 1"
}

application/xml, text/xml

Sample: 
<LookupController.AvailableWorkflowStepsReturnModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rostov.Controllers">
  <CombinedPerformanceId xmlns="http://schemas.datacontract.org/2004/07/Rostov.Models">sample string 1</CombinedPerformanceId>
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Rostov.Models">
    <d2p1:WorkflowStepDefinition>
      <d2p1:CostLinesMustBeCompleted>true</d2p1:CostLinesMustBeCompleted>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:EarliestPossibleStartTime>2026-11-11T19:51:38.8718417+01:00</d2p1:EarliestPossibleStartTime>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:IsAssignedGroupRequired>true</d2p1:IsAssignedGroupRequired>
      <d2p1:IsAssignedResourceRequired>true</d2p1:IsAssignedResourceRequired>
      <d2p1:IsDefault>true</d2p1:IsDefault>
      <d2p1:MinumumRequisitionZone>1</d2p1:MinumumRequisitionZone>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:RequisitionLinesMustBeRegisteredAsCostlines>true</d2p1:RequisitionLinesMustBeRegisteredAsCostlines>
      <d2p1:SchedulesMustBeSet>true</d2p1:SchedulesMustBeSet>
      <d2p1:TemplateFields>
        <d2p1:AttributeUpdateModel>
          <d2p1:AttributeAction>Add</d2p1:AttributeAction>
          <d2p1:AttributeData />
          <d2p1:AttributeName>sample string 1</d2p1:AttributeName>
          <d2p1:AttributeTransaction>sample string 2</d2p1:AttributeTransaction>
          <d2p1:AttributeType>Field</d2p1:AttributeType>
        </d2p1:AttributeUpdateModel>
        <d2p1:AttributeUpdateModel>
          <d2p1:AttributeAction>Add</d2p1:AttributeAction>
          <d2p1:AttributeData />
          <d2p1:AttributeName>sample string 1</d2p1:AttributeName>
          <d2p1:AttributeTransaction>sample string 2</d2p1:AttributeTransaction>
          <d2p1:AttributeType>Field</d2p1:AttributeType>
        </d2p1:AttributeUpdateModel>
      </d2p1:TemplateFields>
    </d2p1:WorkflowStepDefinition>
    <d2p1:WorkflowStepDefinition>
      <d2p1:CostLinesMustBeCompleted>true</d2p1:CostLinesMustBeCompleted>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:EarliestPossibleStartTime>2026-11-11T19:51:38.8718417+01:00</d2p1:EarliestPossibleStartTime>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:IsAssignedGroupRequired>true</d2p1:IsAssignedGroupRequired>
      <d2p1:IsAssignedResourceRequired>true</d2p1:IsAssignedResourceRequired>
      <d2p1:IsDefault>true</d2p1:IsDefault>
      <d2p1:MinumumRequisitionZone>1</d2p1:MinumumRequisitionZone>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:RequisitionLinesMustBeRegisteredAsCostlines>true</d2p1:RequisitionLinesMustBeRegisteredAsCostlines>
      <d2p1:SchedulesMustBeSet>true</d2p1:SchedulesMustBeSet>
      <d2p1:TemplateFields>
        <d2p1:AttributeUpdateModel>
          <d2p1:AttributeAction>Add</d2p1:AttributeAction>
          <d2p1:AttributeData />
          <d2p1:AttributeName>sample string 1</d2p1:AttributeName>
          <d2p1:AttributeTransaction>sample string 2</d2p1:AttributeTransaction>
          <d2p1:AttributeType>Field</d2p1:AttributeType>
        </d2p1:AttributeUpdateModel>
        <d2p1:AttributeUpdateModel>
          <d2p1:AttributeAction>Add</d2p1:AttributeAction>
          <d2p1:AttributeData />
          <d2p1:AttributeName>sample string 1</d2p1:AttributeName>
          <d2p1:AttributeTransaction>sample string 2</d2p1:AttributeTransaction>
          <d2p1:AttributeType>Field</d2p1:AttributeType>
        </d2p1:AttributeUpdateModel>
      </d2p1:TemplateFields>
    </d2p1:WorkflowStepDefinition>
  </Items>
</LookupController.AvailableWorkflowStepsReturnModel>