Jump to

• Request
• Response

Read Archived Items Bulk Restore Operation Status

get

/content/management/api/v1.1/archive/items/.bulk/restore/{statusId}

Read Archived Items Bulk Restore Operation status.

Request

Path Parameters

• statusId: string
  status id of the bulk items operations.

Query Parameters

• links(optional): string
  This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : ArchiveItemsJobStatus

Type: object

ArchiveItemsJobStatus

Show Source

• completed(optional): boolean
  Whether the original request is completed or not
• completedPercentage(optional): integer(int32)
  A number between 0 and 100, capturing how much of the process has been completed.
• endTime(optional): object date
  date
• error(optional): object Error
  Error
• id(optional): string
  status id of the original request. It is a required property in the get response.
• links(optional): array links
  links of the status resource
• message(optional): string
  Human readable message about the current processing status
• progress(optional): string
  Allowed Values: [ "succeeded", "failed", "processing", "pending", "aborted", "paused", "blocked" ]

  The current progress of the original request. It is a required property in the get response.
• requestStatus(optional): integer(int32)
  HTTP status code of the original request. This is not the polling request's status. Value is available only after the request is completed
• result(optional): object ResultBulkItemsArchive
  Result
• startTime(optional): object date
  date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"status id of the original request. It is a required property in the get response."
        },
        "startTime":{
            "description":"Time when the original request started",
            "$ref":"#/definitions/date"
        },
        "endTime":{
            "description":"Time when the original request ended",
            "$ref":"#/definitions/date"
        },
        "progress":{
            "type":"string",
            "description":"The current progress of the original request. It is a required property in the get response.",
            "enum":[
                "succeeded",
                "failed",
                "processing",
                "pending",
                "aborted",
                "paused",
                "blocked"
            ]
        },
        "completed":{
            "type":"boolean",
            "description":"Whether the original request is completed or not"
        },
        "message":{
            "type":"string",
            "description":"Human readable message about the current processing status"
        },
        "completedPercentage":{
            "type":"integer",
            "format":"int32",
            "description":"A number between 0 and 100, capturing how much of the process has been completed."
        },
        "requestStatus":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code of the original request. This is not the polling request's status. Value is available only after the request is completed"
        },
        "result":{
            "description":"The response when the original async request finishes",
            "$ref":"#/definitions/ResultBulkItemsArchive"
        },
        "error":{
            "description":"contains error detail of the original request. This is only available when the original request is processed and failed",
            "$ref":"#/definitions/Error"
        },
        "links":{
            "type":"array",
            "description":"links of the status resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ArchiveItemsJobStatus"
}

Nested Schema : date

Type: object

date

Show Source

• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"date"
}

Nested Schema : Error

Type: object

Error

Show Source

• detail(optional): string
  Detailed error message.
• instance(optional): string
  URI to the link that provides more detail about the error.
• o:errorCode(optional): string
  Application specific error code.
• o:errorDetails(optional): object Error
  Error
• o:errorPath(optional): string
  XPath or JSON patch to indicate where the error occurs.
• status(optional): integer(int32)
  HTTP status code.
• title(optional): string
  Summary error message. It is a required property in the get response.
• type(optional): string
  Link to HTTP error code page. It is a required property in the get response.

{
    "type":"object",
    "properties":{
        "title":{
            "type":"string",
            "description":"Summary error message. It is a required property in the get response."
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code."
        },
        "type":{
            "type":"string",
            "description":"Link to HTTP error code page. It is a required property in the get response."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application specific error code."
        },
        "o:errorDetails":{
            "description":"Drill down to the details. Multiple errors can be organized in a hierarchical structure.",
            "$ref":"#/definitions/Error"
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON patch to indicate where the error occurs."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        }
    },
    "description":"Error"
}

Nested Schema : links

Type: array

links of the status resource

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"links of the status resource",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : ResultBulkItemsArchive

Type: object

Result

Show Source

• body(optional): object BulkItemsArchive
  Item Bulk Archive
• headers(optional): array headers
  List of the HTTP headers of the response to the original async request
• status(optional): object ResultHTTPStatus
  ResultHTTPStatus

{
    "type":"object",
    "properties":{
        "status":{
            "description":"HTTP status line of the response to the original async request",
            "$ref":"#/definitions/ResultHTTPStatus"
        },
        "headers":{
            "type":"array",
            "description":"List of the HTTP headers of the response to the original async request",
            "items":{
                "$ref":"#/definitions/ResultHTTPHeader"
            }
        },
        "body":{
            "description":"HTTP body of the response to the original async request",
            "$ref":"#/definitions/BulkItemsArchive"
        }
    },
    "description":"Result"
}

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.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

Nested 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"

{
    "type":"object",
    "properties":{
        "q":{
            "type":"string",
            "example":"id eq \"COREBE1BDF66159849B790CC9ACE49BD2199\" OR id eq \"CONT22AA154CDD884D81A3678E1BD37333B7\"",
            "description":"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 <b><i>id eq \"{itemId}\"</i></b>. 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."
        },
        "items":{
            "type":"array",
            "description":"archiving items list",
            "items":{
                "$ref":"#/definitions/ItemId"
            }
        },
        "failedItems":{
            "type":"array",
            "description":"items on which the action failed",
            "items":{
                "$ref":"#/definitions/FailedItemIdWithErrorCode"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the bulk items operations resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item Bulk Archive"
}

Nested Schema : headers

Type: array

List of the HTTP headers of the response to the original async request

Show Source

• Array of: object ResultHTTPHeader
  ResultHTTPHeader

{
    "type":"array",
    "description":"List of the HTTP headers of the response to the original async request",
    "items":{
        "$ref":"#/definitions/ResultHTTPHeader"
    }
}

Nested Schema : ResultHTTPStatus

Type: object

ResultHTTPStatus

Show Source

• code(optional): integer(int32)
  HTTP response status code
• reason(optional): string
  HTTP response reason phrase

{
    "type":"object",
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP response status code"
        },
        "reason":{
            "type":"string",
            "description":"HTTP response reason phrase"
        }
    },
    "description":"ResultHTTPStatus"
}

Nested Schema : failedItems

Type: array

items on which the action failed

Show Source

• Array of: object FailedItemIdWithErrorCode

{
    "type":"array",
    "description":"items on which the action failed",
    "items":{
        "$ref":"#/definitions/FailedItemIdWithErrorCode"
    }
}

Nested Schema : items

Type: array

archiving items list

Show Source

• Array of: object ItemId

{
    "type":"array",
    "description":"archiving items list",
    "items":{
        "$ref":"#/definitions/ItemId"
    }
}

Nested Schema : links

Type: array

Links of the bulk items operations resource.

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links of the bulk items operations resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : FailedItemIdWithErrorCode

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "name":{
            "type":"string",
            "description":"name of the item."
        },
        "links":{
            "type":"array",
            "description":"links of the item resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "message":{
            "type":"string",
            "description":"failed item message."
        }
    }
}

Nested Schema : links

Type: array

links of the item resource

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"links of the item resource",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : ItemId

Type: object

Show Source

• id(optional): string
  id of the item.
• links(optional): array links
  links of the item resource
• name(optional): string
  name of the item.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "name":{
            "type":"string",
            "description":"name of the item."
        },
        "links":{
            "type":"array",
            "description":"links of the item resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

links of the item resource

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"links of the item resource",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : ResultHTTPHeader

Type: object

ResultHTTPHeader

Show Source

• name(optional): string
  HTTP response header name
• value(optional): string
  HTTP response header value

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"HTTP response header name"
        },
        "value":{
            "type":"string",
            "description":"HTTP response header value"
        }
    },
    "description":"ResultHTTPHeader"
}

304 Response

Not modified.

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

500 Response

Internal server error.

Back to Top