This page includes release notes and updates for app developers working against the Assets API. Use this page to keep track of upcoming changes, deprecation notices, new features, and feature updates from Assets.
Go to our developer community to ask questions. You may also be interested in the What's New blog for Atlassian Cloud where details of major changes that affect all developers are announced.
We are deprecating the Assets AQL anyAttribute function and it will be retired on 31st March 2024. For further details see https://community.atlassian.com/t5/Jira-Service-Management-articles/UPDATED-DATE-Upcoming-change-Assets-AQL-function-anyAttribute-to/ba-p/2586178.
Added externalIds functionality to object schemas, object types and object type attributes. externalIds allows users to assign an Id to an object schema, object type, and object type attribute for future modifications, and as a unique reference in update and mapping requests.
https://developer.atlassian.com/cloud/assets/imports-rest-api-guide/schema-and-mapping/
https://developer.atlassian.com/cloud/assets/rest/api-group-importsource/#api-group-importsource
Added extra fields to support:
uniqueness
cardinality
status
externalId
Added a new endpoint which retrieves the JSON provided in the mapping endpoint:
Get /schemaAndMapping
We will be making changes to Assets ObjectSchema REST API. In March 2024 we will be removing idAsInt property from the ObjectSchema API response payload. We have updated the examples in our documentation to reflect the future state of the response payload, without the idAsInt property.
Currently, our identifiers (id or <entity>Id) are strings representing integers, but they may change to UUID or other string representations in the near future.
We have updated type information for selected properties across the Assets API documentation, to indicate that they are Strings. These properties were previously documented incorrectly as Integers. See the More details section for the specific properties.
We also updated the response payload of object/aql endpoint to reflect the actual API response. See the More details section for payload details.
The following properties' type information has been updated
attributesToDisplay
referenceObjectTypeId
Id of ObjectHistory
objectId of ObjectHistory
parentObjectTypeId
objectTypeAttributeId
An example response of object/aql endpoint
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
28
29
{
"startAt": ,
"maxResults": 25,
"total": 1,
//Objects
"values": [
{
"workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
"globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:88",
"id": "88",
"label": "SYD-1",
"objectKey": "ITSM-88",
"avatar": {..},
"objectType" : {..},
"created": "2023-09-12T07:04:55.588Z",
"updated": "2023-09-12T07:42:29.807Z",
"hasAvatar": false,
"timestamp": 1694504549807,
"attributes": [..],
"_links": {
"self": "https://api.atlassian.com/jsm/insight/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/object/34"
},
"name": "SYD-1"
}
],
"objectTypeAttributes": [..],
"last": true,
"isLast": true
}We’ve added a template for surfacing Forge UI Kit elements when integrating your app with Jira Service Management assets. This template includes extension points for useful import actions, including:
creating and deleting import structures
starting and stopping imports
returning import progress
Refer to the following pages for additional details:
In Jira Service Management, ‘Insight' has now changed its name to 'Assets'.
URLs with **/insight/** are now **/assets/**
URLs with **/iql/** are now **/aql/**
There’s no action required - no functionality has changed, and the change is backward-compatible.
An improvement will be made in the coming days to allow customers (site admins) to turn off (or back on) end-user installation capabilities for OAuth 2.0 (3LO) apps. If you are a developer of OAuth 2.0 (3LO) apps, you do not need to take any action as a result of this change, as this message is only to communicate the impact to the customer.
Previously, controls were not in place for an admin to block their users from installing 3LO apps. Adding the ability for an admin to prohibit users from installing 3LO apps now aligns more closely to how a user would install any other, non-3LO apps on the Marketplace. This functionality was requested by several Atlassian enterprise customers to gain increased control over where their data is shared and which apps have access to their instance. By allowing admins to control end-user app installs, we are making it possible for more enterprise customers to move to cloud. Once in cloud, these companies will not be blocked from installing 3LO apps, because admins will retain the ability to vet and install the apps at their discretion.
Figure (a) below demonstrates the section of the customer’s admin console where they will now be able to block their users from installing 3LO apps. Figure (b) below shows the new experience when a customer tries to install a 3LO app after their admin has disabled this function.
If a customer attempts to install a 3LO app after their admin has disabled this function, the following error message will appear:
App is blocked by an admin
An admin has not allowed [App Name] to access data from [Your Atlassian Instance] . Select another site to authorize access to or contact your admin for more information.
(a)
(b)
External imports can now define and use their own set of icons.
External imports can now define object reference attributes in their schema and mapping configuration and push object references in the data.
The "mapping" endpoint for external imports now supports PATCH invocations that specify incremental updates to be performed on the schema and mapping configuration.
We published a new set of APIs to allow external applications to import data into Insight.
Rate this page: