Retrieve a Holdings Data Export Record

After you have either created a new holdings data export or retrieved the details of a previously created export, you need to retrieve the export record.

To Retrieve the Holdings Data Export Record (example):

Gather the following information for the request:

• The export id of the holdings data.

Request

GET https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/exports/{exportid}

Response

200 OK


{
  "id": "096dea08-c57e-4dc5-a984-51a94afff2",
  "type": "STANDARD",
  "fileName": "testExport_standard_csv",
  "status": "COMPLETED",
  "created": "2023-06-01T19:31:40.241Z",
  "format": "CSV",
  "links": [
    {
      "href": "https://s3.amazonaws.com/cdn.hhm.ebsco.com/testid/096dea08-c57e-4dc5-a984-51a94a30fff2/testExport_standard_csv?response-content-disposition=attachment%3B%20filename%3D%22testExport_standard_csv.csv%22%3B&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEIz%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJIMEYCIQCskpH4pByB%2Bm%2FP2fua5wzyB82UXZQ5yhDYY9ElO%2FKQIhAN9n83O6JCxI15DGh695wQrXdNpqK6czz%2BFlUVMhAUUnKo4FCMX%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQBBoMNjA0MTY2NTIxMzA3IgxN6Of%2Bj9PEFdNoAAcq4gTlsq0keJGhwE8WmDBd%2BK2K6Oh0acpAE9%2F4fW%2BL3yaLHwf7TT%2BBluU9VFFXYj6H0WILz2SWovjlUxb9wVxR00EmEZvKGPFv2rjZfURW3XCCEYFSvzg5PpwBTZuRx5zZHZ1%2BeGDaU26APjpPjdoQfMlSB%2F3G8QAS0hJV2pYdemY1sbo8EKR57xYjzqIsb36C0UxTg4HwI%2wJWwETGV4VczH7s4NW1AqnbeGcfZmhy%2Bn7UzgV4ISFmC74S8r%2FmCk%2FjNGleRg%2FSMOILes4yFGQk%2BEJ82iB9GQ1UbOFuBdOfaegE4iHRKzKCmqhEcHkmTVrX5vsKoJqKjBi2hluYBUutGtGFCdUTvD9%2BbvpuE9TIIgZkqa6PHcYKNoUsTqNkfoPNXnamIgGytFPNjoHOsOvFfgEpN2lmTj4hAIYYN7cx2doaPlQrSRrSOU6wZFBr0sK0d4t1ICtDDSv8MMrNe6FgWwxXjMKvp%2FsLLy0vLVrpniAtVhh0ofryyyfOgbPjZl5%2FmJJV7aIbnmpHvQXXUkiNuo0qicnTVIvgphioNLhq0DRQSPBdyt35nl06ejQJ%2FH367XfezlXtcNIhw98J2x7GS3gZzH2v8QMkigZ%2Fx2jWCw4RzGIVixD8w4NGcdraj0vhBcs7TIH8eWEWLj7Chw7XGeQ5fo4gJ6MxsiUzxYdWVOlUjCGQG1vnSn6AEK5TnGYYQn8Ao6zNQRLQL0LVuKIw64QZuWptLqeWNlnjEnuqBbNKYttsjRaqeki3j9RTNN09KiGqNK0D0Z3s4RRMQaHta42MNwexjzKulEGPdbLMOvt46MGOpkBbqi7YXGV5VeubNZZpJF7WPVNYeTQg1UOPT4MacxJOvPekE0uX46Cv5MHViNBS3ZKKitKa5FWyeQg2mv%2BoCWJFTMH%2Ba4IfIHUCTiam8ePAtnOoUEmbNRELCrWA%2Fc3Q%2FZoU4M5PqaFOhci4yK8jrupcCa5OwScXdsZ2p5Z5XbM2Wkk4hJMzUbJQxqZ%2BwxQNmtDvKCUlVnOS&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230601T195211Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=ASIAYZKZBQHN5YM5EI6H%2F20230601%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=ea94d56886d3b8053a074dd5ed8dd0dced742092e8f026368bcc84aa11b03b1",
      "rel": "download"
    }
  ],
  "size": 2386715,
  "customerHoldingsCounts": {
    "totalResourceCount": "4612",
    "managedResourceCount": "4604",
    "customResourceCount": "8",
    "totalManagedPackageCount": "16",
    "totalCustomPackageCount": "3",
    "uniqueResourceCount": "4582",
    "uniqueManagedResourceCount": "4574",
    "uniqueCustomResourceCount": "8"
  }
}

If the “status” element in the response is “COMPLETED”, the customer holdings data has been populated and the customer holdings are ready to be downloaded.

For more information on the GET Export by Export ID resource, please refer to our API reference documentation.