Create a new object in Assets.
The object to create.
integer
Requiredarray<ObjectAttributeInEntry>
RequiredReturns the created object. An example of creating an object with the name set to "Hello" and where the Name attribute's ID is set to 2 and the object type ID is 1.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
curl --request POST \
--url 'http://{baseurl}/rest/assets/1.0/object/create' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"objectTypeId": 2154,
"attributes": [
{
"objectId": 2154,
"objectTypeAttributeId": 2154,
"objectAttributeValues": [
{
"value": "<string>"
}
],
"operationType": 2154
}
]
}'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
{
"id": 2154,
"label": "<string>",
"objectKey": "<string>",
"avatar": {
"id": 2154,
"avatarUUID": "<string>",
"url16": "<string>",
"url48": "<string>",
"url72": "<string>",
"url144": "<string>",
"url288": "<string>",
"objectId": 2154
},
"objectType": {
"id": 2154,
"name": "<string>",
"type": 2154,
"description": "<string>",
"icon": {
"expand": "<string>",
"project": "<string>",
"position": "<string>",
"after": "<string>",
"id": 2154,
"name": "<string>",
"url16": "<string>",
"url48": "<string>"
},
"position": 2154,
"created": "<string>",
"updated": "<string>",
"objectCount": 2154,
"parentObjectTypeId": 2154,
"objectSchemaId": 2154,
"inherited": true,
"abstractObjectType": true,
"parentObjectTypeInherited": true
},
"archivedDate": "<string>",
"archivedBy": {
"avatarUrl": "<string>",
"displayName": "<string>",
"name": "<string>",
"key": "<string>",
"html": "<string>",
"renderedLink": "<string>",
"isDeleted": true,
"lastSeenVersion": "<string>"
},
"created": "<string>",
"updated": "<string>",
"hasAvatar": true,
"timestamp": 2154,
"attributes": [
{
"id": 2154,
"objectTypeAttribute": {
"id": 2154,
"objectType": {},
"name": "<string>",
"label": true,
"type": 2154,
"description": "<string>",
"defaultType": {},
"typeValue": "<string>",
"typeValueMulti": [
"<string>"
],
"additionalValue": "<string>",
"referenceType": {},
"referenceObjectTypeId": 2154,
"referenceObjectType": {},
"confluenceTypeValue": {},
"confluenceAddValue": {},
"versionTypeValues": [
{}
],
"editable": true,
"system": true,
"sortable": true,
"summable": true,
"indexed": true,
"minimumCardinality": 2154,
"maximumCardinality": 2154,
"suffix": "<string>",
"removable": true,
"objectAttributeExists": true,
"hidden": true,
"includeChildObjectTypes": true,
"uniqueAttribute": true,
"regexValidation": "<string>",
"qlQuery": "<string>",
"options": "<string>",
"position": 2154,
"iql": "<string>",
"versionTypeValue": {}
},
"objectTypeAttributeId": 2154,
"objectAttributeValues": [
{
"user": {},
"group": {},
"confluencePage": {},
"version": {},
"project": {},
"status": {},
"value": {},
"additionalValue": "<string>",
"displayValue": {},
"searchValue": {},
"referencedType": true
}
],
"objectId": 2154
}
],
"extendedInfo": {
"openIssuesExists": true,
"attachmentsExists": true
},
"get_links": {
"self": "<string>"
},
"name": "<string>",
"archived": true
}Get an object.
string
Requiredstring
string
Returns the requested object.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/assets/1.0/object/{id}' \
--header 'Accept: application/json'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
{
"id": 2154,
"label": "<string>",
"objectKey": "<string>",
"avatar": {
"id": 2154,
"avatarUUID": "<string>",
"url16": "<string>",
"url48": "<string>",
"url72": "<string>",
"url144": "<string>",
"url288": "<string>",
"objectId": 2154
},
"objectType": {
"id": 2154,
"name": "<string>",
"type": 2154,
"description": "<string>",
"icon": {
"expand": "<string>",
"project": "<string>",
"position": "<string>",
"after": "<string>",
"id": 2154,
"name": "<string>",
"url16": "<string>",
"url48": "<string>"
},
"position": 2154,
"created": "<string>",
"updated": "<string>",
"objectCount": 2154,
"parentObjectTypeId": 2154,
"objectSchemaId": 2154,
"inherited": true,
"abstractObjectType": true,
"parentObjectTypeInherited": true
},
"archivedDate": "<string>",
"archivedBy": {
"avatarUrl": "<string>",
"displayName": "<string>",
"name": "<string>",
"key": "<string>",
"html": "<string>",
"renderedLink": "<string>",
"isDeleted": true,
"lastSeenVersion": "<string>"
},
"created": "<string>",
"updated": "<string>",
"hasAvatar": true,
"timestamp": 2154,
"attributes": [
{
"id": 2154,
"objectTypeAttribute": {
"id": 2154,
"objectType": {},
"name": "<string>",
"label": true,
"type": 2154,
"description": "<string>",
"defaultType": {},
"typeValue": "<string>",
"typeValueMulti": [
"<string>"
],
"additionalValue": "<string>",
"referenceType": {},
"referenceObjectTypeId": 2154,
"referenceObjectType": {},
"confluenceTypeValue": {},
"confluenceAddValue": {},
"versionTypeValues": [
{}
],
"editable": true,
"system": true,
"sortable": true,
"summable": true,
"indexed": true,
"minimumCardinality": 2154,
"maximumCardinality": 2154,
"suffix": "<string>",
"removable": true,
"objectAttributeExists": true,
"hidden": true,
"includeChildObjectTypes": true,
"uniqueAttribute": true,
"regexValidation": "<string>",
"qlQuery": "<string>",
"options": "<string>",
"position": 2154,
"iql": "<string>",
"versionTypeValue": {}
},
"objectTypeAttributeId": 2154,
"objectAttributeValues": [
{
"user": {},
"group": {},
"confluencePage": {},
"version": {},
"project": {},
"status": {},
"value": {},
"additionalValue": "<string>",
"displayValue": {},
"searchValue": {},
"referencedType": true
}
],
"objectId": 2154
}
],
"extendedInfo": {
"openIssuesExists": true,
"attachmentsExists": true
},
"get_links": {
"self": "<string>"
},
"name": "<string>",
"archived": true
}Update an existing object in Assets.
string
RequiredThe object to update.
integer
Requiredarray<ObjectAttributeInEntry>
RequiredReturns the updated object.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
curl --request PUT \
--url 'http://{baseurl}/rest/assets/1.0/object/{id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"objectTypeId": 2154,
"attributes": [
{
"objectId": 2154,
"objectTypeAttributeId": 2154,
"objectAttributeValues": [
{
"value": "<string>"
}
],
"operationType": 2154
}
]
}'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
{
"id": 2154,
"label": "<string>",
"objectKey": "<string>",
"avatar": {
"id": 2154,
"avatarUUID": "<string>",
"url16": "<string>",
"url48": "<string>",
"url72": "<string>",
"url144": "<string>",
"url288": "<string>",
"objectId": 2154
},
"objectType": {
"id": 2154,
"name": "<string>",
"type": 2154,
"description": "<string>",
"icon": {
"expand": "<string>",
"project": "<string>",
"position": "<string>",
"after": "<string>",
"id": 2154,
"name": "<string>",
"url16": "<string>",
"url48": "<string>"
},
"position": 2154,
"created": "<string>",
"updated": "<string>",
"objectCount": 2154,
"parentObjectTypeId": 2154,
"objectSchemaId": 2154,
"inherited": true,
"abstractObjectType": true,
"parentObjectTypeInherited": true
},
"archivedDate": "<string>",
"archivedBy": {
"avatarUrl": "<string>",
"displayName": "<string>",
"name": "<string>",
"key": "<string>",
"html": "<string>",
"renderedLink": "<string>",
"isDeleted": true,
"lastSeenVersion": "<string>"
},
"created": "<string>",
"updated": "<string>",
"hasAvatar": true,
"timestamp": 2154,
"attributes": [
{
"id": 2154,
"objectTypeAttribute": {
"id": 2154,
"objectType": {},
"name": "<string>",
"label": true,
"type": 2154,
"description": "<string>",
"defaultType": {},
"typeValue": "<string>",
"typeValueMulti": [
"<string>"
],
"additionalValue": "<string>",
"referenceType": {},
"referenceObjectTypeId": 2154,
"referenceObjectType": {},
"confluenceTypeValue": {},
"confluenceAddValue": {},
"versionTypeValues": [
{}
],
"editable": true,
"system": true,
"sortable": true,
"summable": true,
"indexed": true,
"minimumCardinality": 2154,
"maximumCardinality": 2154,
"suffix": "<string>",
"removable": true,
"objectAttributeExists": true,
"hidden": true,
"includeChildObjectTypes": true,
"uniqueAttribute": true,
"regexValidation": "<string>",
"qlQuery": "<string>",
"options": "<string>",
"position": 2154,
"iql": "<string>",
"versionTypeValue": {}
},
"objectTypeAttributeId": 2154,
"objectAttributeValues": [
{
"user": {},
"group": {},
"confluencePage": {},
"version": {},
"project": {},
"status": {},
"value": {},
"additionalValue": "<string>",
"displayValue": {},
"searchValue": {},
"referencedType": true
}
],
"objectId": 2154
}
],
"extendedInfo": {
"openIssuesExists": true,
"attachmentsExists": true
},
"get_links": {
"self": "<string>"
},
"name": "<string>",
"archived": true
}Delete the referenced object.
string
RequiredReturns the deleted object.
1
2
3
curl --request DELETE \
--url 'http://{baseurl}/rest/assets/1.0/object/{id}' \
--header 'Accept: application/json'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
{
"id": 2154,
"label": "<string>",
"objectKey": "<string>",
"avatar": {
"id": 2154,
"avatarUUID": "<string>",
"url16": "<string>",
"url48": "<string>",
"url72": "<string>",
"url144": "<string>",
"url288": "<string>",
"objectId": 2154
},
"objectType": {
"id": 2154,
"name": "<string>",
"type": 2154,
"description": "<string>",
"icon": {
"expand": "<string>",
"project": "<string>",
"position": "<string>",
"after": "<string>",
"id": 2154,
"name": "<string>",
"url16": "<string>",
"url48": "<string>"
},
"position": 2154,
"created": "<string>",
"updated": "<string>",
"objectCount": 2154,
"parentObjectTypeId": 2154,
"objectSchemaId": 2154,
"inherited": true,
"abstractObjectType": true,
"parentObjectTypeInherited": true
},
"archivedDate": "<string>",
"archivedBy": {
"avatarUrl": "<string>",
"displayName": "<string>",
"name": "<string>",
"key": "<string>",
"html": "<string>",
"renderedLink": "<string>",
"isDeleted": true,
"lastSeenVersion": "<string>"
},
"created": "<string>",
"updated": "<string>",
"hasAvatar": true,
"timestamp": 2154,
"attributes": [
{
"id": 2154,
"objectTypeAttribute": {
"id": 2154,
"objectType": {},
"name": "<string>",
"label": true,
"type": 2154,
"description": "<string>",
"defaultType": {},
"typeValue": "<string>",
"typeValueMulti": [
"<string>"
],
"additionalValue": "<string>",
"referenceType": {},
"referenceObjectTypeId": 2154,
"referenceObjectType": {},
"confluenceTypeValue": {},
"confluenceAddValue": {},
"versionTypeValues": [
{}
],
"editable": true,
"system": true,
"sortable": true,
"summable": true,
"indexed": true,
"minimumCardinality": 2154,
"maximumCardinality": 2154,
"suffix": "<string>",
"removable": true,
"objectAttributeExists": true,
"hidden": true,
"includeChildObjectTypes": true,
"uniqueAttribute": true,
"regexValidation": "<string>",
"qlQuery": "<string>",
"options": "<string>",
"position": 2154,
"iql": "<string>",
"versionTypeValue": {}
},
"objectTypeAttributeId": 2154,
"objectAttributeValues": [
{
"user": {},
"group": {},
"confluencePage": {},
"version": {},
"project": {},
"status": {},
"value": {},
"additionalValue": "<string>",
"displayValue": {},
"searchValue": {},
"referencedType": true
}
],
"objectId": 2154
}
],
"extendedInfo": {
"openIssuesExists": true,
"attachmentsExists": true
},
"get_links": {
"self": "<string>"
},
"name": "<string>",
"archived": true
}Retrieve a list of objects based on an AQL query.
The AQL query to execute.
integer
integer
integer
integer
integer
string
integer
integer
boolean
ObjectTypeAttributesToDisplayEntry
Returns the navlist response and the objects matching the query.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
curl --request POST \
--url 'http://{baseurl}/rest/assets/1.0/object/navlist/aql' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"page": 2154,
"asc": 2154,
"objectTypeId": 2154,
"objectId": 2154,
"objectSchemaId": 2154,
"qlQuery": "<string>",
"resultsPerPage": 2154,
"orderByTypeAttrId": 2154,
"includeAttributes": true,
"attributesToDisplay": {
"attributesToDisplayIds": [
2154
]
},
"iql": "<string>"
}'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
{
"objectEntries": [
{
"id": 2154,
"label": "<string>",
"objectKey": "<string>",
"avatar": {
"id": 2154,
"avatarUUID": "<string>",
"url16": "<string>",
"url48": "<string>",
"url72": "<string>",
"url144": "<string>",
"url288": "<string>",
"objectId": 2154
},
"objectType": {
"id": 2154,
"name": "<string>",
"type": 2154,
"description": "<string>",
"icon": {},
"position": 2154,
"created": "<string>",
"updated": "<string>",
"objectCount": 2154,
"parentObjectTypeId": 2154,
"objectSchemaId": 2154,
"inherited": true,
"abstractObjectType": true,
"parentObjectTypeInherited": true
},
"archivedDate": "<string>",
"archivedBy": {
"avatarUrl": "<string>",
"displayName": "<string>",
"name": "<string>",
"key": "<string>",
"html": "<string>",
"renderedLink": "<string>",
"isDeleted": true,
"lastSeenVersion": "<string>"
},
"created": "<string>",
"updated": "<string>",
"hasAvatar": true,
"timestamp": 2154,
"attributes": [
{
"id": 2154,
"objectTypeAttribute": {},
"objectTypeAttributeId": 2154,
"objectAttributeValues": [
{}
],
"objectId": 2154
}
],
"extendedInfo": {
"openIssuesExists": true,
"attachmentsExists": true
},
"get_links": {
"self": "<string>"
},
"name": "<string>",
"archived": true
}
],
"objectTypeAttributes": [
{
"id": 2154,
"objectType": {
"id": 2154,
"name": "<string>",
"type": 2154,
"description": "<string>",
"icon": {},
"position": 2154,
"created": "<string>",
"updated": "<string>",
"objectCount": 2154,
"parentObjectTypeId": 2154,
"objectSchemaId": 2154,
"inherited": true,
"abstractObjectType": true,
"parentObjectTypeInherited": true
},
"name": "<string>",
"label": true,
"type": 2154,
"description": "<string>",
"defaultType": {
"id": 2154,
"name": "<string>"
},
"typeValue": "<string>",
"typeValueMulti": [
"<string>"
],
"additionalValue": "<string>",
"referenceType": {
"expand": "<string>",
"project": "<string>",
"position": "<string>",
"after": "<string>",
"id": 2154,
"name": "<string>",
"description": "<string>",
"color": "<string>",
"url16": "<string>",
"removable": true,
"objectSchemaId": 2154
},
"referenceObjectTypeId": 2154,
"referenceObjectType": {
"id": 2154,
"name": "<string>",
"type": 2154,
"description": "<string>",
"icon": {},
"position": 2154,
"created": "<string>",
"updated": "<string>",
"objectCount": 2154,
"parentObjectTypeId": 2154,
"objectSchemaId": 2154,
"inherited": true,
"abstractObjectType": true,
"parentObjectTypeInherited": true
},
"confluenceTypeValue": {
"id": "<string>",
"name": "<string>",
"uri": "<string>",
"error": true
},
"confluenceAddValue": {
"key": "<string>",
"name": "<string>",
"error": true
},
"versionTypeValues": [
{
"avatarUrl": "<string>",
"id": 2154,
"name": "<string>",
"key": "<string>",
"url": "<string>"
}
],
"editable": true,
"system": true,
"sortable": true,
"summable": true,
"indexed": true,
"minimumCardinality": 2154,
"maximumCardinality": 2154,
"suffix": "<string>",
"removable": true,
"objectAttributeExists": true,
"hidden": true,
"includeChildObjectTypes": true,
"uniqueAttribute": true,
"regexValidation": "<string>",
"qlQuery": "<string>",
"options": "<string>",
"position": 2154,
"iql": "<string>",
"versionTypeValue": {
"avatarUrl": "<string>",
"id": 2154,
"name": "<string>",
"key": "<string>",
"url": "<string>"
}
}
],
"objectTypeId": 2154,
"objectTypeIsInherited": true,
"abstractObjectType": true,
"totalFilterCount": 2154,
"startIndex": 2154,
"toIndex": 2154,
"pageObjectSize": 2154,
"pageNumber": 2154,
"orderByTypeAttrId": 2154,
"orderWay": "<string>",
"filters": [
{
"objectTypeAttributeId": 2154,
"selectedValues": [
"<string>"
],
"filterByObjectType": true
}
],
"qlQuery": "<string>",
"qlQuerySearchResult": true,
"conversionPossible": true,
"matchedFilterValues": [
{
"id": 2154,
"objectTypeAttribute": {
"id": 2154,
"objectType": {},
"name": "<string>",
"label": true,
"type": 2154,
"description": "<string>",
"defaultType": {},
"typeValue": "<string>",
"typeValueMulti": [
"<string>"
],
"additionalValue": "<string>",
"referenceType": {},
"referenceObjectTypeId": 2154,
"referenceObjectType": {},
"confluenceTypeValue": {},
"confluenceAddValue": {},
"versionTypeValues": [
{}
],
"editable": true,
"system": true,
"sortable": true,
"summable": true,
"indexed": true,
"minimumCardinality": 2154,
"maximumCardinality": 2154,
"suffix": "<string>",
"removable": true,
"objectAttributeExists": true,
"hidden": true,
"includeChildObjectTypes": true,
"uniqueAttribute": true,
"regexValidation": "<string>",
"qlQuery": "<string>",
"options": "<string>",
"position": 2154,
"iql": "<string>",
"versionTypeValue": {}
},
"objectTypeAttributeId": 2154,
"objectAttributeValues": [
{
"referencedObject": {},
"user": {},
"group": {},
"confluencePage": {},
"version": {},
"project": {},
"status": {},
"value": {},
"additionalValue": "<string>",
"displayValue": {},
"searchValue": {},
"referencedType": true
}
],
"objectId": 2154
}
],
"inheritanceTree": {
"parentObjectTypeIdsInclSelf": {}
},
"iql": "<string>",
"pageSize": 2154,
"iqlSearchResult": true
}Get all attributes for the given object.
string
RequiredReturns the list of attributes for the requested object.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/assets/1.0/object/{id}/attributes' \
--header 'Accept: application/json'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
{
"id": 2154,
"objectTypeAttribute": {
"id": 2154,
"objectType": {
"id": 2154,
"name": "<string>",
"type": 2154,
"description": "<string>",
"icon": {},
"position": 2154,
"created": "<string>",
"updated": "<string>",
"objectCount": 2154,
"parentObjectTypeId": 2154,
"objectSchemaId": 2154,
"inherited": true,
"abstractObjectType": true,
"parentObjectTypeInherited": true
},
"name": "<string>",
"label": true,
"type": 2154,
"description": "<string>",
"defaultType": {
"id": 2154,
"name": "<string>"
},
"typeValue": "<string>",
"typeValueMulti": [
"<string>"
],
"additionalValue": "<string>",
"referenceType": {
"expand": "<string>",
"project": "<string>",
"position": "<string>",
"after": "<string>",
"id": 2154,
"name": "<string>",
"description": "<string>",
"color": "<string>",
"url16": "<string>",
"removable": true,
"objectSchemaId": 2154
},
"referenceObjectTypeId": 2154,
"referenceObjectType": {
"id": 2154,
"name": "<string>",
"type": 2154,
"description": "<string>",
"icon": {},
"position": 2154,
"created": "<string>",
"updated": "<string>",
"objectCount": 2154,
"parentObjectTypeId": 2154,
"objectSchemaId": 2154,
"inherited": true,
"abstractObjectType": true,
"parentObjectTypeInherited": true
},
"confluenceTypeValue": {
"id": "<string>",
"name": "<string>",
"uri": "<string>",
"error": true
},
"confluenceAddValue": {
"key": "<string>",
"name": "<string>",
"error": true
},
"versionTypeValues": [
{
"avatarUrl": "<string>",
"id": 2154,
"name": "<string>",
"key": "<string>",
"url": "<string>"
}
],
"editable": true,
"system": true,
"sortable": true,
"summable": true,
"indexed": true,
"minimumCardinality": 2154,
"maximumCardinality": 2154,
"suffix": "<string>",
"removable": true,
"objectAttributeExists": true,
"hidden": true,
"includeChildObjectTypes": true,
"uniqueAttribute": true,
"regexValidation": "<string>",
"qlQuery": "<string>",
"options": "<string>",
"position": 2154,
"iql": "<string>",
"versionTypeValue": {
"avatarUrl": "<string>",
"id": 2154,
"name": "<string>",
"key": "<string>",
"url": "<string>"
}
},
"objectTypeAttributeId": 2154,
"objectAttributeValues": [
{
"referencedObject": {
"id": 2154,
"label": "<string>",
"objectKey": "<string>",
"avatar": {},
"objectType": {},
"archivedDate": "<string>",
"archivedBy": {},
"created": "<string>",
"updated": "<string>",
"hasAvatar": true,
"timestamp": 2154,
"attributes": [],
"extendedInfo": {},
"get_links": {},
"name": "<string>",
"archived": true
},
"user": {
"avatarUrl": "<string>",
"displayName": "<string>",
"name": "<string>",
"key": "<string>",
"html": "<string>",
"renderedLink": "<string>",
"isDeleted": true,
"lastSeenVersion": "<string>"
},
"group": {
"avatarUrl": "<string>",
"name": "<string>"
},
"confluencePage": {
"id": "<string>",
"title": "<string>",
"url": "<string>"
},
"version": {
"avatarUrl": "<string>",
"name": "<string>",
"id": 2154,
"url": "<string>"
},
"project": {
"avatarUrl": "<string>",
"id": 2154,
"name": "<string>",
"key": "<string>",
"url": "<string>"
},
"status": {
"id": 2154,
"name": "<string>",
"description": "<string>",
"category": 2154,
"objectSchemaId": 2154
},
"value": {},
"additionalValue": "<string>",
"displayValue": {},
"searchValue": {},
"referencedType": true
}
],
"objectId": 2154
}Retrieve the history entries for this object.
string
Requiredboolean
string
string
Returns a list of history entries for the requested object.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/assets/1.0/object/{id}/history' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"actor": {
"avatarUrl": "<string>",
"displayName": "<string>",
"name": "<string>",
"key": "<string>",
"html": "<string>",
"renderedLink": "<string>",
"isDeleted": true,
"lastSeenVersion": "<string>"
},
"id": 2154,
"affectedAttribute": "<string>",
"oldValue": "<string>",
"newValue": "<string>",
"type": 2154,
"created": "<string>",
"objectId": 2154,
"importSourceId": 2154
}Use /navlist/aql resource to retrieve objects.
The IQL query to execute.
integer
integer
integer
integer
integer
string
integer
integer
boolean
ObjectTypeAttributesToDisplayEntry
Returns the navlist response and the objects matching the query.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
curl --request POST \
--url 'http://{baseurl}/rest/assets/1.0/object/navlist/iql' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"page": 2154,
"asc": 2154,
"objectTypeId": 2154,
"objectId": 2154,
"objectSchemaId": 2154,
"qlQuery": "<string>",
"resultsPerPage": 2154,
"orderByTypeAttrId": 2154,
"includeAttributes": true,
"attributesToDisplay": {
"attributesToDisplayIds": [
2154
]
},
"iql": "<string>"
}'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
{
"objectEntries": [
{
"id": 2154,
"label": "<string>",
"objectKey": "<string>",
"avatar": {
"id": 2154,
"avatarUUID": "<string>",
"url16": "<string>",
"url48": "<string>",
"url72": "<string>",
"url144": "<string>",
"url288": "<string>",
"objectId": 2154
},
"objectType": {
"id": 2154,
"name": "<string>",
"type": 2154,
"description": "<string>",
"icon": {},
"position": 2154,
"created": "<string>",
"updated": "<string>",
"objectCount": 2154,
"parentObjectTypeId": 2154,
"objectSchemaId": 2154,
"inherited": true,
"abstractObjectType": true,
"parentObjectTypeInherited": true
},
"archivedDate": "<string>",
"archivedBy": {
"avatarUrl": "<string>",
"displayName": "<string>",
"name": "<string>",
"key": "<string>",
"html": "<string>",
"renderedLink": "<string>",
"isDeleted": true,
"lastSeenVersion": "<string>"
},
"created": "<string>",
"updated": "<string>",
"hasAvatar": true,
"timestamp": 2154,
"attributes": [
{
"id": 2154,
"objectTypeAttribute": {},
"objectTypeAttributeId": 2154,
"objectAttributeValues": [
{}
],
"objectId": 2154
}
],
"extendedInfo": {
"openIssuesExists": true,
"attachmentsExists": true
},
"get_links": {
"self": "<string>"
},
"name": "<string>",
"archived": true
}
],
"objectTypeAttributes": [
{
"id": 2154,
"objectType": {
"id": 2154,
"name": "<string>",
"type": 2154,
"description": "<string>",
"icon": {},
"position": 2154,
"created": "<string>",
"updated": "<string>",
"objectCount": 2154,
"parentObjectTypeId": 2154,
"objectSchemaId": 2154,
"inherited": true,
"abstractObjectType": true,
"parentObjectTypeInherited": true
},
"name": "<string>",
"label": true,
"type": 2154,
"description": "<string>",
"defaultType": {
"id": 2154,
"name": "<string>"
},
"typeValue": "<string>",
"typeValueMulti": [
"<string>"
],
"additionalValue": "<string>",
"referenceType": {
"expand": "<string>",
"project": "<string>",
"position": "<string>",
"after": "<string>",
"id": 2154,
"name": "<string>",
"description": "<string>",
"color": "<string>",
"url16": "<string>",
"removable": true,
"objectSchemaId": 2154
},
"referenceObjectTypeId": 2154,
"referenceObjectType": {
"id": 2154,
"name": "<string>",
"type": 2154,
"description": "<string>",
"icon": {},
"position": 2154,
"created": "<string>",
"updated": "<string>",
"objectCount": 2154,
"parentObjectTypeId": 2154,
"objectSchemaId": 2154,
"inherited": true,
"abstractObjectType": true,
"parentObjectTypeInherited": true
},
"confluenceTypeValue": {
"id": "<string>",
"name": "<string>",
"uri": "<string>",
"error": true
},
"confluenceAddValue": {
"key": "<string>",
"name": "<string>",
"error": true
},
"versionTypeValues": [
{
"avatarUrl": "<string>",
"id": 2154,
"name": "<string>",
"key": "<string>",
"url": "<string>"
}
],
"editable": true,
"system": true,
"sortable": true,
"summable": true,
"indexed": true,
"minimumCardinality": 2154,
"maximumCardinality": 2154,
"suffix": "<string>",
"removable": true,
"objectAttributeExists": true,
"hidden": true,
"includeChildObjectTypes": true,
"uniqueAttribute": true,
"regexValidation": "<string>",
"qlQuery": "<string>",
"options": "<string>",
"position": 2154,
"iql": "<string>",
"versionTypeValue": {
"avatarUrl": "<string>",
"id": 2154,
"name": "<string>",
"key": "<string>",
"url": "<string>"
}
}
],
"objectTypeId": 2154,
"objectTypeIsInherited": true,
"abstractObjectType": true,
"totalFilterCount": 2154,
"startIndex": 2154,
"toIndex": 2154,
"pageObjectSize": 2154,
"pageNumber": 2154,
"orderByTypeAttrId": 2154,
"orderWay": "<string>",
"filters": [
{
"objectTypeAttributeId": 2154,
"selectedValues": [
"<string>"
],
"filterByObjectType": true
}
],
"qlQuery": "<string>",
"qlQuerySearchResult": true,
"conversionPossible": true,
"matchedFilterValues": [
{
"id": 2154,
"objectTypeAttribute": {
"id": 2154,
"objectType": {},
"name": "<string>",
"label": true,
"type": 2154,
"description": "<string>",
"defaultType": {},
"typeValue": "<string>",
"typeValueMulti": [
"<string>"
],
"additionalValue": "<string>",
"referenceType": {},
"referenceObjectTypeId": 2154,
"referenceObjectType": {},
"confluenceTypeValue": {},
"confluenceAddValue": {},
"versionTypeValues": [
{}
],
"editable": true,
"system": true,
"sortable": true,
"summable": true,
"indexed": true,
"minimumCardinality": 2154,
"maximumCardinality": 2154,
"suffix": "<string>",
"removable": true,
"objectAttributeExists": true,
"hidden": true,
"includeChildObjectTypes": true,
"uniqueAttribute": true,
"regexValidation": "<string>",
"qlQuery": "<string>",
"options": "<string>",
"position": 2154,
"iql": "<string>",
"versionTypeValue": {}
},
"objectTypeAttributeId": 2154,
"objectAttributeValues": [
{
"referencedObject": {},
"user": {},
"group": {},
"confluencePage": {},
"version": {},
"project": {},
"status": {},
"value": {},
"additionalValue": "<string>",
"displayValue": {},
"searchValue": {},
"referencedType": true
}
],
"objectId": 2154
}
],
"inheritanceTree": {
"parentObjectTypeIdsInclSelf": {}
},
"iql": "<string>",
"pageSize": 2154,
"iqlSearchResult": true
}Find all inbound references for an object.
string
RequiredReturns a list of references for the object.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/assets/1.0/object/{id}/referenceinfo' \
--header 'Accept: application/json'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
{
"referenceTypes": [
{
"expand": "<string>",
"project": "<string>",
"position": "<string>",
"after": "<string>",
"id": 2154,
"name": "<string>",
"description": "<string>",
"color": "<string>",
"url16": "<string>",
"removable": true,
"objectSchemaId": 2154
}
],
"objectType": {
"id": 2154,
"name": "<string>",
"type": 2154,
"description": "<string>",
"icon": {
"expand": "<string>",
"project": "<string>",
"position": "<string>",
"after": "<string>",
"id": 2154,
"name": "<string>",
"url16": "<string>",
"url48": "<string>"
},
"position": 2154,
"created": "<string>",
"updated": "<string>",
"objectCount": 2154,
"parentObjectTypeId": 2154,
"objectSchemaId": 2154,
"inherited": true,
"abstractObjectType": true,
"parentObjectTypeInherited": true
},
"numberOfReferencedObjects": 2154,
"openIssuesExists": true
}Rate this page: