Cloud

External Assets Platform / Reference / REST API

Assets

This resource represents assets in Jira. These assets may have been populated in Jira from another application. Use this resource to get, search for, create, update, and delete assets in Jira.

Operations

PUT/asset/bulk GET/asset PUT/asset GET/asset/{appKey}/{originId}DEL/asset/{appKey}/{originId}GET/asset/search

PUT

Bulk create or update assets

Creates new assets or updates existing assets. Note that updating assets will overwrite their properties with the properties defined in the request object.

Request

Request bodyapplication/json

putRequest

array<asset>

Responses

Returned if the resource is accepted to be asynchronously processed.

PUT/asset/bulk

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url '/rest/assetapi/asset/bulk' \
  --header 'Content-Type: application/json' \
  --data '{
  "putRequest": [
    {
      "origin": {
        "appKey": "com.myasset.app",
        "originId": "5-113-51143-2032"
      },
      "label": {
        "value": "MacBook Pro 15\" 2016"
      },
      "type": {
        "appKey": "com.myasset.app",
        "originId": "5-113-51143-2032"
      },
      "assignee": {
        "accountId": "27505:c73cd17f-ae93-4f10-911c-d754d02420be",
        "email": "test@example.com"
      },
      "fields": [
        {
          "fieldId": "RAM",
          "value": "8GB DDR4 2400MHz"
        }
      ]
    }
  ]
}'

GET

Get all assets

Returns a list of all assets

Request

Query parameters

type

array<string>

start

integer

limit

integer

Responses

Returned if the request is successful. The response may be empty, if no results are found.

application/json

pagedAssets

GET/asset

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url '/rest/assetapi/asset' \
  --header 'Accept: application/json'

200Response

{
  "values": [
    {
      "origin": {
        "appKey": "com.myasset.app",
        "originId": "5-113-51143-2032"
      },
      "label": {
        "value": "MacBook Pro 15\" 2016"
      },
      "type": {
        "appKey": "com.myasset.app",
        "originId": "5-113-51143-2032"
      },
      "assignee": {
        "accountId": "27505:c73cd17f-ae93-4f10-911c-d754d02420be",
        "email": "test@example.com"
      },
      "fields": [
        {
          "fieldId": "RAM",
          "value": "8GB DDR4 2400MHz"
        }
      ]
    }
  ],
  "start": 73,
  "limit": 122,
  "size": 33,
  "isLastPage": true
}

PUT

Create or update asset

Creates a new asset or updates an existing asset. Note that updating an asset will overwrite its properties with the properties defined in the request object.

Request

Request bodyapplication/json

origin

origin

Required

label

label

Required

type

origin

assignee

assignee

fields

array<fieldValue>

Responses

Returned if the resource is updated.

application/json

asset

Asset

PUT/asset

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url '/rest/assetapi/asset' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "origin": {
    "appKey": "com.myasset.app",
    "originId": "5-113-51143-2032"
  },
  "label": {
    "value": "MacBook Pro 15\" 2016"
  },
  "type": {
    "appKey": "com.myasset.app",
    "originId": "5-113-51143-2032"
  },
  "assignee": {
    "accountId": "27505:c73cd17f-ae93-4f10-911c-d754d02420be",
    "email": "test@example.com"
  },
  "fields": [
    {
      "fieldId": "RAM",
      "value": "8GB DDR4 2400MHz"
    }
  ]
}'

200Response

{
  "origin": {
    "appKey": "com.myasset.app",
    "originId": "5-113-51143-2032"
  },
  "label": {
    "value": "MacBook Pro 15\" 2016"
  },
  "type": {
    "appKey": "com.myasset.app",
    "originId": "5-113-51143-2032"
  },
  "assignee": {
    "accountId": "27505:c73cd17f-ae93-4f10-911c-d754d02420be",
    "email": "test@example.com"
  },
  "fields": [
    {
      "fieldId": "RAM",
      "value": "8GB DDR4 2400MHz"
    }
  ]
}

GET

Get an asset by its origin

Request

Path parameters

appKey

string

Required

originId

string

Required

Responses

Returned if the request is successful.

application/json

asset

Asset

GET/asset/{appKey}/{originId}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url '/rest/assetapi/asset/{appKey}/{originId}' \
  --header 'Accept: application/json'

200Response

{
  "origin": {
    "appKey": "com.myasset.app",
    "originId": "5-113-51143-2032"
  },
  "label": {
    "value": "MacBook Pro 15\" 2016"
  },
  "type": {
    "appKey": "com.myasset.app",
    "originId": "5-113-51143-2032"
  },
  "assignee": {
    "accountId": "27505:c73cd17f-ae93-4f10-911c-d754d02420be",
    "email": "test@example.com"
  },
  "fields": [
    {
      "fieldId": "RAM",
      "value": "8GB DDR4 2400MHz"
    }
  ]
}

DEL

Delete an asset

Request

Path parameters

appKey

string

Required

originId

string

Required

Responses

Returned if the request is successful.

DEL/asset/{appKey}/{originId}

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url '/rest/assetapi/asset/{appKey}/{originId}'

GET

Search assets

Searches assets matching the query parameter. Only assets with an appKey matching an installed asset management app will be returned. If no asset management apps are installed, falls back to returning all assets.

Request

Query parameters

query

string

type

array<string>

assignee

array<string>

prioritizedAssignee

array<string>

limit

integer

Responses

Returns a list of assets ordered by relevance to the query parameter. The response may be empty, if no matching assets were found.

application/json

asset

Asset

GET/asset/search

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url '/rest/assetapi/asset/search' \
  --header 'Accept: application/json'

200Response

{
  "origin": {
    "appKey": "com.myasset.app",
    "originId": "5-113-51143-2032"
  },
  "label": {
    "value": "MacBook Pro 15\" 2016"
  },
  "type": {
    "appKey": "com.myasset.app",
    "originId": "5-113-51143-2032"
  },
  "assignee": {
    "accountId": "27505:c73cd17f-ae93-4f10-911c-d754d02420be",
    "email": "test@example.com"
  },
  "fields": [
    {
      "fieldId": "RAM",
      "value": "8GB DDR4 2400MHz"
    }
  ]
}