Create Export Request

post

https://sandbox.ebsco.io/rm/rmaccounts/{custid}/exports

This operation enables customers to request an export file of their holdings in one of four formats: "COST", "HoldingsEvent", "KBART2" or "STANDARD". Export files will be generated with the most up-to-date holdings information available; however, any changes made to holdings after the request is made may not be reflected in the export. Export files will be deleted after 365 days. Customers are limited to a maximum of 500 export files.

Please Note: You will need an API key to gain access to the API through our interactive documentation. If you require an API key, please contact EBSCO customer support.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

custid

string

required

EBSCO Customer ID

Body Params

Export Request for a given type and format with a provided filename followed by optional parameters associated to the particular export type requested.

Export

costDownload

object

Cost Download Request Parameters

fileName

string

The filename of the export when downloaded.

format

string

enum

Specifies file format type. Valid values by export type are as follows: Standard exports: TSV, CSV; KBART2 exports: TSV, CSV; HoldingsEvent Exports: CSV, XLSX; COST Exports: CSV.

Allowed:

holdingsEvent

object

Holdings Event Request Parameters

managedOrCustom

string

enum

Limiter to managed holdings, custom holdings or both. (MANAGED_AND_CUSTOM, MANAGED, CUSTOM)

Allowed:

noteIds

array of strings

Export file note id.

noteIds

orderedThroughEbsco

boolean

Limiter to include only records associated with an EBSCO order.

packageContentTypes

array of strings

List of package content types.

packageContentTypes

packageIds

array of strings

List of package ids used as limiters in the export file.

packageIds

resourceTypes

array of strings

List of resource types used as limiters for records in the export file. (JOURNALS, NEWSLETTERS, REPORTS, PROCEEDINGS, WEB_SITES, NEWSPAPER, UNSPECIFIED, BOOK,BOOK_SERIES, DATABASE, THESIS_DISSERTATION, STREAMING_AUDIO, STREAMING_VIDEO, AUDIO_BOOK)

resourceTypes

type

string

enum

File format of the holdings snapshot. Allowed values (STANDARD, KBART2, HoldingsEvent, COST)

Allowed:

Headers

x-api-key

string

required

Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. You will need an API key to use the interactive documentation. If you require an API key, please contact EBSCO customer support.

Responses

202Accepted

defaultUnexpected Error