GET api/Tickets/GetWorkflowParameters?ticketREF={ticketREF}&ticketAction={ticketAction}

Gets available options for the Ticket Action. It returns available operators or services. If both of these collection are null, there is no need to select (post to WorkflowPush method) anything. This situation (calling this method unnecessarily) should be prevented by respecting flag ExtraParameterIsNeeded from AllAvailableTicketActions when GetTicket() is called.

Request Information

URI Parameters

Name	Description	Type	Additional information
ticketREF	Required TicketREF	string	Required
ticketAction		TicketActionEnum	Required

Body Parameters

None.

Response Information

Resource Description

GetWorkflowPushParametersResult

Name	Description	Type	Additional information
Users	Users are filled when there is neccessary to select (post to WorkflowPush method) one. For example if the ticket has to be assigned to some operator.	Collection of UserItem	None.
Services	Services are filled when there is neccessary to select (post to WorkflowPush method) one. For example if the operator intends to convert end-user ticket to incident or service request.	Collection of ServiceItem	None.

Response Formats

application/json, text/json

Sample:

{
  "Users": [
    {
      "UserProviderKey": "8fdfc703-b9d5-401a-a546-290a8e2d847b",
      "Fullname": "Mr. Operator",
      "UserName": "operator1"
    }
  ],
  "Services": null
}

application/xml, text/xml

Sample:

<GetWorkflowPushParametersResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <Services i:nil="true" />
  <Users>
    <GetWorkflowPushParametersResult.UserItem>
      <Fullname>Mr. Operator</Fullname>
      <UserName>operator1</UserName>
      <UserProviderKey>8fdfc703-b9d5-401a-a546-290a8e2d847b</UserProviderKey>
    </GetWorkflowPushParametersResult.UserItem>
  </Users>
</GetWorkflowPushParametersResult>