POST /api/tickets/{TicketID}/labels

Updates the label associated with a ticket.

Authorization Roles/Permissions: Must be logged in. Must be an admin for the resource the ticket relates to.

This topic includes the following sections:

HTTP Method

POST

URL

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

Sample Request

The example below shows a request to change the ticket label to medium priority, which shows up as a priority of Major in the user interface.

Sample Request URL

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

Sample request headers

POST /api/tickets/ticket25687.acmepaymentscorp/labels HTTP/1.1
Host: {hostname}
Accept: */*
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "comments":"Changing priority from Critical to Major",
  "labels":[
    "com.soa.ticket.label.priority.medium"
  ],
  "userID":"522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp"
}

Request Headers

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

Header	Description
Accept	application/json, application/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml
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
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
TicketID	Path	string	Required	The unique ID for a specific ticket.
TicketLabelChange	Body	TicketLabelChange	Required	Includes information about a change in ticket label indicating the priority of the ticket. Comments, Labels, and UserID are required.

Response

If successful, this operation returns HTTP status code 200, with the updated ticket label.

Sample Response

The sample response below successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Content-Type: application/json
Date: Tue, 16 Jul 2013 19:50:06 GMT

Sample response body

[
  "com.soa.ticket.label.priority.medium" 
]

Response Headers

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

Header	Description
Content-Type	application/json, application/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Response Body

Name	Type	Description
Labels	string[ ]	The updated ticket label information.

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. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics