REST APIs

Owned by Derya Özdemir
Last updated: Aug 17, 2023
3 min read

This page is about Assets & Inventory Plugin for Jira Cloud. Using Server or Data Center? Click here.

These APIs are here to help you edit and view your data. But before you can use them, you need a special token called JWT for authorization.

For further information, click here to access the REST APIs documentation.

To create a new token:

  1. In the top bar, navigate to Settings.

  2. From the side menu, select API Token.

  3. Click New Token to generate a new token.

  4. Name your token, select when it'll expire, or check the Never expire box to make sure the token doesn’t expire in a certain time period, and how much access it will have. Click Save.

For security reasons, we do not recommend generating tokens that never expire. Please be aware that if this token is somehow exposed, you will need to delete it manually, as it will not expire automatically.

  1. The JWT Token will appear. Save it by clicking the icon shown below. Keep in mind that you won’t be able to access this code after closing the pop-up.

  2. Click Cancel after copying the token, and the token will appear on the main page.

  3. Replace {{jwtToken}} in the header with your token.

To give JWT permission:

Here is how you can give JWT authorization using Postman.

  1. Open the AIP REST APIs documentation.

  2. Click Run in Postman > Postman for Web.

  3. On the Postman main page, click Workspaces > My Workspaces.

  4. Click to add a new permission.

  5. Here, to give authorization, first copy and paste the link of the token you’ve chosen from here.

  1. Click Headers.

  2. Under KEY, write Authorization.

  3. Under Value, write “Bearer (paste the token you’ve created and copied)”

  4. Click Send.

10. Tada! You’ve successfully given the JWT authorization.

Rest Call Example

For better comprehension, we included definitions for some values of an example response below.

Example Response

Meaning

Example Response

Meaning

asset.key

This represents a unique identifier or key associated with an asset.

asset.collectionId

An identifier that categorizes or groups assets into different collections.

globalAttributes

These are attributes that are shared across multiple assets or throughout a system.

attachments

This refers to the count or number of attachments that are associated with a particular asset.

createdBy

This indicates the entity (user, system, etc.) that created or added the asset to the system.

createdAt

This refers to the timestamp or date when the asset was created or added to the system.

attributes

These are specific characteristics, properties, or metadata associated with an asset.

startAt

This refers to a parameter used in pagination, indicating the starting point or offset from where the results should be fetched. For example, if you want to fetch data in batches of 10 and you fetch the first 50, the "startAt" value should be set to 51 for the second set of 50.

maxResult

This is a parameter related to pagination, specifying the maximum number of results or items to be returned in a single response.

sortParams

These are parameters that define the sorting order for the retrieved data.