• Approval
  • Customer
  • Customer Request
  • Customer Transition
  • Jira Service Management Application
  • Organization
  • Organization Service Desk
  • Portals
  • Queue
  • Queue Settings
  • Request Attachment
  • Request Type
  • Request Type Permissions
  • Service Desk
  • Service Desk Customer
  • application-properties
  • applicationrole
  • attachment
  • avatar
  • cluster
  • comment
  • component
  • configuration
  • customFieldOption
  • customFields
  • dashboard
  • email-templates
  • field
  • filter
  • group
  • groups
  • groupuserpicker
  • index
  • index-snapshot
  • issue
  • issueLinkType
  • issuesecurityschemes
  • issuetype
  • issuetypescheme
  • jql
  • licenseValidator
  • monitoring
  • mypermissions
  • mypreferences
  • myself
  • notificationscheme
  • password
  • permissions
  • permissionscheme
  • priority
  • priorityschemes
  • project
  • projectCategory
  • projects
  • projectvalidate
  • reindex
  • resolution
  • role
  • screens
  • securitylevel
  • serverInfo
  • session
  • settings
  • status
  • statuscategory
  • terminology
  • universal_avatar
  • upgrade
  • user
  • version
  • websudo
  • workflow
  • workflowscheme
  • worklog
  • Assets - AQL
  • Assets - Analytics
  • Assets - Archived Objects
  • Assets - Attachments
  • Assets - Comments
  • Assets - Icons
  • Assets - Index Configuration
  • Assets - Object
  • Assets - Object Archive
  • Assets - Object Attribute
  • Assets - Object Connected Tickets
  • Assets - Object Restore
  • Assets - Object Schema
  • Assets - Object Type
  • Assets - Object Type Attribute
  • Assets - Progress
  • Assets - QR Code
  • Assets - Status Types
Server
Jira Service Management / Reference / REST API

Assets - Object Archive

Postman Collection
OpenAPI
PUT

Archive object

Archive the referenced object.

Request

Path parameters

objectIdentifier

string

Required

Responses

Returns the archived object.

application/json

ObjectEntry
PUT/assets/1.0/object/archive/{objectIdentifier}
1 2 3 curl --request PUT \ --url 'http://{baseurl}/rest/assets/1.0/object/archive/{objectIdentifier}' \ --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 { "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 }
POST

Bulk archive objects by filter

Bulk archive objects of an object type by filter.

Request

Query parameters

typeId

string

Request bodyapplication/json

The filter to use for archiving objects.

objectSchemaId

integer

qlQuerySearch

boolean

qlQueryParams

ObjectIQLFilterParamEntry

filterParams

ObjectFilterParamsEntry

iqlSearch

boolean

iqlParams

ObjectIQLFilterParamEntry

Responses

Returns the progress of the bulk archive operation.

application/json

ProgressOutEntry