GET

Get object {id}

Load one object

Data Security Policy: Not exempt from app access rules
Scopes
read:cmdb-object:jira

Request

Path parameters

id

string

Required

Responses

application/json

Object

An Assets object

GET/object/{id}
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/object/{id}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
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 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 { "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b", "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:88", "id": "88", "label": "SYD-1", "objectKey": "ITSM-88", "avatar": { "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b", "url16": "https://api.atlassian.com/jsm/assets/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=48", "url72": "https://api.atlassian.com/jsm/assets/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=72", "url144": "https://api.atlassian.com/jsm/assets/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=144", "url288": "https://api.atlassian.com/jsm/assets/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=288", "objectId": "88", "mediaClientConfig": { "clientId": "1a2s3d4f-dc47-44b0-9t0r-1h2h3yd68e9q", "mediaBaseUrl": "https://api.media.atlassian.com", "mediaJwtToken": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIxYTJzM2Q0Zi1kYzQ3LTQ0YjAtOXQwci0xaDJoM3lkNjhlOXEiLCJhY2Nlc3MiOnsidXJuOmZpbGVzdG9yZTpmaWxlOjg0MTIzZXJ0LTEyM2MtNGIxMi0xMmM1LTBiODZkYzgxMjNmZiI6WyJyZWFkIl19LCJleHAiOjE2MjYxNTY1NjcsIm5iZiI6MTYyNjE1NTkwN30.YjicbagPLbzapp3eEZbCQ7Z9V8Uc0WeBledyTw-Qu0s", "fileId": "84123ert-123c-4b12-12c5-0b86dc8123ff" } }, "objectType": { "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b", "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:23", "id": "23", "name": "Office", "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.", "icon": { "id": "13", "name": "Building", "url16": "https://api.atlassian.com/jsm/assets/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=48" }, "position": 2, "created": "2021-02-16T19:36:51.951Z", "updated": "2021-04-16T15:17:03.384Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "created": "2021-02-16T20:04:41.527Z", "updated": "2021-02-16T20:04:41.527Z", "hasAvatar": false, "timestamp": 1613505881527, "attributes": [ { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:637", "id": "637", "objectTypeAttribute": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:134", "id": "134", "name": "Key", "label": false, "defaultType": { "id": 0, "name": "Text" }, "editable": false, "system": true, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 0 }, "objectTypeAttributeId": "134", "objectAttributeValues": [ { "value": "ITSM-88", "displayValue": "ITSM-88", "searchValue": "ITSM-88", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:640", "id": "640", "objectTypeAttribute": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:135", "id": "135", "name": "Name", "label": true, "description": "The name of the object", "defaultType": { "id": 0, "name": "Text" }, "editable": true, "system": false, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "suffix": "", "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": true, "regexValidation": "", "options": "", "position": 1 }, "objectTypeAttributeId": "135", "objectAttributeValues": [ { "value": "SYD-1", "displayValue": "SYD-1", "searchValue": "SYD-1", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:638", "id": "638", "objectTypeAttribute": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:136", "id": "136", "name": "Created", "label": false, "defaultType": { "id": 6, "name": "DateTime" }, "editable": false, "system": true, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 2 }, "objectTypeAttributeId": "136", "objectAttributeValues": [ { "value": "2021-02-16T20:04:41.527Z", "displayValue": "16/Feb/21 8:04 PM", "searchValue": "2021-02-16T20:04:41.527Z", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:639", "id": "639", "objectTypeAttribute": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:137", "id": "137", "name": "Updated", "label": false, "defaultType": { "id": 6, "name": "DateTime" }, "editable": false, "system": true, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 3 }, "objectTypeAttributeId": "137", "objectAttributeValues": [ { "value": "2021-02-16T20:04:41.527Z", "displayValue": "16/Feb/21 8:04 PM", "searchValue": "2021-02-16T20:04:41.527Z", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:641", "id": "641", "objectTypeAttribute": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:144", "id": "144", "name": "City", "label": false, "referenceType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:4", "id": "4", "name": "Reference", "description": "Reference", "color": "49a6ed", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/config/referencetype/4/image.png?size=16" }, "referenceObjectTypeId": "24", "referenceObjectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:24", "id": "24", "name": "City", "icon": { "id": "28", "name": "Cottage", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=48" }, "position": 3, "created": "2021-02-16T19:58:45.698Z", "updated": "2021-04-16T15:17:03.393Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "editable": true, "system": false, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 0, "maximumCardinality": 1, "removable": true, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 4 }, "objectTypeAttributeId": "144", "objectAttributeValues": [ { "referencedObject": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:87", "id": "87", "label": "Sydney", "objectKey": "ITSM-87", "avatar": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=48", "url72": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=72", "url144": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=144", "url288": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=288", "objectId": "87", "mediaClientConfig": { "clientId": "1a2s3d4f-dc47-44b0-9t0r-1h2h3yd68e9q", "mediaBaseUrl": "https://api.media.atlassian.com", "mediaJwtToken": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIxYTJzM2Q0Zi1kYzQ3LTQ0YjAtOXQwci0xaDJoM3lkNjhlOXEiLCJhY2Nlc3MiOnsidXJuOmZpbGVzdG9yZTpmaWxlOjg0MTIzZXJ0LTEyM2MtNGIxMi0xMmM1LTBiODZkYzgxMjNmZiI6WyJyZWFkIl19LCJleHAiOjE2MjYxNTY1NjcsIm5iZiI6MTYyNjE1NTkwN30.YjicbagPLbzapp3eEZbCQ7Z9V8Uc0WeBledyTw-Qu0s", "fileId": "84123ert-123c-4b12-12c5-0b86dc8123ff" } }, "objectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:24", "id": "24", "name": "City", "icon": { "id": "28", "name": "Cottage", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=48" }, "position": 3, "created": "2021-02-16T19:58:45.698Z", "updated": "2021-04-16T15:17:03.393Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "created": "2021-02-16T20:04:26.445Z", "updated": "2021-02-16T20:04:26.445Z", "hasAvatar": false, "timestamp": 1613505866445, "_links": { "self": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/object/87" }, "name": "Sydney" }, "displayValue": "Sydney", "searchValue": "ITSM-87", "referencedType": true } ], "objectId": "88" } ], "extendedInfo": { "openIssuesExists": false, "attachmentsExists": false }, "_links": { "self": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/object/88" }, "name": "SYD-1" }
PUT

Put object {id}

Update an existing object in Assets

Data Security Policy: Exempt from app access rules
Scopes
write:cmdb-object:jira

Request

Path parameters

id

string

Required

Request bodyapplication/json

objectTypeId

string

Required
attributes

array<ObjectAttributeIn>

Required
hasAvatar

boolean

avatarUUID

string

Responses

The updated object

application/json

Object

An Assets object

PUT/object/{id}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 curl --request PUT \ --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/object/{id}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "attributes": [ { "objectTypeAttributeId": "265", "objectAttributeValues": [ { "value": "A placeholder value" } ] } ], "objectTypeId": "23", "avatarUUID": "", "hasAvatar": false }'
200Response
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 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 { "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b", "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:88", "id": "88", "label": "SYD-1", "objectKey": "ITSM-88", "avatar": { "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b", "url16": "https://api.atlassian.com/jsm/assets/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=48", "url72": "https://api.atlassian.com/jsm/assets/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=72", "url144": "https://api.atlassian.com/jsm/assets/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=144", "url288": "https://api.atlassian.com/jsm/assets/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=288", "objectId": "88", "mediaClientConfig": { "clientId": "1a2s3d4f-dc47-44b0-9t0r-1h2h3yd68e9q", "mediaBaseUrl": "https://api.media.atlassian.com", "mediaJwtToken": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIxYTJzM2Q0Zi1kYzQ3LTQ0YjAtOXQwci0xaDJoM3lkNjhlOXEiLCJhY2Nlc3MiOnsidXJuOmZpbGVzdG9yZTpmaWxlOjg0MTIzZXJ0LTEyM2MtNGIxMi0xMmM1LTBiODZkYzgxMjNmZiI6WyJyZWFkIl19LCJleHAiOjE2MjYxNTY1NjcsIm5iZiI6MTYyNjE1NTkwN30.YjicbagPLbzapp3eEZbCQ7Z9V8Uc0WeBledyTw-Qu0s", "fileId": "84123ert-123c-4b12-12c5-0b86dc8123ff" } }, "objectType": { "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b", "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:23", "id": "23", "name": "Office", "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.", "icon": { "id": "13", "name": "Building", "url16": "https://api.atlassian.com/jsm/assets/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=48" }, "position": 2, "created": "2021-02-16T19:36:51.951Z", "updated": "2021-04-16T15:17:03.384Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "created": "2021-02-16T20:04:41.527Z", "updated": "2021-02-16T20:04:41.527Z", "hasAvatar": false, "timestamp": 1613505881527, "attributes": [ { "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b", "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:637", "id": "637", "objectTypeAttribute": { "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b", "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:134", "id": "134", "name": "Key", "label": false, "defaultType": { "id": 0, "name": "Text" }, "editable": false, "system": true, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 0 }, "objectTypeAttributeId": "134", "objectAttributeValues": [ { "value": "ITSM-88", "displayValue": "ITSM-88", "searchValue": "ITSM-88", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:640", "id": "640", "objectTypeAttribute": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:135", "id": "135", "name": "Name", "label": true, "description": "The name of the object", "defaultType": { "id": 0, "name": "Text" }, "editable": true, "system": false, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "suffix": "", "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": true, "regexValidation": "", "options": "", "position": 1 }, "objectTypeAttributeId": "135", "objectAttributeValues": [ { "value": "SYD-1", "displayValue": "SYD-1", "searchValue": "SYD-1", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:638", "id": "638", "objectTypeAttribute": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:136", "id": "136", "name": "Created", "label": false, "defaultType": { "id": 6, "name": "DateTime" }, "editable": false, "system": true, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 2 }, "objectTypeAttributeId": "136", "objectAttributeValues": [ { "value": "2021-02-16T20:04:41.527Z", "displayValue": "16/Feb/21 8:04 PM", "searchValue": "2021-02-16T20:04:41.527Z", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:639", "id": "639", "objectTypeAttribute": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:137", "id": "137", "name": "Updated", "label": false, "defaultType": { "id": 6, "name": "DateTime" }, "editable": false, "system": true, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 3 }, "objectTypeAttributeId": "137", "objectAttributeValues": [ { "value": "2021-04-20T14:55:02.816Z", "displayValue": "20/Apr/21 2:55 PM", "searchValue": "2021-04-20T14:55:02.816Z", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:641", "id": "641", "objectTypeAttribute": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:144", "id": "144", "name": "City", "label": false, "referenceType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:4", "id": "4", "name": "Reference", "description": "Reference", "color": "49a6ed", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/config/referencetype/4/image.png?size=16" }, "referenceObjectTypeId": "24", "referenceObjectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:24", "id": "24", "name": "City", "icon": { "id": "28", "name": "Cottage", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=48" }, "position": 3, "created": "2021-02-16T19:58:45.698Z", "updated": "2021-04-16T15:17:03.393Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "editable": true, "system": false, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 0, "maximumCardinality": 1, "removable": true, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 4 }, "objectTypeAttributeId": "144", "objectAttributeValues": [ { "referencedObject": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:87", "id": "87", "label": "Sydney", "objectKey": "ITSM-87", "avatar": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=48", "url72": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=72", "url144": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=144", "url288": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=288", "objectId": "87", "mediaClientConfig": { "clientId": "1a2s3d4f-dc47-44b0-9t0r-1h2h3yd68e9q", "mediaBaseUrl": "https://api.media.atlassian.com", "mediaJwtToken": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIxYTJzM2Q0Zi1kYzQ3LTQ0YjAtOXQwci0xaDJoM3lkNjhlOXEiLCJhY2Nlc3MiOnsidXJuOmZpbGVzdG9yZTpmaWxlOjg0MTIzZXJ0LTEyM2MtNGIxMi0xMmM1LTBiODZkYzgxMjNmZiI6WyJyZWFkIl19LCJleHAiOjE2MjYxNTY1NjcsIm5iZiI6MTYyNjE1NTkwN30.YjicbagPLbzapp3eEZbCQ7Z9V8Uc0WeBledyTw-Qu0s", "fileId": "84123ert-123c-4b12-12c5-0b86dc8123ff" } }, "objectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:24", "id": "24", "name": "City", "icon": { "id": "28", "name": "Cottage", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=48" }, "position": 3, "created": "2021-02-16T19:58:45.698Z", "updated": "2021-04-16T15:17:03.393Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "created": "2021-02-16T20:04:26.445Z", "updated": "2021-02-16T20:04:26.445Z", "hasAvatar": false, "timestamp": 1613505866445, "_links": { "self": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/object/87" }, "name": "Sydney" }, "displayValue": "Sydney", "searchValue": "ITSM-87", "referencedType": true } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:44662", "id": "44662", "objectTypeAttribute": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:265", "id": "265", "name": "Placeholder", "label": false, "defaultType": { "id": 0, "name": "Text" }, "editable": true, "system": false, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 0, "maximumCardinality": 1, "removable": true, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 5 }, "objectTypeAttributeId": "265", "objectAttributeValues": [ { "value": "A placeholder value", "displayValue": "A placeholder value", "searchValue": "A placeholder value", "referencedType": false } ], "objectId": "88" } ], "_links": { "self": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/object/88" }, "name": "SYD-1" }
DEL

Delete object {id}

Delete the referenced object

Data Security Policy: Exempt from app access rules
Scopes
delete:cmdb-object:jira

Request

Path parameters

id

string

Required

Responses

The system cannot fulfill the request due to validation errors. See the response body for more details.

DEL/object/{id}
1 2 3 curl --request DELETE \ --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/object/{id}' \ --header 'Authorization: Bearer <access_token>'
GET

Get object {id} attributes

List all attributes for the given object

Data Security Policy: Exempt from app access rules
Scopes
read:cmdb-object:jira

Request

Path parameters

id

string

Required

Responses

application/json

array<ObjectAttribute>

GET/object/{id}/attributes
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/object/{id}/attributes' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
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 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 [ { "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b", "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:637", "id": "637", "objectTypeAttribute": { "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b", "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:134", "id": "134", "name": "Key", "label": false, "type": 0, "defaultType": { "id": 0, "name": "Text" }, "editable": false, "system": true, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 0 }, "objectTypeAttributeId": "134", "objectAttributeValues": [ { "value": "ITSM-88", "displayValue": "ITSM-88", "searchValue": "ITSM-88", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b", "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:640", "id": "640", "objectTypeAttribute": { "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b", "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:135", "id": "135", "name": "Name", "label": true, "type": 0, "description": "The name of the object", "defaultType": { "id": 0, "name": "Text" }, "editable": true, "system": false, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "suffix": "", "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": true, "regexValidation": "", "options": "", "position": 1 }, "objectTypeAttributeId": "135", "objectAttributeValues": [ { "value": "SYD-1", "displayValue": "SYD-1", "searchValue": "SYD-1", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b", "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:638", "id": "638", "objectTypeAttribute": { "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b", "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:136", "id": "136", "name": "Created", "label": false, "type": 0, "defaultType": { "id": 6, "name": "DateTime" }, "editable": false, "system": true, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 2 }, "objectTypeAttributeId": "136", "objectAttributeValues": [ { "value": "2021-02-16T20:04:41.527Z", "displayValue": "16/Feb/21 8:04 PM", "searchValue": "2021-02-16T20:04:41.527Z", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:639", "id": "639", "objectTypeAttribute": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:137", "id": "137", "name": "Updated", "label": false, "type": 0, "defaultType": { "id": 6, "name": "DateTime" }, "editable": false, "system": true, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 3 }, "objectTypeAttributeId": "137", "objectAttributeValues": [ { "value": "2021-04-20T14:55:02.816Z", "displayValue": "20/Apr/21 2:55 PM", "searchValue": "2021-04-20T14:55:02.816Z", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:641", "id": "641", "objectTypeAttribute": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:144", "id": "144", "name": "City", "label": false, "type": 1, "referenceType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:4", "id": "4", "name": "Reference", "description": "Reference", "color": "49a6ed", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/config/referencetype/4/image.png?size=16" }, "referenceObjectTypeId": "24", "referenceObjectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:24", "id": "24", "name": "City", "type": 0, "icon": { "id": "28", "name": "Cottage", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=48" }, "position": 3, "created": "2021-02-16T19:58:45.698Z", "updated": "2021-04-16T15:17:03.393Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "editable": true, "system": false, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 0, "maximumCardinality": 1, "removable": true, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 4 }, "objectTypeAttributeId": "144", "objectAttributeValues": [ { "referencedObject": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:87", "id": "87", "label": "Sydney", "objectKey": "ITSM-87", "avatar": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=48", "url72": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=72", "url144": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=144", "url288": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=288", "objectId": "87", "mediaClientConfig": { "clientId": "1a2s3d4f-dc47-44b0-9t0r-1h2h3yd68e9q", "mediaBaseUrl": "https://api.media.atlassian.com", "mediaJwtToken": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIxYTJzM2Q0Zi1kYzQ3LTQ0YjAtOXQwci0xaDJoM3lkNjhlOXEiLCJhY2Nlc3MiOnsidXJuOmZpbGVzdG9yZTpmaWxlOjg0MTIzZXJ0LTEyM2MtNGIxMi0xMmM1LTBiODZkYzgxMjNmZiI6WyJyZWFkIl19LCJleHAiOjE2MjYxNTY1NjcsIm5iZiI6MTYyNjE1NTkwN30.YjicbagPLbzapp3eEZbCQ7Z9V8Uc0WeBledyTw-Qu0s", "fileId": "84123ert-123c-4b12-12c5-0b86dc8123ff" } }, "objectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:24", "id": "24", "name": "City", "type": 0, "icon": { "id": "28", "name": "Cottage", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=48" }, "position": 3, "created": "2021-02-16T19:58:45.698Z", "updated": "2021-04-16T15:17:03.393Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "created": "2021-02-16T20:04:26.445Z", "updated": "2021-02-16T20:04:26.445Z", "hasAvatar": false, "timestamp": 1613505866445, "_links": { "self": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/object/87" }, "name": "Sydney" }, "displayValue": "Sydney", "searchValue": "ITSM-87", "referencedType": true } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:44662", "id": "44662", "objectTypeAttribute": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:265", "id": "265", "name": "Placeholder", "label": false, "type": 0, "defaultType": { "id": 0, "name": "Text" }, "editable": true, "system": false, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 0, "maximumCardinality": 1, "removable": true, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 5 }, "objectTypeAttributeId": "265", "objectAttributeValues": [ { "value": "A placeholder value", "displayValue": "A placeholder value", "searchValue": "A placeholder value", "referencedType": false } ], "objectId": "88" } ]
GET

Get object {id} history

Retrieve the history entries for this object

Data Security Policy: Exempt from app access rules
Scopes
read:cmdb-object:jira

Request

Path parameters

id

string

Required

Query parameters

asc

boolean

Responses

application/json

array<ObjectHistory>

GET/object/{id}/history
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/object/{id}/history' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
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 30 31 [ { "actor": { "avatarUrl": "https://avatar-management-url/6g2c42d1f6fgd2112cgc66dc/f0bfb5b7-7b3b-4ce6-98a6-bdb5825c19b4/48", "displayName": "John Smith", "name": "John Smith", "key": "6g2c42d1f6fgd2112cgc66dc", "emailAddress": "john.smith@atlassian.com", "isDeleted": false }, "id": "8122", "affectedAttribute": "Placeholder", "oldValue": "", "newValue": "A placeholder value", "created": "2021-04-20T14:55:02.833Z", "objectId": "88" }, { "actor": { "avatarUrl": "https://avatar-management-url/6g2c42d1f6fgd2112cgc66dc/f0bfb5b7-7b3b-4ce6-98a6-bdb5825c19b4/48", "displayName": "John Smith", "name": "John Smith", "key": "6g2c42d1f6fgd2112cgc66dc", "emailAddress": "john.smith@atlassian.com", "isDeleted": false }, "id": "108", "created": "2021-02-16T20:04:41.554Z", "objectId": "88" } ]
GET

Get object {id} referenceinfo

Find all references for an object

Data Security Policy: Not exempt from app access rules
Scopes
read:cmdb-object:jira

Request

Path parameters

id

string

Required

Responses

application/json

array<ObjectReferenceTypeInfo>

GET/object/{id}/referenceinfo
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/object/{id}/referenceinfo' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
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 30 31 32 33 34 35 36 37 38 [ { "referenceTypes": [ { "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:7", "id": "7", "name": "Work At", "color": "688E6E", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/config/referencetype/7/image.png?size=16", "objectSchemaId": "6" } ], "objectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:19", "id": "19", "name": "Employee", "type": 0, "icon": { "id": "131", "name": "Users", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/19/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/19/icon.png?size=48" }, "position": 0, "created": "2021-02-16T18:32:38.173Z", "updated": "2021-02-16T19:37:07.179Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "numberOfReferencedObjects": 2, "openIssuesExists": true } ]
POST

Post object create

Create a new object in Assets

Data Security Policy: Exempt from app access rules
Scopes
write:cmdb-object:jira

Request

Request bodyapplication/json

objectTypeId

string

Required
attributes

array<ObjectAttributeIn>

Required
hasAvatar

boolean

avatarUUID

string

Responses

The created object witout attributes

application/json

Object

An Assets object

POST/object/create
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 curl --request POST \ --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/object/create' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "objectTypeId": "23", "attributes": [ { "objectTypeAttributeId": "135", "objectAttributeValues": [ { "value": "NY-1" } ] }, { "objectTypeAttributeId": "144", "objectAttributeValues": [ { "value": "99" } ] } ] }'
201Response
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 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:5186", "id": "5186", "label": "NY-1", "objectKey": "ITSM-5186", "avatar": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48", "url72": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=72", "url144": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=144", "url288": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=288", "objectId": "5186", "mediaClientConfig": { "clientId": "1a2s3d4f-dc47-44b0-9t0r-1h2h3yd68e9q", "mediaBaseUrl": "https://api.media.atlassian.com", "mediaJwtToken": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIxYTJzM2Q0Zi1kYzQ3LTQ0YjAtOXQwci0xaDJoM3lkNjhlOXEiLCJhY2Nlc3MiOnsidXJuOmZpbGVzdG9yZTpmaWxlOjg0MTIzZXJ0LTEyM2MtNGIxMi0xMmM1LTBiODZkYzgxMjNmZiI6WyJyZWFkIl19LCJleHAiOjE2MjYxNTY1NjcsIm5iZiI6MTYyNjE1NTkwN30.YjicbagPLbzapp3eEZbCQ7Z9V8Uc0WeBledyTw-Qu0s", "fileId": "84123ert-123c-4b12-12c5-0b86dc8123ff" } }, "objectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23", "id": "23", "name": "Office", "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.", "icon": { "id": "13", "name": "Building", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48" }, "position": 2, "created": "2021-02-16T19:36:51.951Z", "updated": "2021-04-16T15:17:03.384Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "created": "2021-04-20T15:25:39.777Z", "updated": "2021-04-20T15:25:39.777Z", "hasAvatar": false, "timestamp": 1618932339777, "_links": { "self": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/object/5186" }, "name": "NY-1" }
POST

Post object navlist aqlDeprecated

Retrieve a list of objects based on an AQL. Deprecated from 30 September 2024. Please use POST /object/aql instead. For more information please see https://developer.atlassian.com/changelog/#CHANGE-1661.

Data Security Policy: Exempt from app access rules
Scopes
read:cmdb-object:jira

Request

Request bodyapplication/json

qlQuery

string

Required
iql

string

Deprecated
objectTypeId

string

Required
page

integer

resultsPerPage

integer

Required
orderByTypeAttrId

integer

asc

integer

objectId

string

objectSchemaId

string

Required
includeAttributes

boolean

Responses

The navlist response and the objects matching the query

application/json

ObjectListResult

A result list containing objects

POST/object/navlist/aql
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 curl --request POST \ --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/object/navlist/aql' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "objectTypeId": "23", "attributesToDisplay": { "attributesToDisplayIds": [ "135", "144" ] }, "page": 1, "asc": 1, "resultsPerPage": 25, "includeAttributes": false, "objectSchemaId": "6", "qlQuery": "objectType = Office AND Name LIKE SYD" }'
200Response
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 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 { "objectEntries": [ { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:88", "id": "88", "label": "SYD-1", "objectKey": "ITSM-88", "avatar": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48", "url72": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=72", "url144": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=144", "url288": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=288", "objectId": "88", "mediaClientConfig": { "clientId": "1a2s3d4f-dc47-44b0-9t0r-1h2h3yd68e9q", "mediaBaseUrl": "https://api.media.atlassian.com", "mediaJwtToken": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIxYTJzM2Q0Zi1kYzQ3LTQ0YjAtOXQwci0xaDJoM3lkNjhlOXEiLCJhY2Nlc3MiOnsidXJuOmZpbGVzdG9yZTpmaWxlOjg0MTIzZXJ0LTEyM2MtNGIxMi0xMmM1LTBiODZkYzgxMjNmZiI6WyJyZWFkIl19LCJleHAiOjE2MjYxNTY1NjcsIm5iZiI6MTYyNjE1NTkwN30.YjicbagPLbzapp3eEZbCQ7Z9V8Uc0WeBledyTw-Qu0s", "fileId": "84123ert-123c-4b12-12c5-0b86dc8123ff" } }, "objectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23", "id": "23", "name": "Office", "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.", "icon": { "id": "13", "name": "Building", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48" }, "position": 2, "created": "2021-02-16T19:36:51.951Z", "updated": "2021-04-16T15:17:03.384Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "created": "2021-02-16T20:04:41.527Z", "updated": "2021-02-16T20:04:41.527Z", "hasAvatar": false, "timestamp": 1613505881527, "attributes": [ { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:637", "id": "637", "objectTypeAttributeId": "134", "objectAttributeValues": [ { "value": "ITSM-88", "displayValue": "ITSM-88", "searchValue": "ITSM-88", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:640", "id": "640", "objectTypeAttributeId": "135", "objectAttributeValues": [ { "value": "SYD-1", "displayValue": "SYD-1", "searchValue": "SYD-1", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:638", "id": "638", "objectTypeAttributeId": "136", "objectAttributeValues": [ { "value": "2021-02-16T20:04:41.527Z", "displayValue": "16/Feb/21 8:04 PM", "searchValue": "2021-02-16T20:04:41.527Z", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:639", "id": "639", "objectTypeAttributeId": "137", "objectAttributeValues": [ { "value": "2021-02-16T20:04:41.527Z", "displayValue": "16/Feb/21 8:04 PM", "searchValue": "2021-02-16T20:04:41.527Z", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:641", "id": "641", "objectTypeAttributeId": "144", "objectAttributeValues": [ { "referencedObject": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:87", "id": "87", "label": "Sydney", "objectKey": "ITSM-87", "avatar": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=48", "url72": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=72", "url144": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=144", "url288": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=288", "objectId": "87", "mediaClientConfig": { "clientId": "1a2s3d4f-dc47-44b0-9t0r-1h2h3yd68e9q", "mediaBaseUrl": "https://api.media.atlassian.com", "mediaJwtToken": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIxYTJzM2Q0Zi1kYzQ3LTQ0YjAtOXQwci0xaDJoM3lkNjhlOXEiLCJhY2Nlc3MiOnsidXJuOmZpbGVzdG9yZTpmaWxlOjg0MTIzZXJ0LTEyM2MtNGIxMi0xMmM1LTBiODZkYzgxMjNmZiI6WyJyZWFkIl19LCJleHAiOjE2MjYxNTY1NjcsIm5iZiI6MTYyNjE1NTkwN30.YjicbagPLbzapp3eEZbCQ7Z9V8Uc0WeBledyTw-Qu0s", "fileId": "84123ert-123c-4b12-12c5-0b86dc8123ff" } }, "objectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:24", "id": "24", "name": "City", "icon": { "id": "28", "name": "Cottage", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=48" }, "position": 3, "created": "2021-02-16T19:58:45.698Z", "updated": "2021-04-16T15:17:03.393Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "created": "2021-02-16T20:04:26.445Z", "updated": "2021-02-16T20:04:26.445Z", "hasAvatar": false, "timestamp": 1613505866445, "_links": { "self": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/object/87" }, "name": "Sydney" }, "displayValue": "Sydney", "searchValue": "ITSM-87", "referencedType": true } ], "objectId": "88" } ], "_links": { "self": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/object/88" }, "name": "SYD-1" } ], "objectTypeAttributes": [ { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:134", "id": "134", "name": "Key", "label": false, "defaultType": { "id": 0, "name": "Text" }, "editable": false, "system": true, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 0 }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:135", "id": "135", "name": "Name", "label": true, "description": "The name of the object", "defaultType": { "id": 0, "name": "Text" }, "editable": true, "system": false, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "suffix": "", "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": true, "regexValidation": "", "options": "", "position": 1 }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:136", "id": "136", "name": "Created", "label": false, "defaultType": { "id": 6, "name": "DateTime" }, "editable": false, "system": true, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 2 }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:137", "id": "137", "name": "Updated", "label": false, "defaultType": { "id": 6, "name": "DateTime" }, "editable": false, "system": true, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 3 }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:144", "id": "144", "name": "City", "label": false, "referenceType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:4", "id": "4", "name": "Reference", "description": "Reference", "color": "49a6ed", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/config/referencetype/4/image.png?size=16" }, "referenceObjectTypeId": "24", "referenceObjectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:24", "id": "24", "name": "City", "icon": { "id": "28", "name": "Cottage", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=48" }, "position": 3, "created": "2021-02-16T19:58:45.698Z", "updated": "2021-04-16T15:17:03.393Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "editable": true, "system": false, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 0, "maximumCardinality": 1, "removable": true, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 4 }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:265", "id": "265", "name": "Placeholder", "label": false, "defaultType": { "id": 0, "name": "Text" }, "editable": true, "system": false, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 0, "maximumCardinality": 1, "removable": true, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 5 } ], "objectTypeIsInherited": false, "abstractObjectType": false, "totalFilterCount": 1, "startIndex": 1, "toIndex": 1, "pageObjectSize": 25, "pageNumber": 1, "orderWay": "ascending", "qlQuery": "objectType = Office AND Name LIKE SYD", "qlQuerySearchResult": true, "conversionPossible": false, "pageSize": 1 }
POST

Post object navlist iqlDeprecated

Deprecated. Use /object/navlist/aql instead.

Data Security Policy: Exempt from app access rules

Request

Request bodyapplication/json

qlQuery

string

Required
iql

string

Deprecated
objectTypeId

string

Required
page

integer

resultsPerPage

integer

Required
orderByTypeAttrId

integer

asc

integer

objectId

string

objectSchemaId

string

Required
includeAttributes

boolean

Responses

The navlist response and the objects matching the query

application/json

ObjectListResult

A result list containing objects

POST/object/navlist/iql
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 curl --request POST \ --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/object/navlist/iql' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "objectTypeId": "23", "attributesToDisplay": { "attributesToDisplayIds": [ 135, 144 ] }, "page": 1, "asc": 1, "resultsPerPage": 25, "includeAttributes": false, "objectSchemaId": "6", "iql": "objectType = Office AND Name LIKE SYD" }'
200Response
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 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 { "objectEntries": [ { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:88", "id": "88", "label": "SYD-1", "objectKey": "ITSM-88", "avatar": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48", "url72": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=72", "url144": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=144", "url288": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=288", "objectId": "88", "mediaClientConfig": { "clientId": "1a2s3d4f-dc47-44b0-9t0r-1h2h3yd68e9q", "mediaBaseUrl": "https://api.media.atlassian.com", "mediaJwtToken": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIxYTJzM2Q0Zi1kYzQ3LTQ0YjAtOXQwci0xaDJoM3lkNjhlOXEiLCJhY2Nlc3MiOnsidXJuOmZpbGVzdG9yZTpmaWxlOjg0MTIzZXJ0LTEyM2MtNGIxMi0xMmM1LTBiODZkYzgxMjNmZiI6WyJyZWFkIl19LCJleHAiOjE2MjYxNTY1NjcsIm5iZiI6MTYyNjE1NTkwN30.YjicbagPLbzapp3eEZbCQ7Z9V8Uc0WeBledyTw-Qu0s", "fileId": "84123ert-123c-4b12-12c5-0b86dc8123ff" } }, "objectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23", "id": "23", "name": "Office", "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.", "icon": { "id": "13", "name": "Building", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48" }, "position": 2, "created": "2021-02-16T19:36:51.951Z", "updated": "2021-04-16T15:17:03.384Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "created": "2021-02-16T20:04:41.527Z", "updated": "2021-02-16T20:04:41.527Z", "hasAvatar": false, "timestamp": 1613505881527, "attributes": [ { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:637", "id": "637", "objectTypeAttributeId": "134", "objectAttributeValues": [ { "value": "ITSM-88", "displayValue": "ITSM-88", "searchValue": "ITSM-88", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:640", "id": "640", "objectTypeAttributeId": "135", "objectAttributeValues": [ { "value": "SYD-1", "displayValue": "SYD-1", "searchValue": "SYD-1", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:638", "id": "638", "objectTypeAttributeId": "136", "objectAttributeValues": [ { "value": "2021-02-16T20:04:41.527Z", "displayValue": "16/Feb/21 8:04 PM", "searchValue": "2021-02-16T20:04:41.527Z", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:639", "id": "639", "objectTypeAttributeId": "137", "objectAttributeValues": [ { "value": "2021-02-16T20:04:41.527Z", "displayValue": "16/Feb/21 8:04 PM", "searchValue": "2021-02-16T20:04:41.527Z", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:641", "id": "641", "objectTypeAttributeId": "144", "objectAttributeValues": [ { "referencedObject": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:87", "id": "87", "label": "Sydney", "objectKey": "ITSM-87", "avatar": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=48", "url72": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=72", "url144": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=144", "url288": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=288", "objectId": "87", "mediaClientConfig": { "clientId": "1a2s3d4f-dc47-44b0-9t0r-1h2h3yd68e9q", "mediaBaseUrl": "https://api.media.atlassian.com", "mediaJwtToken": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIxYTJzM2Q0Zi1kYzQ3LTQ0YjAtOXQwci0xaDJoM3lkNjhlOXEiLCJhY2Nlc3MiOnsidXJuOmZpbGVzdG9yZTpmaWxlOjg0MTIzZXJ0LTEyM2MtNGIxMi0xMmM1LTBiODZkYzgxMjNmZiI6WyJyZWFkIl19LCJleHAiOjE2MjYxNTY1NjcsIm5iZiI6MTYyNjE1NTkwN30.YjicbagPLbzapp3eEZbCQ7Z9V8Uc0WeBledyTw-Qu0s", "fileId": "84123ert-123c-4b12-12c5-0b86dc8123ff" } }, "objectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:24", "id": "24", "name": "City", "icon": { "id": "28", "name": "Cottage", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=48" }, "position": 3, "created": "2021-02-16T19:58:45.698Z", "updated": "2021-04-16T15:17:03.393Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "created": "2021-02-16T20:04:26.445Z", "updated": "2021-02-16T20:04:26.445Z", "hasAvatar": false, "timestamp": 1613505866445, "_links": { "self": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/object/87" }, "name": "Sydney" }, "displayValue": "Sydney", "searchValue": "ITSM-87", "referencedType": true } ], "objectId": "88" } ], "_links": { "self": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/object/88" }, "name": "SYD-1" } ], "objectTypeAttributes": [ { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:134", "id": "134", "name": "Key", "label": false, "defaultType": { "id": 0, "name": "Text" }, "editable": false, "system": true, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 0 }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:135", "id": "135", "name": "Name", "label": true, "description": "The name of the object", "defaultType": { "id": 0, "name": "Text" }, "editable": true, "system": false, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "suffix": "", "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": true, "regexValidation": "", "options": "", "position": 1 }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:136", "id": "136", "name": "Created", "label": false, "defaultType": { "id": 6, "name": "DateTime" }, "editable": false, "system": true, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 2 }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:137", "id": "137", "name": "Updated", "label": false, "defaultType": { "id": 6, "name": "DateTime" }, "editable": false, "system": true, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 3 }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:144", "id": "144", "name": "City", "label": false, "referenceType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:4", "id": "4", "name": "Reference", "description": "Reference", "color": "49a6ed", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/config/referencetype/4/image.png?size=16" }, "referenceObjectTypeId": "24", "referenceObjectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:24", "id": "24", "name": "City", "icon": { "id": "28", "name": "Cottage", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=48" }, "position": 3, "created": "2021-02-16T19:58:45.698Z", "updated": "2021-04-16T15:17:03.393Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "editable": true, "system": false, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 0, "maximumCardinality": 1, "removable": true, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 4 }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:265", "id": "265", "name": "Placeholder", "label": false, "defaultType": { "id": 0, "name": "Text" }, "editable": true, "system": false, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 0, "maximumCardinality": 1, "removable": true, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 5 } ], "objectTypeIsInherited": false, "abstractObjectType": false, "totalFilterCount": 1, "startIndex": 1, "toIndex": 1, "pageObjectSize": 25, "pageNumber": 1, "orderWay": "ascending", "iql": "objectType = Office AND Name LIKE SYD", "iqlSearchResult": true, "conversionPossible": false, "pageSize": 1 }
POST

Post object aql

Fetch Objects by AQL

Data Security Policy: Exempt from app access rules
Scopes
read:cmdb-object:jira

Request

Query parameters

startAt

integer

maxResults

integer

includeAttributes

boolean

Request bodyapplication/json

qlQuery

string

Required

Responses

A object result set that can be used to paginate through the result list of objects

application/json

ObjectListInclTypeAttributesEntryResult

A result list containing objects and object type attributes

POST/object/aql
1 2 3 4 5 6 7 8 curl --request POST \ --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/object/aql?startAt={startAt}&maxResults={maxResults}&includeAttributes={includeAttributes}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "qlQuery": "objectType = Office AND Name LIKE SYD" }'
200Response
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 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 { "startAt": 0, "maxResults": 25, "total": 5, "isLast": "false", "values": [ { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:88", "id": "88", "label": "SYD-1", "objectKey": "ITSM-88", "avatar": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48", "url72": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=72", "url144": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=144", "url288": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=288", "objectId": "88", "mediaClientConfig": { "clientId": "1a2s3d4f-dc47-44b0-9t0r-1h2h3yd68e9q", "mediaBaseUrl": "https://api.media.atlassian.com", "mediaJwtToken": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIxYTJzM2Q0Zi1kYzQ3LTQ0YjAtOXQwci0xaDJoM3lkNjhlOXEiLCJhY2Nlc3MiOnsidXJuOmZpbGVzdG9yZTpmaWxlOjg0MTIzZXJ0LTEyM2MtNGIxMi0xMmM1LTBiODZkYzgxMjNmZiI6WyJyZWFkIl19LCJleHAiOjE2MjYxNTY1NjcsIm5iZiI6MTYyNjE1NTkwN30.YjicbagPLbzapp3eEZbCQ7Z9V8Uc0WeBledyTw-Qu0s", "fileId": "84123ert-123c-4b12-12c5-0b86dc8123ff" } }, "objectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23", "id": "23", "name": "Office", "type": 0, "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.", "icon": { "id": "13", "name": "Building", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48" }, "position": 2, "created": "2021-02-16T19:36:51.951Z", "updated": "2021-04-16T15:17:03.384Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "created": "2021-02-16T20:04:41.527Z", "updated": "2021-02-16T20:04:41.527Z", "hasAvatar": false, "timestamp": 1613505881527, "attributes": [ { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:637", "id": "637", "objectTypeAttributeId": "134", "objectAttributeValues": [ { "value": "ITSM-88", "displayValue": "ITSM-88", "searchValue": "ITSM-88", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:640", "id": "640", "objectTypeAttributeId": "135", "objectAttributeValues": [ { "value": "SYD-1", "displayValue": "SYD-1", "searchValue": "SYD-1", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:638", "id": "638", "objectTypeAttributeId": "136", "objectAttributeValues": [ { "value": "2021-02-16T20:04:41.527Z", "displayValue": "16/Feb/21 8:04 PM", "searchValue": "2021-02-16T20:04:41.527Z", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:639", "id": "639", "objectTypeAttributeId": "137", "objectAttributeValues": [ { "value": "2021-02-16T20:04:41.527Z", "displayValue": "16/Feb/21 8:04 PM", "searchValue": "2021-02-16T20:04:41.527Z", "referencedType": false } ], "objectId": "88" }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:641", "id": "641", "objectTypeAttributeId": "144", "objectAttributeValues": [ { "referencedObject": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:87", "id": "87", "label": "Sydney", "objectKey": "ITSM-87", "avatar": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=48", "url72": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=72", "url144": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=144", "url288": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=288", "objectId": "87", "mediaClientConfig": { "clientId": "1a2s3d4f-dc47-44b0-9t0r-1h2h3yd68e9q", "mediaBaseUrl": "https://api.media.atlassian.com", "mediaJwtToken": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIxYTJzM2Q0Zi1kYzQ3LTQ0YjAtOXQwci0xaDJoM3lkNjhlOXEiLCJhY2Nlc3MiOnsidXJuOmZpbGVzdG9yZTpmaWxlOjg0MTIzZXJ0LTEyM2MtNGIxMi0xMmM1LTBiODZkYzgxMjNmZiI6WyJyZWFkIl19LCJleHAiOjE2MjYxNTY1NjcsIm5iZiI6MTYyNjE1NTkwN30.YjicbagPLbzapp3eEZbCQ7Z9V8Uc0WeBledyTw-Qu0s", "fileId": "84123ert-123c-4b12-12c5-0b86dc8123ff" } }, "objectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:24", "id": "24", "name": "City", "icon": { "id": "28", "name": "Cottage", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=48" }, "position": 3, "created": "2021-02-16T19:58:45.698Z", "updated": "2021-04-16T15:17:03.393Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "created": "2021-02-16T20:04:26.445Z", "updated": "2021-02-16T20:04:26.445Z", "hasAvatar": false, "timestamp": 1613505866445, "_links": { "self": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/object/87" }, "name": "Sydney" }, "displayValue": "Sydney", "searchValue": "ITSM-87", "referencedType": true } ], "objectId": "88" } ], "_links": { "self": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/object/88" }, "name": "SYD-1" } ], "objectTypeAttributes": [ { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:134", "id": "134", "objectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23", "id": "23", "name": "Office", "type": 0, "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.", "icon": { "id": "13", "name": "Building", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48" }, "position": 2, "created": "2021-02-16T19:36:51.951Z", "updated": "2021-04-16T15:17:03.384Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "name": "Key", "label": false, "defaultType": { "id": 0, "name": "Text" }, "editable": false, "system": true, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 0 }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:135", "id": "135", "objectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23", "id": "23", "name": "Office", "type": 0, "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.", "icon": { "id": "13", "name": "Building", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48" }, "position": 2, "created": "2021-02-16T19:36:51.951Z", "updated": "2021-04-16T15:17:03.384Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "name": "Name", "label": true, "description": "The name of the object", "defaultType": { "id": 0, "name": "Text" }, "editable": true, "system": false, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "suffix": "", "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": true, "regexValidation": "", "options": "", "position": 1 }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:136", "id": "136", "objectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23", "id": "23", "name": "Office", "type": 0, "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.", "icon": { "id": "13", "name": "Building", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48" }, "position": 2, "created": "2021-02-16T19:36:51.951Z", "updated": "2021-04-16T15:17:03.384Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "name": "Created", "label": false, "defaultType": { "id": 6, "name": "DateTime" }, "editable": false, "system": true, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 2 }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:137", "id": "137", "objectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23", "id": "23", "name": "Office", "type": 0, "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.", "icon": { "id": "13", "name": "Building", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48" }, "position": 2, "created": "2021-02-16T19:36:51.951Z", "updated": "2021-04-16T15:17:03.384Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "name": "Updated", "label": false, "defaultType": { "id": 6, "name": "DateTime" }, "editable": false, "system": true, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 1, "maximumCardinality": 1, "removable": false, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 3 }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:144", "id": "144", "objectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23", "id": "23", "name": "Office", "type": 0, "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.", "icon": { "id": "13", "name": "Building", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48" }, "position": 2, "created": "2021-02-16T19:36:51.951Z", "updated": "2021-04-16T15:17:03.384Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "name": "City", "label": false, "referenceType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:4", "id": "4", "name": "Reference", "description": "Reference", "color": "49a6ed", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/config/referencetype/4/image.png?size=16" }, "referenceObjectTypeId": "24", "referenceObjectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:24", "id": "24", "name": "City", "icon": { "id": "28", "name": "Cottage", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=48" }, "position": 3, "created": "2021-02-16T19:58:45.698Z", "updated": "2021-04-16T15:17:03.393Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "editable": true, "system": false, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 0, "maximumCardinality": 1, "removable": true, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 4 }, { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:265", "id": "265", "objectType": { "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a", "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23", "id": "23", "name": "Office", "type": 0, "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.", "icon": { "id": "13", "name": "Building", "url16": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16", "url48": "https://api.atlassian.com/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48" }, "position": 2, "created": "2021-02-16T19:36:51.951Z", "updated": "2021-04-16T15:17:03.384Z", "objectCount": 0, "objectSchemaId": "6", "inherited": false, "abstractObjectType": false, "parentObjectTypeInherited": false }, "name": "Placeholder", "label": false, "defaultType": { "id": 0, "name": "Text" }, "editable": true, "system": false, "sortable": true, "summable": false, "indexed": true, "minimumCardinality": 0, "maximumCardinality": 1, "removable": true, "hidden": false, "includeChildObjectTypes": false, "uniqueAttribute": false, "options": "", "position": 5 } ] }
POST

Post object aql totalcount

This API provides the total count of objects that match a specified AQL query. Please note that this operation may incur performance latency.

Data Security Policy: Exempt from app access rules
Scopes
read:cmdb-object:jira

Request

Request bodyapplication/json

qlQuery

string

Required

Responses

An integer representing the total count for a given AQL

application/json

ObjectAQLTotalCountResult

An object that is used to represent the total count of objects returned for a given AQL query

POST/object/aql/totalcount
1 2 3 4 5 6 7 8 curl --request POST \ --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/object/aql/totalcount' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "qlQuery": "objectType = Office AND Name LIKE SYD" }'
200Response
1 2 3 { "totalCount": 5 }

Rate this page: