FAfabric
Catalog Connector Jobs

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 parameter lastJobOnly.
  • Pagination isn't supported when ids or inputFileIds is specified.
get/catalog-connector-jobs

Request

Query parameters

idsstring

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'CATALOG_CONN_ITEM_VARIANT_IMPORT' | 'CATALOG_CONN_ITEM_VARIANT_EXPORT' | 'CATALOG_CONN_BUNDLE_IMPORT' | 'CATALOG_CONN_BUNDLE_EXPORT'

Specify the type of operation or job performed by uploading the file.

Example:CATALOG_CONN_ITEM_VARIANT_IMPORT

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

inputFileIdsstring

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.

lastJobOnlyboolean

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.

offsetinteger
Example:2

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.

limitinteger
Example:20

The maximum number of records per page.

Headers

x-fabric-tenant-idstring 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-idstring

Unique request ID

Response

OK

offsetinteger

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.

limitinteger

The maximum number of records per page.

countinteger

The total number of records.

Example response

{
  "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"
    }
  ],
  "offset": 5,
  "limit": 10,
  "count": 100
}

Changes

No recorded changes to this operation across all 1 revision of this API.