Create Assets objects via REST API for various attribute types in Jira Cloud

Platform Notice: Cloud Only - This article only applies to Atlassian products on the cloud platform.

Summary

There is a scenario where the admin needs to create an Asset object via the REST API.

Solution

The purpose of this documentation

In the Assets Cloud REST API documentation, there is a list of APIs available. However, it didn't give an example of a JSON template for certain scenarios. For this article, we list the JSON templates to create a new object based on each attribute type. Using the same JSON template, you can use it to update Asset objects using the REST API, too.

Using the Assets REST API

Follow the step-by-step to create a new object using the REST API :

  1. Generate an API token for your account to execute the REST API using Basic Authentication:

    1. Go to https://id.atlassian.com/manage/api-tokens.

    2. Click Create API Token.

    3. Set a Label and click Create.

    4. Save the Token somewhere safe to use it for later.

  2. Get the workspace ID for your site:

    1. Run the API below:

      https://<JSM Premium Site Name>.atlassian.net/rest/servicedeskapi/insight/workspace

    2. From the response, save the workspace ID.

  3. Then, use the POST object API to create the new object. The API is as below, make sure to update the workspace ID:

    POST https://api.atlassian.com/jsm/insight/workspace/{workspaceId}/v1/object/create

  4. Structure the JSON template using the basic template as follows:

    { "objectTypeId": "250", "attributes": [ { "objectTypeAttributeId": "2797", "objectAttributeValues": [ { "value": "Test" } ] }, { "objectTypeAttributeId": "2807", "objectAttributeValues": [ { "value": "Testing" } ] } ] }

    ObjectTypeID: You can get it from the Object Type configuration page.

    ObjectTypeAttributeID: You can get it from the Object Type attribute configuration page.

  5. Below is the detailed template for each attribute:

Attribute Type

Notes

Example

Text

The value just needs to be the expected text.

{       "objectTypeAttributeId": "2797",       "objectAttributeValues": [         {           "value": "Test"         }       ]     }

Boolean

The value can be either true or false.

{       "objectTypeAttributeId": "2800",       "objectAttributeValues": [         {           "value": "true"         }       ]     }

Integer

The value must be an exact number.

{       "objectTypeAttributeId": "2801",       "objectAttributeValues": [         {           "value": "123"         }       ]     }

Float

The value must be a floating number.

{       "objectTypeAttributeId": "2802",       "objectAttributeValues": [         {           "value": "123.0"         }       ]     }

Date

The value format is

YYYY-MM-DD

{       "objectTypeAttributeId": "2803",       "objectAttributeValues": [         {           "value": "2022-08-09"         }       ]     }

Date and Time

The value format is

YYYY-MM-DDTHH:mm:ss.sssZ

{       "objectTypeAttributeId": "2804",       "objectAttributeValues": [         {           "value": "2022-08-10T13:00:00.000+10:00"         }       ]     }

URL

The value must start with HTTP:// or HTTPS://

{       "objectTypeAttributeId": "2805",       "objectAttributeValues": [         {           "value": "https://www.google.com"         }       ]     }

Email

The value must be a valid email format

{ "objectTypeAttributeId": "2806", "objectAttributeValues": [ { "value": "xxxx@atlassian.com" } ] }

Text Area

The value just needs to be the expected text.

{       "objectTypeAttributeId": "2807",       "objectAttributeValues": [         {           "value": "This is a long text"         }       ]     }

Select

The value must be the selection value name. This is an example of a single value.

{ "objectTypeAttributeId": "2808", "objectAttributeValues": [ { "value": "one" } ] }

Select

The value must be the selection value name. This is an example of multi-value.

{ "objectTypeAttributeId": "2808", "objectAttributeValues": [ { "value": "one" }, { "value": "two" } ] }

IP Address

The value must represent IP Addresses (IPv4). This is an example of a single value.

{ "objectTypeAttributeId": "2809", "objectAttributeValues": [ { "value": "10.11.11.11" } ] }

Reference Object

The value must be the reference object key. This is an example of a single value.

{ "objectTypeAttributeId": "2811", "objectAttributeValues": [ { "value": "AP-76" } ] }

Reference Object

The value must be the reference object key. This is an example of multi-value.

{ "objectTypeAttributeId": "2811", "objectAttributeValues": [ { "value": "AP-24" }, { "value": "AP-76" } ] }

Group

The value must be the group name. This example is for a single value.

{ "objectTypeAttributeId": "2812", "objectAttributeValues": [ { "value": "administrators" } ] }

Group

The value must be the group name. This example is for a multi-value.

{ "objectTypeAttributeId": "2812", "objectAttributeValues": [ { "value": "administrators" }, { "value": "atlassian-addons-admin" } ] }

User

The value must be the user's Atlassian Account ID. This example is for a single value.

{ "objectTypeAttributeId": "2810", "objectAttributeValues": [ { "value": "557057:1a8aeee5-40e9-413a-9f4e-2f074f09644a" } ] }

User

The value must be the user's Atlassian Account ID. This example is for a multi-value.

{ "objectTypeAttributeId": "2810", "objectAttributeValues": [ { "value": "557057:1a8aeee5-40e9-413a-9f4e-2f074f09644a" }, { "value": "557058:13a8c36c-79e5-44d7-8a6a-d985370a8c91" } ] }

Project

The value must be the project ID. You can get this via the REST API call <JIRA_BASE_URL>/rest/api/latest/project/<project_key>

{ "objectTypeAttributeId": "699", "objectAttributeValues": [ { "value": "10030" } ] }

Tips: For an easier way to get the correct JSON template for your REST API, try to create or update the object from the UI. While doing it, open the Developer Tool > Network and look for the create request and click Payload.

Click View Source for the raw data.

For Postman, the request will look like the following example:

{ "objectTypeId": "23", "attributes": [ { "objectTypeAttributeId": "135", "objectAttributeValues": [ { "value": "NY-1" } ] },

Updated on June 23, 2025
Platform
Cloud only
Product
Jira Service Management Cloud
On this pageSummarySolution

Still need help?

The Atlassian Community is here for you.
Ask the Community