POST /api/tickets

Opens a new ticket.

Note: If you are using markdown, and will be incorporating one or more artifacts in your ticket, you must upload the artifacts first. Run the POST /api/boards/items/artifacts operation to upload the first artifact and the POST /api/boards/items/{BoardItemID}/artifacts operation to upload any subsequent artifacts. Use the values from the responses, such as the BoardItemID and the image paths, to construct the payload for adding the ticket.

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

Workflow: A default workflow is in effect for new tickets, unless a custom workflow is specified. By default, when a new ticket is created, the @Create initial action is used to start the workflow for the new ticket. This places the new ticket in an Open state. This is the default behavior; if a custom workflow is in use, the initial action is determined by the custom workflow. For more information on workflow, see Executing Workflow Actions.

This topic includes the following sections:

HTTP Method

POST

Back to top

URL

https://{hostname}/api/tickets

Back to top

Sample Request

The example below shows a request to add a specific ticket.

Request URL

https://{hostname}/api/tickets

Sample request headers

POST /api/tickets HTTP/1.1
Host: {hostname}
Accept: text/html, */*; q=0.01
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_{tenant}: {TokenID}

Sample request body: application/json

{
  "UserID":"8dba2d85-1108-417f-ad81-7a369e9e5d79.acmepaymentscorp",
  "Description":"When I try to use more than one payment type the transaction hangs up. It's happened to me **twice**.",
  "Title":"Bug when using multiple payment types",
  "Environment":"Production",
  "APIID":"ecbf7010-abcf-41f8-9f52-1c02b3a51984.acmepaymentscorp",
  "AppID":"4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp",
  "Label":[
    "com.soa.ticket.label.priority.high"
  ],
  "Tag":[
    "bug",
    "payment",
    "multiple"
  ],
  "BoardItemArtifacts":{
    "BoardItemArtifact":[

    ]
  },
  "DescriptionMediaType":"text/markdown"
}

Sample request body: application/xml

<Ticket xmlns="http://soa.com/xsd/ticket/1.0" xmlns:ns2="http://soa.com/xsd/api/1.0" 
xmlns:ns3="http://soa.com/xsd/resource/1.0" xmlns:ns4="http://soa.com/xsd/business/1.0" 
xmlns:ns5="http://soa.com/xsd/dnmodel/1.0" xmlns:ns6="http://soa.com/xsd/board/1.0" 
xmlns:ns7="http://soa.com/xsd/app/1.0" xmlns:ns8="http://soa.com/xsd/user/1.0" 
xmlns:ns9="http://soa.com/xsd/comment/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">
  <ns2:APIID>ecbf7010-abcf-41f8-9f52-1c02b3a51984.acmepaymentscorp</ns2:APIID>
  <ns3:AppID>990af3d3-d4e8-4b78-ae31-d61c474ab4d9.acmepaymentscorp</ns3:AppID>
  <Title>Bug when using multiple payment types</Title>
  <Description>When I try to use more than one payment type the transaction hangs up. It's happened to me **twice**.</Description>
  <Environment>Production</Environment>
  <ns8:UserID>c24c82dc-13d8-41ee-b1d7-3329f5446e6f.acmepaymentscorp</ns8:UserID>
  <Label>com.soa.ticket.label.priority.high</Label>
  <ns6:DescriptionMediaType>text/plain</ns6:DescriptionMediaType>
  <ns6:BoardItemArtifacts />
</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
Ticket Body Ticket Required Includes information about a ticket. The request message must include: APIID, Title, Description, Environment, UserID, and Label.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the TicketID for the new ticket.

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: Mon, 11 May 2015 20:17:47 GMT

Sample response body

ticket25687.acmepaymentscorp

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
TicketID string The unique ID for the new ticket.

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
400 Bad request: Returned if the client sends invalid parameters or body content. For example, you might get this response if you send an incorrect JSON object in the request, or specified the wrong media type in the Content-Type header.
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.
405 Method Not Allowed. For example, you might get this if you specified an invalid Accept header or omitted a required Content-Type header.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics