Jump to

• Request
• Response
• Examples

Get archive process batch details by its archiveGUID

get

/ArchiveService/api/v1/archives/{archiveGUID}/batches

Request

Path Parameters

• archiveGUID(required): string
  Example:

  5289446E-A8AB-4D7D-80F6-A81CE6335522

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successfull retrieved archival process batch details

Body ()

Root Schema : BatchResponse

Type: array

Archival Batch Response Schema

Show Source

• Array of: object items

{
    "description":"Archival Batch Response Schema",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "archiveGUID":{
                "example":"5289446E-A8AB-4D7D-80F6-A81CE6335522",
                "type":"string"
            },
            "batchID":{
                "example":100,
                "type":"integer"
            },
            "batchStatus":{
                "example":"COMPLETED",
                "type":"string"
            },
            "createdDate":{
                "example":"2016-03-05",
                "type":"string"
            },
            "endTime":{
                "example":"2022-11-03",
                "type":"string"
            },
            "startTime":{
                "example":"2022-11-03",
                "type":"string"
            },
            "failedEntities":{
                "type":"array",
                "items":{
                    "$ref":"#/components/schemas/ArchivalBatchEntityResponse"
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• archiveGUID: string
  Example: 5289446E-A8AB-4D7D-80F6-A81CE6335522
• batchID: integer
  Example: 100
• batchStatus: string
  Example: COMPLETED
• createdDate: string
  Example: 2016-03-05
• endTime: string
  Example: 2022-11-03
• failedEntities: array failedEntities
• startTime: string
  Example: 2022-11-03

{
    "type":"object",
    "properties":{
        "archiveGUID":{
            "example":"5289446E-A8AB-4D7D-80F6-A81CE6335522",
            "type":"string"
        },
        "batchID":{
            "example":100,
            "type":"integer"
        },
        "batchStatus":{
            "example":"COMPLETED",
            "type":"string"
        },
        "createdDate":{
            "example":"2016-03-05",
            "type":"string"
        },
        "endTime":{
            "example":"2022-11-03",
            "type":"string"
        },
        "startTime":{
            "example":"2022-11-03",
            "type":"string"
        },
        "failedEntities":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ArchivalBatchEntityResponse"
            }
        }
    }
}

Nested Schema : failedEntities

Type: array

Show Source

• Array of: array ArchivalBatchEntityResponse
  Archival Batch Entity Response Schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ArchivalBatchEntityResponse"
    }
}

Nested Schema : ArchivalBatchEntityResponse

Type: array

Archival Batch Entity Response Schema

Show Source

• Array of: object items

{
    "description":"Archival Batch Entity Response Schema",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "entityGuid":{
                "type":"string",
                "example":"E2AA95FE-67DA-49F4-8903-EA37D5405BB7"
            },
            "status":{
                "type":"string",
                "example":"COMPLETED"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• entityGuid: string
  Example: E2AA95FE-67DA-49F4-8903-EA37D5405BB7
• status: string
  Example: COMPLETED

{
    "type":"object",
    "properties":{
        "entityGuid":{
            "type":"string",
            "example":"E2AA95FE-67DA-49F4-8903-EA37D5405BB7"
        },
        "status":{
            "type":"string",
            "example":"COMPLETED"
        }
    }
}

404 Response

No archival process batch details found for the archiveGUID

Back to Top

Examples

This example describes how to the service will provide all the batch details of an Archival job.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl \
  -X GET \
  -H "Content-Type: application/json" \
  -u 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
  -L "http://server:port/ArchiveService/api/v1/archives/{archiveGUID}/batches"

Example Response Body

The following shows an example of the response body in JSON format:

[
    {
        "archiveGUID": "E28FAF74-7971-4169-8A46-2ED526A7037C",
        "batchID": 1,
        "batchStatus": "FAILED",
        "createdDate": "2023-06-06",
        "endTime": "2023-06-06T09:40:37.199Z",
        "failedEntities": [
            {
                "entityGuid": "62946103-F951-444F-B4BA-1D2D32B1D584",
                "status": "FAILED"
            }
        ],
        "startTime": "2023-06-06T09:40:37.117Z"
    },
    {
        "archiveGUID": "E28FAF74-7971-4169-8A46-2ED526A7037C",
        "batchID": 2,
        "batchStatus": "COMPLETED",
        "createdDate": "2023-06-06",
        "endTime": "2023-06-06T09:40:37.288Z",
        "failedEntities": [],
        "startTime": "2023-06-06T09:40:37.203Z"
    }
]

Back to Top