Archive the referenced object.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredReturns the archived object.
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/assets/1.0/object/archive/{objectIdentifier}' \
--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>",
"searchValue": {},
"referencedType": true,
"displayValue": {}
}
],
"objectId": 2154
}
],
"extendedInfo": {
"openIssuesExists": true,
"attachmentsExists": true
},
"get_links": {
"self": "<string>"
},
"name": "<string>",
"archived": true
}Bulk archive objects of an object type by filter.
Forge and OAuth2 apps cannot access this REST resource.
string
The filter to use for archiving objects.
integer
boolean
ObjectIQLFilterParamEntry
ObjectFilterParamsEntry
boolean
ObjectIQLFilterParamEntry
Returns the progress of the bulk archive operation.
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
curl --request POST \
--url 'http://{baseurl}/rest/assets/1.0/object/archive/by-filter' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"objectSchemaId": 2154,
"qlQuerySearch": true,
"qlQueryParams": {
"page": 2154,
"asc": 2154,
"objectTypeId": 2154,
"objectId": 2154,
"objectSchemaId": 2154,
"qlQuery": "<string>",
"resultsPerPage": 2154,
"orderByTypeAttrId": 2154,
"includeAttributes": true,
"attributesToDisplay": {
"attributesToDisplayIds": [
2154
]
},
"iql": "<string>"
},
"filterParams": {
"page": 2154,
"asc": 2154,
"objectTypeId": 2154,
"objectId": 2154,
"objectSchemaId": 2154,
"resultsPerPage": 2154,
"orderByTypeAttrId": 2154,
"filters": [
{
"objectTypeAttributeId": 2154,
"selectedValues": [
"<string>"
],
"filterByObjectType": true
}
],
"includeAttributes": true,
"attributesToDisplay": {
"attributesToDisplayIds": [
2154
]
},
"attributesToDisplayIds": [
2154
]
},
"iqlSearch": true,
"iqlParams": {
"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
{
"progressInPercent": 2154,
"resourceId": "<string>",
"category": "<string>",
"status": "<string>",
"stepDescription": "<string>",
"currentStep": 2154,
"numberOfSteps": 2154,
"currentWorkUnits": 2154,
"currentWorkDescription": "<string>",
"currentStepTotalWorkUnits": 2154,
"totalWorkUnits": 2154,
"result": "<string>",
"resultData": {},
"resultMessage": "<string>",
"actor": "<string>",
"startDate": "<string>",
"finishedDate": "<string>",
"estimatedFinishDate": "<string>"
}Bulk archive objects across object schemas by object keys asynchronously.
Forge and OAuth2 apps cannot access this REST resource.
The list of object keys to archive.
string
Returns the progress of the bulk archive operation.
1
2
3
4
5
curl --request POST \
--url 'http://{baseurl}/rest/assets/1.0/object/archive/by-keys' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '"<string>"'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"progressInPercent": 2154,
"resourceId": "<string>",
"category": "<string>",
"status": "<string>",
"stepDescription": "<string>",
"currentStep": 2154,
"numberOfSteps": 2154,
"currentWorkUnits": 2154,
"currentWorkDescription": "<string>",
"currentStepTotalWorkUnits": 2154,
"totalWorkUnits": 2154,
"result": "<string>",
"resultData": {},
"resultMessage": "<string>",
"actor": "<string>",
"startDate": "<string>",
"finishedDate": "<string>",
"estimatedFinishDate": "<string>"
}Rate this page: