GET /api/tickets

Returns information about tickets.

Authorization Roles/Permissions: Anyone can use this operation; login is not required. However, note that for any operations that do not require login, information about private resources is not returned unless the user is logged in and is authorized to view information about those resources. Without login, only public information is returned. However, the results are restricted according to the user's permissions. When the user is not logged in, only public information is returned.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/tickets

Back to top

Sample Request

The example below shows a request for the first two tickets for a specific API.

Request URL

https://{hostname}/api/tickets?APIID=ecbf7010-abcf-41f8-9f52-1c02b3a51984.acmepaymentscorp&count=2

Sample request headers

Accept: application/vnd.soa.v72+json

Sample request body

Not applicable.

Back to top

Request Headers

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

Header Description
Accept

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

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
APIID Query string Optional The unique ID for a specific API.
AppID Query string Optional The unique ID for a specific app.
RetrievingUserID Query string Optional The ID of the user retrieving the discussion information.
AuthorID Query string Optional The unique ID for the author of a discussion. If this parameter is included, only discussions created by this author are included in the results.
ItemID Query string Optional The unique ID for a specific forum entry.
Tag Query string Optional

A user-defined tag.

If specified, results are limited to tickets relating to that tag. If not specified, no filter is applied.

Label Query string Optional A ticket label indicating a ticket priority. For valid values, see Ticket Label Values.
State Query string Optional The current state of the ticket. For valid values, see Ticket State Values.
IncludeComments Query boolean Optional Indicates whether comments should be included in the information returned. Default: true. If set to false, comments are excluded.
NumberOfComments Query integer Optional The number of comments to be returned (if IncludeComments is not set to false). Default value: 2.
IncludeActions Query boolean Optional Indicates whether workflow actions currently valid for the resource should be included in the results. Default: true. For valid workflow actions, see Workflow Actions.
SortBy Query string Optional An optional parameter allowing users to sort results by a specific value; for example, com.soa.sort.order.updated sorts with the most updated entries first. For valid values, see Sort By Values. If not specified, items are returned in the sort order of DescendingDate, which means that the most recent items are first.
start Query integer Optional An index number indicating the starting point for the results to be returned. If not specified, results start at position 0, the first result.
count Query integer Optional The number of results to be returned, from the specified starting point. If not specified, all matching results are returned.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about tickets.

Back to top

Sample Response

The sample response below returns the first three tickets, for a specified user, as per the sample request.

Sample response headers: application/vnd.soa.v72+json

Status Code: 200 OK
Content-Type: application/vnd.soa.v72+xml
Expires: Tue, 12 May 2015 12:27:20 GMT

Sample response body: application/vnd.soa.v72+json

{
  "Ticket" : [ {
    "TicketID" : "ticket11623.acmepaymentscorp",
    "APIID" : "037a3fad-45ba-4126-aae4-84a9dadae89e.acmepaymentscorp",
    "Title" : "Bug when using multiple payment types",
    "Description" : "When I try to use **more than one payment type** the transaction hangs up.",
    "Environment" : "Production",
    "State" : "OPEN",
    "UserID" : "a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp",
    "Created" : "2015-05-12T17:27:06Z",
    "Label" : [ "com.soa.ticket.label.priority.high" ],
    "Tag" : [ "bug", "payment" ],
    "Comments" : 0,
    "Marks" : 0,
    "IsMarked" : false,
    "Visibility" : "Limited",
    "PubDate" : "2015-05-12T17:27:06Z",
    "Action" : [ {
      "value" : "discussion.action.delete",
      "label" : "discussion.action.delete"
    } ],
    "TargetResources" : {
      "TargetResource" : [ {
        "Name" : "ACME Payments API",
        "ID" : "b28f3b3b-4c54-4ccf-a4db-55abc7a467f0.acmepaymentscorp",
        "Type" : "api"
      }, {
        "Name" : "1.0",
        "ID" : "037a3fad-45ba-4126-aae4-84a9dadae89e.acmepaymentscorp",
        "Type" : "apiversion"
      } ]
    },
    "Image" : {
      "Url" : "http://{hostname}/api/users/a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp/avatar",
      "Link" : "../acmepaymentscorp#/user/a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp/details"
    },
    "CommentsPreview" : {
      "Count" : 0,
      "Comment" : [ ]
    },
    "Link" : "../acmepaymentscorp#/forum/discussions/ticket11623.acmepaymentscorp/details",
    "AuthoringUser" : {
      "UserID" : "a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp",
      "Name" : "adminAcmepaymentscorp",
      "Image" : {
        "Url" : "http://{hostname}/api/users/a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp/avatar",
        "Title" : "adminAcmepaymentscorp",
        "Link" : "#/users/a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp/details"
      }
    },
    "DescriptionMediaType" : "text/markdown",
    "BoardItemArtifacts" : {
      "BoardItemArtifact" : [ ]
    }
  }, {
    "TicketID" : "ticket11622.acmepaymentscorp",
    "APIID" : "037a3fad-45ba-4126-aae4-84a9dadae89e.acmepaymentscorp",
    "Title" : "Cannot log in after timeout",
    "Description" : "After a timeout, users cannot log back in. Password reset is the only way I've been able to figure to get a user back in.",
    "Environment" : "Production",
    "State" : "OPEN",
    "UserID" : "a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp",
    "Created" : "2015-05-12T17:06:08Z",
    "Label" : [ "com.soa.ticket.label.priority.high" ],
    "Tag" : [ "login", "timeout" ],
    "Comments" : 0,
    "Marks" : 0,
    "IsMarked" : false,
    "Visibility" : "Limited",
    "PubDate" : "2015-05-12T17:06:08Z",
    "Action" : [ {
      "value" : "discussion.action.delete",
      "label" : "discussion.action.delete"
    } ],
    "TargetResources" : {
      "TargetResource" : [ {
        "Name" : "ACME Payments API",
        "ID" : "b28f3b3b-4c54-4ccf-a4db-55abc7a467f0.acmepaymentscorp",
        "Type" : "api"
      }, {
        "Name" : "1.0",
        "ID" : "037a3fad-45ba-4126-aae4-84a9dadae89e.acmepaymentscorp",
        "Type" : "apiversion"
      } ]
    },
    "Image" : {
      "Url" : "http://{hostname}/api/users/a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp/avatar",
      "Link" : "../acmepaymentscorp#/user/a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp/details"
    },
    "CommentsPreview" : {
      "Count" : 0,
      "Comment" : [ ]
    },
    "Link" : "../acmepaymentscorp#/forum/discussions/ticket11622.acmepaymentscorp/details",
    "AuthoringUser" : {
      "UserID" : "a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp",
      "Name" : "adminAcmepaymentscorp",
      "Image" : {
        "Url" : "http://{hostname}/api/users/a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp/avatar",
        "Title" : "adminAcmepaymentscorp",
        "Link" : "#/users/a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp/details"
      }
    },
    "DescriptionMediaType" : "text/plain",
    "BoardItemArtifacts" : {
      "BoardItemArtifact" : [ ]
    }
  } ]
}

Back to top

Sample response headers: application/vnd.soa.v72+xml

Status Code: 200 OK
Content-Type: application/vnd.soa.v72+xml
Expires: Tue, 12 May 2015 12:32:29 GMT

Sample response body: application/vnd.soa.v72+xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Tickets xmlns="http://soa.com/xsd/ticket/1.0" xmlns:ns2="http://soa.com/xsd/api/1.0" 
xmlns:ns3="http://soa.com/xsd/app/1.0" xmlns:ns4="http://soa.com/xsd/user/1.0" 
xmlns:ns5="http://soa.com/xsd/dnmodel/1.0" xmlns:ns6="http://soa.com/xsd/comment/1.0" 
xmlns:ns7="http://soa.com/xsd/board/1.0" xmlns:ns8="http://soa.com/xsd/resource/1.0" 
xmlns:ns9="http://soa.com/xsd/business/1.0" xmlns:ns10="http://a9.com/-/spec/opensearch/1.1/" 
xmlns:ns11="http://soa.com/xsd/alert/1.0" xmlns:ns12="http://soa.com/xsd/contract/1.0" 
xmlns:ns13="http://soa.com/xsd/discussion/1.0" xmlns:ns14="http://soa.com/xsd/review/1.0">
  <Ticket>
    <TicketID>ticket11623.acmepaymentscorp</TicketID>
    <ns2:APIID>037a3fad-45ba-4126-aae4-84a9dadae89e.acmepaymentscorp</ns2:APIID>
    <Title>Bug when using multiple payment types</Title>
    <Description>When I try to use **more than one payment type** the transaction hangs up.</Description>
    <Environment>Production</Environment>
    <State>OPEN</State>
    <ns4:UserID>a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp</ns4:UserID>
    <Created>2015-05-12T17:27:06Z</Created>
    <Label>com.soa.ticket.label.priority.high</Label>
    <Tag>bug</Tag>
    <Tag>payment</Tag>
    <Comments>0</Comments>
    <Marks>0</Marks>
    <IsMarked>false</IsMarked>
    <Visibility>Limited</Visibility>
    <PubDate>2015-05-12T17:27:06Z</PubDate>
    <ns5:Action label="discussion.action.delete">discussion.action.delete</ns5:Action>
    <ns5:TargetResources>
      <ns5:TargetResource>
        <ns5:Name>ACME Payments API</ns5:Name>
        <ns5:ID>b28f3b3b-4c54-4ccf-a4db-55abc7a467f0.acmepaymentscorp</ns5:ID>
        <ns5:Type>api</ns5:Type>
      </ns5:TargetResource>
      <ns5:TargetResource>
        <ns5:Name>1.0</ns5:Name>
        <ns5:ID>037a3fad-45ba-4126-aae4-84a9dadae89e.acmepaymentscorp</ns5:ID>
        <ns5:Type>apiversion</ns5:Type>
      </ns5:TargetResource>
    </ns5:TargetResources>
    <ns5:Image>
      <ns5:Url>http://{hostname}/api/users/a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp/avatar</ns5:Url>
      <ns5:Link>../acmepaymentscorp#/user/a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp/details</ns5:Link>
    </ns5:Image>
    <ns6:CommentsPreview>
      <ns6:Count>0</ns6:Count>
    </ns6:CommentsPreview>
    <Link>../acmepaymentscorp#/forum/discussions/ticket11623.acmepaymentscorp/details</Link>
    <ns5:AuthoringUser>
      <ns5:UserID>a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp</ns5:UserID>
      <ns5:Name>adminAcmepaymentscorp</ns5:Name>
      <ns5:Image>
        <ns5:Url>http://{hostname}/api/users/a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp/avatar</ns5:Url>
        <ns5:Title>adminAcmepaymentscorp</ns5:Title>
        <ns5:Link>#/users/a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp/details</ns5:Link>
      </ns5:Image>
    </ns5:AuthoringUser>
    <ns7:DescriptionMediaType>text/markdown</ns7:DescriptionMediaType>
    <ns7:BoardItemArtifacts />
  </Ticket>
  <Ticket>
    <TicketID>ticket11622.acmepaymentscorp</TicketID>
    <ns2:APIID>037a3fad-45ba-4126-aae4-84a9dadae89e.acmepaymentscorp</ns2:APIID>
    <Title>Cannot log in after timeout</Title>
    <Description>After a timeout, users cannot log back in. Password reset is the only way I've been able to figure to get a user back in.</Description>
    <Environment>Production</Environment>
    <State>OPEN</State>
    <ns4:UserID>a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp</ns4:UserID>
    <Created>2015-05-12T17:06:08Z</Created>
    <Label>com.soa.ticket.label.priority.high</Label>
    <Tag>login</Tag>
    <Tag>timeout</Tag>
    <Comments>0</Comments>
    <Marks>0</Marks>
    <IsMarked>false</IsMarked>
    <Visibility>Limited</Visibility>
    <PubDate>2015-05-12T17:06:08Z</PubDate>
    <ns5:Action label="discussion.action.delete">discussion.action.delete</ns5:Action>
    <ns5:TargetResources>
      <ns5:TargetResource>
        <ns5:Name>ACME Payments API</ns5:Name>
        <ns5:ID>b28f3b3b-4c54-4ccf-a4db-55abc7a467f0.acmepaymentscorp</ns5:ID>
        <ns5:Type>api</ns5:Type>
      </ns5:TargetResource>
      <ns5:TargetResource>
        <ns5:Name>1.0</ns5:Name>
        <ns5:ID>037a3fad-45ba-4126-aae4-84a9dadae89e.acmepaymentscorp</ns5:ID>
        <ns5:Type>apiversion</ns5:Type>
      </ns5:TargetResource>
    </ns5:TargetResources>
    <ns5:Image>
      <ns5:Url>http://{hostname}/api/users/a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp/avatar</ns5:Url>
      <ns5:Link>../acmepaymentscorp#/user/a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp/details</ns5:Link>
    </ns5:Image>
    <ns6:CommentsPreview>
      <ns6:Count>0</ns6:Count>
    </ns6:CommentsPreview>
    <Link>../acmepaymentscorp#/forum/discussions/ticket11622.acmepaymentscorp/details</Link>
    <ns5:AuthoringUser>
      <ns5:UserID>a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp</ns5:UserID>
      <ns5:Name>adminAcmepaymentscorp</ns5:Name>
      <ns5:Image>
        <ns5:Url>http://{hostname}/api/users/a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp/avatar</ns5:Url>
        <ns5:Title>adminAcmepaymentscorp</ns5:Title>
        <ns5:Link>#/users/a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp/details</ns5:Link>
      </ns5:Image>
    </ns5:AuthoringUser>
    <ns7:DescriptionMediaType>text/plain</ns7:DescriptionMediaType>
    <ns7:BoardItemArtifacts />
  </Ticket>
</Tickets>

Back to top

Response Headers

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

Header Description
Content-Type

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

Back to top

Response Body

Name Type Description
Tickets Tickets Contains information about one or more tickets.

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

More information about Akana API Platform API error messages.

Back to top

Related Topics