Performs Bulk Items Archive Operation
post
/content/management/api/v1.1/bulkItemsOperations/archive
Performs bulk items archive operation with given payload.
Request
Supported Media Types
- application/json
Header Parameters
-
Prefer(optional): string
This parameter is used to control the interaction type (synchronous/asynchronous) of the request. If the header is provided with value respond-async, it indicates that asynchronous interaction is preferred. Otherwise, synchronous interaction is preferred. Asynchronous request is responded with 202 status with a status link in the location header. Synchronous request is responded with 200 along with response body.Allowed Values:
[ "respond-async" ]
-
X-Requested-With: string
A custom header to mitigate CSRF attacks.Allowed Values:
[ "XMLHttpRequest" ]
Details of the bulk items archive.
Root Schema : BulkItemsArchive
Type:
object
Item Bulk Archive
Show Source
-
failedItems(optional):
array failedItems
items on which the action failed
-
items(optional):
array items
archiving items list
-
links(optional):
array links
Links of the bulk items operations resource.
-
q(optional):
string
This parameter accepts a query expression condition that matches the field values. Many such query conditions can be joined using OR operators. The value of query condition follows the format of id eq "{itemId}". Query condition on any item field other than id is not supported. Any operator other than eq (Equals) in the query condition is not supported.Example:
id eq "COREBE1BDF66159849B790CC9ACE49BD2199" OR id eq "CONT22AA154CDD884D81A3678E1BD37333B7"
Nested Schema : links
Type:
array
Links of the bulk items operations resource.
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : FailedItemIdWithErrorCode
Type:
Show Source
object
-
id(optional):
string
id of the item.
-
links(optional):
array links
links of the item resource
-
message(optional):
string
failed item message.
-
name(optional):
string
name of the item.
Nested Schema : links
Type:
array
links of the item resource
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : Link
Type:
object
Link of the resource.
Show Source
-
href(optional):
string
The target resource's URI. It could be template URI. It is a required property in the get response.
-
mediaType(optional):
string
Media type.
-
method(optional):
string
What HTTP method can be used to access the target resource.
-
profile(optional):
string
Link to the metadata that describes the target resource.
-
rel(optional):
string
Relation type. It is a required property in the get response.
-
templated(optional):
boolean
Whether the URI is a template.
Nested Schema : ItemId
Type:
Show Source
object
-
id(optional):
string
id of the item.
-
links(optional):
array links
links of the item resource
-
name(optional):
string
name of the item.
Nested Schema : links
Type:
array
links of the item resource
Show Source
-
Array of:
object Link
Link of the resource.
Response
Supported Media Types
- application/json
202 Response
Accepted.
304 Response
Not modified.
400 Response
Bad request.
403 Response
Forbidden.
404 Response
Not found.
500 Response
Internal server error.