Skip to main content
POST
Search Overrides

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-fabric-tenant-id
string
required

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

x-fabric-channel-id
string

x-fabric-channel-id identifies the sales channel through which the API request is being made; primarily for multichannel use cases. It is an optional field. The default US channel is 12 while the default Canada channel is 13.

Query Parameters

offset
number
default:0

Number of records to skip before returning all records. Default is 0 when no value is specified.

Example:

1

limit
number
default:10

Maximum number of records per page

Example:

10

Body

application/json

Capacity Override search request

filters
object[]
required
Maximum array length: 50

List to filters for search

sort
string
default:-capacityOverride.createdAt

Resource property on which data needed to be sorted on.

Pattern: (^[+-]capacityOverride\.[a-zA-Z.\-_]*)(,([+-]alert\.[a-zA-Z.\-_]*)){0,}
Example:

"+capacityOverride.createdAt"

Response

OK

Response object returned after searching for Capacity Overrides. Includes paginated data and optional summary statistics.

pagination
object

Pagination response

data
object[]

A list of Capacity Override records that match the search criteria.

stats
string[]

An array of summary statistics or aggregated data related to the search.