POST api/Tickets/WorkflowPush

Pushes forward Ticket's state.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
TicketId	(Required TicketId OR TicketREF) The ID of the ticket	integer	None.
TicketREF	(Required TicketId OR TicketREF) The reference ID of the ticket	string	None.
Action	(Required) Right workflow action for the Ticket's state is needed. Get a list of available actions using GetTicket method.	TicketActionEnum	None.
UserProviderKey	Optional parameter. Only some Actions need to specify this parameter. These are IncidentAssign, IncidentAssignOther, IncidentFunctionEscalate, ServiceRequestAssign, ServiceRequestAssignOther, ProblemAssign and ChangeAssign.	string	None.
ServiceId	Optional parametr. Only some Actions need to specify this parameter. There are TicketConvertToIncident, TicketConvertToServiceRequest.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "TicketId": null,
  "TicketREF": "INC-000047",
  "Action": 207,
  "UserProviderKey": null,
  "ServiceId": null
}

application/xml, text/xml

Sample:

<WorkflowPushPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Posts">
  <Action>IncidentSuspend</Action>
  <ServiceId i:nil="true" />
  <TicketId i:nil="true" />
  <TicketREF>INC-000047</TicketREF>
  <UserProviderKey i:nil="true" />
</WorkflowPushPost>

Response Information

Resource Description

HttpStatusCode 200 OK or 400 BadRequest with Message.

WorkflowPushResult

Name	Description	Type	Additional information
TicketREF	Reference ID of the Ticket. Useful if the Ticket has been converted.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "TicketREF": "INC-000015"
}

application/xml, text/xml

Sample:

<WorkflowPushResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <TicketREF>INC-000015</TicketREF>
</WorkflowPushResult>