Connecting to Assets API

Learn how to connect to the Assets API.

Actions for Jira Service Management enables you to use Assets, so you can include the Assets custom field in Request and/or Workflow actions. To do that, you must have the Jira Service Management Premium Plan and be connected to the Assets API.

API tokens serve for authentication, allowing you to use the Atlassian cloud product securely. We require this token due to the limitations of Atlassian’s API. Without it, we cannot access the configuration information for Assets field types. This information is essential for accurately displaying and managing these fields.

This chapter guides you on how to:

• Access the Assets API configuration page.
• Establish Assets API connection.
• Check Assets API connection status.
• Disconnect Assets API.

Access the Assets API configuration page

Follow the steps below to access the Assets API configuration page:

Steps

1. Navigate to Jira admin settings > Marketplace Apps > Actions for Jira Service Management.
2. Click Actions for Jira Service Management.
3. Select the Assets API section.

Result

You are redirected to the Assets API configuration page, where you can establish Assets API connection.

Establish Assets API connection

To establish the Assets API connection:

1. Check your Jira Service Management Premium Plan.
2. Access the Assets API configuration page.
3. Enter your Atlassian email address.
4. Create the token from your Atlassian account and copy and paste it into the API token field.
5. Click Connect.

   

Result

The connection is established. Now, you can add the previously set up and configured Assets custom field to your Request and/or Workflow actions. To do that, follow the linked guides for detailed instructions.

Check Assets API connection status

You can always check if the ongoing API connection works correctly by accessing the Assets API configuration page and checking its status. To access the page, follow the below steps:

Steps

1. Access the Assets API configuration page.
2. Look at the bottom of the configuration page where the Connection status is displayed. Three statuses may be displayed:

• Connected - status with a green label means that the connection works as expected.
• Checking - status with a blue label means the connection is being verified.
• Error - status with a red label, meaning there is some problem with your API token. In this case, check the token on the Manage your API tokens page or disconnect it and connect the new one.

  

Result

You can check the Assets API connection status.

Disconnect Assets API

You can end the ongoing API connection by disconnecting from the Assets API. To do that, follow the below steps.

Steps

1. Access the Assets API configuration page.
2. Click Disconnect and confirm your decision.

   

Result

The Assets API connection is disconnected. You can reconnect it by providing your API token and Atlassian email address.