Asset types

This resource represents asset types in Jira. Asset types are used to categorize assets. Use this resource to get, create, update, and delete assets in Jira.

Returns all asset types.

GET /rest/assetapi/asset/type

Fetches all available asset types. Only asset types with an appKey matching an installed asset management app will be returned. If no asset management apps are installed, falls back to returning all asset types.

Request

Query parameters
start

integer

The index of the first item to return in a page of results (page offset).

Default: 0, Format: int32
limit

integer

The maximum number of items to return per page. Note that this may be constrained by the Assets platform service.

Default: 50, Format: int32

Example

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

Responses

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

Content typeValue
application/json

assetTypes

Creates or updates an asset type.

PUT /rest/assetapi/asset/type

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

Request

Body parameters
origin

origin

label

label

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
curl --request PUT \
  --url '/rest/assetapi/asset/type' \
  --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"
  }
}'

Responses

Returned if the resource is updated.

Content typeValue
application/json

assetType

Deletes an asset type

DELETE /rest/assetapi/asset/type/{appKey}/{originId}

Request

Path parameters
appKey Required

string

The app key, which should be the Connect app key. This parameter is used to scope the originId.

originId Required

string

The identifier of an asset/asset type. This is the same identifier for the asset/asset type in its origin (external) system.

Example

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

Responses

Returned if the request is successful.

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.

Get all assets

GET /rest/assetapi/asset

Returns a list of all assets

Request

Query parameters
start

integer

The index of the first item to return in a page of results (page offset).

Default: 0, Format: int32
limit

integer

The maximum number of items to return per page. Note that this may be constrained by the Assets platform service.

Default: 20, Minimum: 0, Maximum: 100, Format: int32

Example

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

Responses

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

Content typeValue
application/json

pagedAssets

Create or update asset.

PUT /rest/assetapi/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

Body parameters
origin Required

origin

label Required

label

type

origin

assignee

assignee

fields

Array<fieldValue>

The list of asset's fields, this is an arbitrary list of vendor specific fields which will be available for searching.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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"
    }
  ]
}'

Responses

Returned if the resource is updated.

Content typeValue
application/json

asset

Search assets

GET /rest/assetapi/asset/search

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

The search term that will be matched with either label, origin or fields values.

type

Array<string>

The asset type to filter the search by. Set this to the concatenation of the asset type’s appKey and originId, in the format appKey/originId.

assignee

Array<string>

The assignees to filter the search by. Set one of these values to unassigned if you want to include unassigned assets.

prioritizedAssignee

Array<string>

The assignee the search is prioritized by. This means that results with an assignee matching this one will be promoted to the top of the list. If multiple prioritizedAssignee parameters are specified, only the first one will be used.

limit

integer

The maximum number of items to return per page. Note that this may be constrained by the Assets platform service.

Default: 10, Minimum: 0, Maximum: 10, Format: int32

Example

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

Responses

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

Content typeValue
application/json

assets

Returns an asset by its origin.

GET /rest/assetapi/asset/{appKey}/{originId}

Request

Path parameters
appKey Required

string

The app key, which should be the Connect app key. This parameter is used to scope the originId.

originId Required

string

The identifier of an asset/asset type. This is the same identifier for the asset/asset type in its origin (external) system.

Example

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

Responses

Returned if the request is successful.

Content typeValue
application/json

asset

Deletes an asset.

DELETE /rest/assetapi/asset/{appKey}/{originId}

Request

Path parameters
appKey Required

string

The app key, which should be the Connect app key. This parameter is used to scope the originId.

originId Required

string

The identifier of an asset/asset type. This is the same identifier for the asset/asset type in its origin (external) system.

Example

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

Responses

Returned if the request is successful.

A schema has not been defined for this response code.