Retrieve jobs
Use this endpoint to retrieve a paginated list of import and export jobs related to Catalog Connector. The following constraints apply when using the query parameters:
- The query parameter job
ids
can’t be combined with any other query parameters. - The query parameter
inputFileIds
can only be combined with the query parameterlastJobOnly
. - Pagination isn’t supported when
ids
orinputFileIds
is specified.
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.
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 file IDs specified in the request. You can specify up to 15 file IDs separated by commas. - This parameter can only be combined with the query parameter lastJobOnly
. - Pagination isn't supported when this is specified.
A flag indicating whether the response should be based only on the last job. Set it to true
to show response based on the last job and false
to include response based on all jobs that meet the criteria. This is only applicable with type
and inputFileIds
.
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.
Response
The details of the job.
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?