GET
/
catalog-connector-jobs
Retrieve jobs
curl --request GET \
  --url https://api.fabric.inc/v3/catalog-connector-jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>'
{
  "data": [
    {
      "id": "877f1f77bcf86cd799439087",
      "inputFileId": "327f1f77bcf86cd799439045",
      "outputFiles": [
        "507f1f77bcf86cd7994390163, 967f1f77bcf86cd799439058"
      ],
      "errorFiles": [
        "887f1f77bcf86cd799439011, 997f1f77bcf86cd799439074"
      ],
      "progressTracker": {
        "updatedAt": "2023-02-14T22:10:30.618Z",
        "totalCount": 100000,
        "processedCount": 40000,
        "errorCount": 10
      },
      "status": "COMPLETED",
      "statusMessage": "100% completed",
      "additionalDetails": {
        "itemsCreated": 10,
        "itemsUpdated": 10
      },
      "createdAt": "2021-09-14T22:10:30.618Z",
      "completedAt": "2021-09-14T22:10:30.618Z",
      "updatedBy": "test@email.com",
      "updatedAt": "2021-09-14T22:10:30.618Z",
      "type": "CATALOG_CONN_ITEM_VARIANT_IMPORT"
    }
  ],
  "offset": 5,
  "limit": 10,
  "count": 100
}

Authorizations

​
Authorization
string
header
required

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

​
x-fabric-tenant-id
string
required

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.

​
x-fabric-request-id
string

Unique request ID

Query Parameters

​
ids
string

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.
​
type
enum<string>

Specify the type of operation or job performed when the file was uploaded.

Available options:
CATALOG_CONN_ITEM_VARIANT_IMPORT,
CATALOG_CONN_ITEM_VARIANT_EXPORT,
CATALOG_CONN_BUNDLE_IMPORT,
CATALOG_CONN_BUNDLE_EXPORT
Example:

"CATALOG_CONN_ITEM_VARIANT_IMPORT"

​
inputFileIds
string

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.

​
lastJobOnly
boolean

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.

​
offset
integer
default:0

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.

Example:

2

​
limit
integer
default:10

The maximum number of records per page.

Example:

20

Response

200
application/json

OK

The details of the job.