--- title: "Search jobs" method: POST path: "/catalog-connector-jobs/search" tags: ["Catalog Connector Jobs"] --- # Search jobs `POST /catalog-connector-jobs/search` ## Request - Base URL: `https://api.fabric.inc/v3` - URL: `https://api.fabric.inc/v3/catalog-connector-jobs/search` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) 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`. ## Headers - `x-fabric-tenant-id` string, required - `x-fabric-request-id` string ## Request body - object: Request for a job search. - `sort` string: Sorting criteria. Sorting is supported on `id`, `type`, `status`, `completedAt`, and `createdAt`. `-` refers to descending while `+` refers to ascending order. - `match` JobSearchRequestMatch, required: Search criteria to match jobs. - `id` SimpleMultiIdSearchOperation: A simple multi-string search operation. - `op` 'IN', required: Operations that can be performed on a `string` type. - `value` Id[], required - `inputFileId` SimpleMultiIdSearchOperation: A simple multi-string search operation. - `op` 'IN', required: Operations that can be performed on a `string` type. - `value` Id[], required - `name` union: String search - object: Simple multi-string search. - `op` 'IN', required: Operations that can be performed on a `string` type. - `value` StringSchema[], required - object: An operation used to define string search. - `op` 'CONTAINS', required: Search operation that can be performed on a `string` type. - `value` string, nullable, required: Represents a string schema. - `keyword` union: Search based on either job name or job ID - ContainsStringSearchOperation: An operation used to define string search. - `op` 'CONTAINS', required: Search operation that can be performed on a `string` type. - `value` string, nullable, required: Represents a string schema. - SimpleMultiStringSearchOperation: Simple multi-string search. - `op` 'IN', required: Operations that can be performed on a `string` type. - `value` StringSchema[], required - `type` MultiJobType: Search jobs using multiple job types. For example, `ITEM_VARIANT_IMPORT, BUNDLE_EXPORT`. - `op` 'IN', required: Operations that can be performed on a `string` type. - `value` ProductFileJobTypes[], required - `status` MultiJobStatuses: Search jobs using multiple job types. For example, `COMPLETED' or 'SCHEDULED`. - `op` 'IN', required: Operations that can be performed on a `string` type. - `value` JobStatuses[], required - `createdAt` union: Date-time search - object: The search criteria based on date range. - `op` 'RANGE': The type of search operation. - `fromValue` string: The start date for searching, in UTC format. - `toValue` string: The end date for searching, in UTC format. - object: The search criteria based on date-time using the IN condition. - `op` 'IN': The type of search operation. - `value` string[]: The timestamp to search. - object: The search criteria based on date-time. - `op` 'EQUALS' | 'LTE' | 'GTE' | 'LT' | 'GT': The type of search operation. - `value` string: The timestamp to be searched, in UTC format. - `completedAt` union: Date-time search - object: The search criteria based on date range. - `op` 'RANGE': The type of search operation. - `fromValue` string: The start date for searching, in UTC format. - `toValue` string: The end date for searching, in UTC format. - object: The search criteria based on date-time using the IN condition. - `op` 'IN': The type of search operation. - `value` string[]: The timestamp to search. - object: The search criteria based on date-time. - `op` 'EQUALS' | 'LTE' | 'GTE' | 'LT' | 'GT': The type of search operation. - `value` string: The timestamp to be searched, in UTC format. - `offset` integer: Number of records to skip before returning records. For example, `offset=20, limit=10` returns records 21-30. - `limit` integer: Maximum number of records per page. ## Response `200` OK - ProductJob: The details of the job. - `data` Job[] - `id` string: The 24-character system-generated file ID created using the [Create a File](/v3/api-reference/catalog-connector/files/create-file) endpoint. - `inputFileId` string: The IDs of the files to be processed as part of the job. - `outputFiles` string[]: The IDs of the processed files. The output files include success files, error files, and more. - `errorFiles` string[]: The IDs of the processed files. The output files include success files, error files, and more. - `progressTracker` object - `updatedAt` string: The time when the tracker was last updated, in UTC format. - `totalCount` integer: The total number of records to be processed through the job. - `processedCount` integer: The total number of records processed. - `errorCount` integer: Total number of records with error. - `status` 'IN_PROGRESS' | 'COMPLETED' | 'FAILED': The job status. - `statusMessage` string: A brief message corresponding to the job `status`. - `additionalDetails` object - `itemsCreated` integer: The number of items created during the import process. Only applicable when job `type` is `PRODUCT_IMPORT`. - `itemsUpdated` integer: The number of items updated during the import process. Only applicable when job `type` is `PRODUCT_IMPORT`. - `createdAt` string: The time of job creation, in UTC format. - `completedAt` string: The time of job completion, in UTC format. - `updatedBy` string: The email of the user who last updated the job. - `updatedAt` string: The time when the job was last updated, in UTC format. - `offset` integer: 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. - `limit` integer: The maximum number of records per page. - `count` integer: The total number of records. ## Other responses - `400`: Request is invalid or malformed - `401`: The requester is unauthorized. - `403`: The user isn't allowed to perform this action. - `500`: Internal server error --- [API](https://skmtc.dev/fabric/apis/catalog-connector.md) - [All operations](https://skmtc.dev/fabric/apis/catalog-connector/llms.txt) - [OpenAPI document](https://skmtc.dev/fabric/apis/catalog-connector/revisions/878ef9866561?raw)