Retrieve import and export history
Use this endpoint to access files previously imported to or exported from the Catalog Connector, sorted in chronological order. You can refine the search results by using the following query parameters:
ids: Provide a comma-separated list of file IDs to retrieve multiple files by their IDs. Note that pagination isn’t supported when using this parameter.- Format type (
formatType) : Specify the format of the file to filter files by format. The options are CSV or JSONL. - Operation type (
type): Use this parameter to specify whether you want imported or exported files. - Pagination (
offset,limit): Use offset and limit parameters to refine the number of results returned. sort: Use this parameter to view results in ascending or descending order. If no query parameters are specified, the endpoint returns up to 10 records.
Authorizations
This is the authorization token used to authenticate the request. You must pass the access token generated from the system app. For more information, see the Making your first API request section.
Headers
A header retrieved from your Copilot Account Details that's used by the API to identify the tenant making the request. Tenant ID must be included in the authentication header for API requests to access any of fabric’s endpoints.
Unique request ID
Query Parameters
The 24-character system-generated file ID created using the Create a File endpoint.
Depending on the type of IDs, the array represents the file IDs or job IDs. Specify up to 15 IDs separated by commas. Note the following limitations of using this parameter:
- This parameter can't be combined with any other parameters.
- Pagination isn't supported when this parameter is specified.
Use this endpoint to specify the name of the file you want to retrieve.
Depending on the context, it represents the format of the file or template.
csv, jsonl Specify the type of operation or job performed when the file was uploaded.
CATALOG_CONN_ITEM_VARIANT_IMPORT, CATALOG_CONN_ITEM_VARIANT_EXPORT, CATALOG_CONN_BUNDLE_IMPORT, CATALOG_CONN_BUNDLE_EXPORT The number of records to skip before returning records. For example, with an offset of 20 and limit of 10, the system returns records from 21 to 30.
The maximum number of records per page.
The sorting criteria. Currently, the supported values are updatedAt and name. Use - for descending order and + for ascending.
Response
The response of the Retrieve import or export history request, along with pagination data.
The number of records to skip before returning records. For example, when the offset is 20 and limit is 10, the system returns the records from 21 to 30.
The maximum number of records per page.
The total number of records.
Was this page helpful?