FAfabric
Catalog Connector Jobs

Search jobs

Get a paginated list of jobs related to products and collections by specifying the request body. You need to specify the criteria for the search such as job id, type, status, collectionId, or inputFileId.

post/catalog-connector-jobs/search

Request

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

Request body

sortstring

Sorting criteria. Sorting is supported on id, type, status, completedAt, and createdAt. - refers to descending while + refers to ascending order.

offsetinteger

Number of records to skip before returning records. For example, offset=20, limit=10 returns records 21-30.

limitinteger

Maximum number of records per page.

Example request

{
  "sort": "+id,-type",
  "match": {
    "id": {
      "op": "IN",
      "value": [
        "5f7329dfd5288b0011332366"
      ]
    },
    "inputFileId": {
      "op": "IN",
      "value": [
        "5f7329dfd5288b0011332366"
      ]
    },
    "name": {
      "op": "IN",
      "value": [
        "blue"
      ]
    },
    "keyword": {
      "op": "CONTAINS",
      "value": "blue"
    },
    "type": {
      "op": "IN",
      "value": [
        "CATALOG_CONN_ITEM_VARIANT_IMPORT"
      ]
    },
    "status": {
      "op": "IN",
      "value": [
        "COMPLETED"
      ]
    },
    "createdAt": {
      "op": "RANGE",
      "fromValue": "2022-09-14T22:10:30.618Z",
      "toValue": "2023-04-14T22:10:30.618Z"
    },
    "completedAt": {
      "op": "RANGE",
      "fromValue": "2022-09-14T22:10:30.618Z",
      "toValue": "2023-04-14T22:10:30.618Z"
    }
  },
  "offset": 2,
  "limit": 10
}

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.