GET /api/tickets/{TicketID}

Returns information about a specific ticket.

Authorization Roles/Permissions: Must be logged in and have permission to view the requested resources. If the user is logged in but doesn't have permission to view certain resources, the operation works, but limited (or empty) results are returned.

This topic includes the following sections:

HTTP Method

GET

URL

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

Sample Request

The example below shows a request for information about the specified ticket.

Sample Request URL

https://{hostname}/api/tickets/132f7a34-b71f-448f-9a49-6e8777de2b4c.acmepaymentscorp

Sample request headers

Accept: application/json

Sample request body

Not applicable.

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

Response

If successful, this operation returns HTTP status code 200, with information about the specified ticket.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Date: Thu, 11 May 2017 15:37:09 GMT

Sample response body: application/json

{
  "TicketID" : "132f7a34-b71f-448f-9a49-6e8777de2b4c.acmepaymentscorp",
  "APIID" : "177f24e1-513f-4239-b20b-3d06d85bd15b.acmepaymentscorp",
  "Title" : "Bug when using multiple payment types",
  "Description" : "When I try to use more than one payment type the transaction hangs up. It's happened to me **twice**.\n![thumbsdown.jpg](thumbsdown.jpg \"thumbsdown.jpg\")\n",
  "Environment" : "Production",
  "State" : "OPEN",
  "UserID" : "3a5aca42-498a-4341-a204-0694684fc05b.acmepaymentscorp",
  "UserName" : "adminacmepaymentscorp",
  "Created" : "2017-05-11T15:18:22Z",
  "Label" : [ "com.soa.ticket.label.priority.high" ],
  "Tag" : [ ],
  "Comments" : 0,
  "Marks" : 0,
  "Visibility" : "Public",
  "PubDate" : "2017-05-11T15:18:22Z",
  "Image" : {
    "Url" : "http://testing-acmepaymentscorp/api/users/avatar/_VSHJa4F1wLk54xM7MQkJIaA",
    "Link" : "../atmosphere#/user/3a5aca42-498a-4341-a204-0694684fc05b.acmepaymentscorp/details"
  },
  "Published" : true,
  "DescriptionMediaType" : "text/markdown",
  "BoardItemArtifacts" : {
    "BoardItemArtifact" : [ {
      "ContextID" : "132f7a34-b71f-448f-9a49-6e8777de2b4c.acmepaymentscorp",
      "FileName" : "thumbsdown.jpg",
      "BaseUri" : "http://testing-acmepaymentscorp",
      "UriPath" : "/api/boards/items/132f7a34-b71f-448f-9a49-6e8777de2b4c.acmepaymentscorp/artifacts/thumbsdown.jpg"
    } ]
  }
}

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
Ticket	Ticket	Includes information about a ticket.

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
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics