Jump to

• Request
• Response
• Examples

Get archive process details by its archiveGUID

get

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

Request

Path Parameters

• archiveGUID(required): string
  archiveGUID of the process

  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

Successfully retrieved archival process details

Body ()

Root Schema : ArchivalResponse

Type: object

Archival Response Schema

Show Source

• archivedCount: integer
  Example: 100
• archiveGUID: string
  Example: 5289446E-A8AB-4D7D-80F6-A81CE6335522
• archiveName: string
  Example: ARCHIVE_20221103093710
• archiveStatus: string
  Example: COMPLETED
• batchSize: integer
  Example: 100
• createdBy: string
  Example: user
• createdDate: string
  Example: 2016-03-05
• endTime: string
  Example: 2022-11-03T08:07:33.612Z
• entityType: string
  Example: ACTIVITY
• expectedCount: integer
  Example: 100
• startTime: string
  Example: 2022-10-27T05:58:50.621Z

{
    "description":"Archival Response Schema",
    "type":"object",
    "properties":{
        "archiveGUID":{
            "example":"5289446E-A8AB-4D7D-80F6-A81CE6335522",
            "type":"string"
        },
        "archiveName":{
            "example":"ARCHIVE_20221103093710",
            "type":"string"
        },
        "archiveStatus":{
            "example":"COMPLETED",
            "type":"string"
        },
        "archivedCount":{
            "example":100,
            "type":"integer"
        },
        "batchSize":{
            "example":100,
            "type":"integer"
        },
        "createdBy":{
            "example":"user",
            "type":"string"
        },
        "createdDate":{
            "example":"2016-03-05",
            "type":"string"
        },
        "endTime":{
            "example":"2022-11-03T08:07:33.612Z",
            "type":"string"
        },
        "expectedCount":{
            "example":100,
            "type":"integer"
        },
        "startTime":{
            "example":"2022-10-27T05:58:50.621Z",
            "type":"string"
        },
        "entityType":{
            "example":"ACTIVITY",
            "type":"string"
        }
    }
}

404 Response

No archival process details found for the archiveGUID

Back to Top

Examples

This example describes how 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}"

Example Response Body

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

{
    "archiveGUID": "FC07A74B-421B-C8CC-E053-05914C649109",
    "archiveName": "ARCHIVE_20230519071310",
    "archiveStatus": "COMPLETED",
    "archivedCount": 1,
    "batchSize": 2,
    "createdBy": "root",
    "createdDate": "2023-05-19",
    "endTime": "2023-05-19T07:13:11.211Z",
    "entityType": "ACTIVITY",
    "expectedCount": 1,
    "startTime": "2023-05-19T07:13:10.450Z"
}

Back to Top