POST /api/tickets/{TicketID}/actions

Executes an action on the specified ticket.

Authorization Roles/Permissions: The user must be logged in, and must be an admin for the resource the ticket relates to.

This topic includes the following sections:

HTTP Method

POST

Back to top

URL

https://{hostname}/api/tickets/{TicketID}/actions

Back to top

Sample Request

The example below shows a request message resolving a ticket.

Request URL

https://{hostname}/api/tickets/ticket25687.acmepaymentscorp/actions

Sample request headers

POST /api/tickets/ticket25687.acmepaymentscorp/actions HTTP/1.1
Host: {hostname}
Accept: */*
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

{
  "ActionName":"ticket.action.resolve",
  "Comments":"Bug is fixed. Resolving this ticket."
}

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
Content-Type

Any one of the following media types is valid for the request Content-Type:

application/json or application/xml

application/vnd.soa.v71+json or application/vnd.soa.v71+xml

application/vnd.soa.v72+json or application/vnd.soa.v72+xml

application/vnd.soa.v80+json or application/vnd.soa.v80+xml

application/vnd.soa.v81+json or application/vnd.soa.v81+xml

X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
TicketID Path string Required The unique ID for a specific ticket.
Action Body Action Required

Contains information about an action performed on a resource as part of a workflow-related activity.

For information on possible values for workflow actions relating to Tickets, see Tickets: Valid Workflow Actions. ActionName is required.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the updated ticket state value in the response.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Content-Type: text/plain
Date: Tue, 16 Jul 2013 20:42:52 GMT

Sample response body

RESOLVED

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type text/plain

Back to top

Response Body

Name Type Description
Response string The updated value for the ticket's state.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics