Last updated Feb 23, 2024

Assets REST API Guide

The Standard Assets REST API Guide will walk you through a workflow that is designed for users that want to use the REST API to complete tasks other than importing data or data structures into Assets. It follows the normal procedure of making REST API calls using basic auth.

This workflow includes the following steps:

  1. Use basic auth to authenticate.
  2. Use the workspace call to discover your workspaceID
  3. Use the REST API with your workspaceID to make your REST API calls.

Step 1: Authenticate using basic auth

Authentication: For authenticating directly against the REST API, the Assets in Jira Service Management REST API supports basic auth ( see Basic auth for REST APIs).

Authorization: For making calls directly against the REST API, authorization is based on the user used in the authentication process.

See Security overview for more details on authentication and authorization.

Please note that import APIs might support extra means of authentication, such as OAuth tokens. Read more about this in the Imports REST API guide.

If you are using the Imports REST API, only container tokens will be accepted, unless you're building on Atlassian Forge. For more information on how to integrate with Assets using Forge, see: Importing Third Party data into Assets using Forge.

Step 2: Discover your workspaceId

Workspace ID: The Jira Service Management REST API uses the workspaceId to identify your individual instance of Assets. You must include the workspaceId when making any calls to the REST API.

You can discover your workspaceId through the following endpoint:

1
2
https://<JSM Premium Site Name>.atlassian.net/rest/servicedeskapi/assets/workspace

Step 3: Use the REST API

The workspaceId should be included in any requests as follows:

1
2
https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v{version}/object/{id}

Rate this page: