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, inputFileId.

Authorizations

Authorization

string

header

required

S2S access token (JWT) from fabric Identity service (during login)

Headers

x-fabric-tenant-id

string

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-request-id

string

Unique request ID

Body

application/json

Request for a job search.

match

object

required

Search criteria to match jobs.

Show child attributes

match.completedAt

object

Search based on job completion Time

• Option 1
• Option 2
• Option 3

Show child attributes

match.completedAt.fromValue

string

required

Starting range (UTC)

match.completedAt.op

enum<string>

required

Search operation performed on a date range

Available options:

RANGE

match.completedAt.toValue

string

required

Ending range (UTC)

match.createdAt

object

Search based on job creation time

• Option 1
• Option 2
• Option 3

Show child attributes

match.createdAt.fromValue

string

required

Starting range (UTC)

match.createdAt.op

enum<string>

required

Search operation performed on a date range

Available options:

RANGE

match.createdAt.toValue

string

required

Ending range (UTC)

match.id

object

job id search

Show child attributes

match.id.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

match.id.value

string[]

required

match.inputFileId

object

Search based on input file ID

Show child attributes

match.inputFileId.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

match.inputFileId.value

string[]

required

match.keyword

object

Search based on either job name or job ID

• Option 1
• Option 2

Show child attributes

match.keyword.op

enum<string>

required

Search operation that can be performed on a string type

Available options:

CONTAINS

match.keyword.value

string

required

Sample string schema

match.name

object

Search based on job name

• Option 1
• Option 2

Show child attributes

match.name.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

match.name.value

string[]

required

match.status

object

Search based on job status

Show child attributes

match.status.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

match.status.value

enum<string>[]

required

Available options:

SCHEDULED,

COMPLETED_PARTIALLY,

IN_PROGRESS,

COMPLETED,

FAILED,

UPDATING_SEARCH_INDEX,

CANCELLATION_IN_PROGRESS,

CANCELLED

match.type

object

Search based on job type

Show child attributes

match.type.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

match.type.value

enum<string>[]

required

Available options:

ITEM_VARIANT_EXPORT,

ITEM_VARIANT_IMPORT,

BUNDLE_EXPORT,

BUNDLE_IMPORT,

ATTRIBUTE_IMPORT,

ATTRIBUTE_EXPORT,

CATEGORY_IMPORT,

CATEGORY_EXPORT,

COLLECTION_IMPORT,

COLLECTION_EXPORT,

ATTRIBUTE_JOB,

PRODUCT_JOB,

CATEGORY_JOB,

COLLECTION_JOB,

PRODUCT_BULK_CATEGORY_UPDATE,

PRODUCT_DENORM_JOB

limit

integer

default:

10

Maximum number of records per page

offset

integer

default:

0

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

sort

string

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

Response

200 - application/json

Details of jobs

count

integer

Total number of records

data

object[]

Show child attributes

data.additionalDetails

object

Show child attributes

data.additionalDetails.attributeCreated

integer

Number of attributes created. Only applicable when the job type is ATTRIBUTE_IMPORT.

data.additionalDetails.attributeUpdated

integer

Number of attributes updated. Only applicable when the job type is ATTRIBUTE_IMPORT.

data.additionalDetails.bundlesCreated

integer

Number of bundles created. Only applicable when the job type is BUNDLE_IMPORT.

data.additionalDetails.bundlesUpdated

integer

Number of bundles updated. Only applicable when the job type is BUNDLE_IMPORT.

data.additionalDetails.categoriesCreated

integer

Number of categories created. Only applicable when the job type - CATEGORY_IMPORT.

data.additionalDetails.categoriesUpdated

integer

Number of categories updated. Only applicable when the job type is CATEGORY_IMPORT.

data.additionalDetails.collectionCreated

integer

Number of collections created. Only applicable when the job type is COLLECTION_IMPORT.

data.additionalDetails.collectionUpdated

integer

Number of collections updated. Only applicable when the job type is COLLECTION_IMPORT.

data.additionalDetails.itemsCreated

integer

Number of items created. Only applicable when the job type is ITEM_VARIANT_IMPORT.

data.additionalDetails.itemsUpdated

integer

Number of items updated. Only applicable when the job type is ITEM_VARIANT_IMPORT.

data.additionalDetails.variantsCreated

integer

Number of variants created. Only applicable when the job type is ITEM_VARIANT_IMPORT.

data.additionalDetails.variantsUpdated

integer

Number of variants updated. Only applicable when the job type is ITEM_VARIANT_IMPORT.

data.completedAt

string

Time of job completion (UTC)

data.createdAt

string

Time of job creation (UTC)

data.errorFiles

string[]

data.id

string

24-character system-generated job ID

data.inputFileId

string

File ID that needs to be processed through the job

data.outputFiles

string[]

data.progressTracker

object

Show child attributes

data.progressTracker.errorCount

integer

Total number of errors

data.progressTracker.processedCount

integer

Total number of records to be processed

data.progressTracker.totalCount

integer

Total number of records to be processed through the job

data.progressTracker.updatedAt

string

Time of last update to tracker (UTC)

data.status

enum<string>

Job status

Available options:

SCHEDULED,

COMPLETED_PARTIALLY,

IN_PROGRESS,

COMPLETED,

FAILED,

UPDATING_SEARCH_INDEX,

CANCELLATION_IN_PROGRESS,

CANCELLED

data.statusMessage

string

User-friendly message corresponding to the current job status

data.type

Supported job types

Available options:

ITEM_VARIANT_EXPORT,

ITEM_VARIANT_IMPORT,

BUNDLE_EXPORT,

BUNDLE_IMPORT,

ATTRIBUTE_IMPORT,

ATTRIBUTE_EXPORT,

CATEGORY_IMPORT,

CATEGORY_EXPORT,

COLLECTION_IMPORT,

COLLECTION_EXPORT,

ATTRIBUTE_JOB,

PRODUCT_JOB,

CATEGORY_JOB,

COLLECTION_JOB,

PRODUCT_BULK_CATEGORY_UPDATE,

PRODUCT_DENORM_JOB

data.updatedAt

string

Time of last update to job (UTC)

data.updatedBy

string

Email of the user who last updated the job

limit

integer

default:

10

Maximum number of records per page

offset

integer

default:

0

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