Custom API Action

Make a custom, authenticated HTTP call to the Jira Service Desk API.

Important Note

This action is unlike other Jira Service Desk cards. See Jira Service Desk API documentation for more information on using custom HTTP calls.

Methods

These are supported HTTP request methods, or HTTP verbs, in a custom API call (see HTTP request methods).

Field Definition Type Required
Request Type   Dropdown TRUE
GET

Retrieves data from a web server based on your parameters. This method requests a representation of the specified resource. If a request is successful, you receive a 200 (OK) response message with the requested content.

   
POST Sends data to a web server based on your parameters (for example, uploading a file). Multiple POST requests may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POST requests. If a request is successful, you receive a 200 (OK) response message.    
PUT Sends data to be stored at a specific location on a web server based on your parameters (for example, uploading a file). The difference between PUT and POST requests is that PUT is idempotent. This means that for successful requests, the result of a single PUT request is the same as many identical PUT requests. If a request is successful, you receive a 200 (OK), 201 (Created), or 204 (No Content) response message.    
PATCH Applies partial modifications to a resource on a web server based on your parameters. PATCH is not idempotent, which means that multiple PATCH requests could have unintended consequences. If a PATCH is successful, you receive a 200 (OK) or 204 (No Content) response message.    
DELETE Deletes the specified resource from the web server based on your parameters (if the resource exists). If a DELETE is successful, you receive a 200 (OK) response message.    

Input

Field Definition Type Required
Request
Relative URL

Specify the relative URL as /api/v2/{insert_remaining_URL}. You can specify query parameters in the relative URL using “?”, or specify the query parameters as an object key pair in the Query input.

Example: https://{{auth.domain}}.atlassian.net/rest/servicedeskapi{{input.Request.Relative URL}}

String FALSE
Query

Specify any additional query parameters that should be included in object format (key value pairs).

Example: {"name":"something-urgent"}

Object or string FALSE
Headers

Specify any headers required in addition to authorization or content-type (these are already handled by this connector). This will usually be similar to the following:

Example: {"Content-type":"application/json"}

Object FALSE
Body Specify a request body in JSON format. Only available for POST, PUT, and PATCH requests. Object FALSE

Output

Field Definition Type
Response
Status Code

The result of your HTTP request. See HTTP status codes.

Number
Headers A detailed context for the status code, unrelated to the output body. Response headers are dependent on your selected HTTP request option. Note that not all headers are response headers. This will be usually similar to {"Content-type":"application/json"}. Object
Body The data returned from your selected HTTP request (for example, the data from a GET request). Object

Related topics

Jira Service Desk connector

About the elements of Okta Workflows

Jira Service Desk API