Find attributes

With this endpoint, you can search for attributes based on criteria such as name, creation or modification date, attribute type, and other factors.

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

match

object

required

Specification for matching attributes

Show child attributes

match.createdAt

object

Date-time search

• Option 1
• Option 2
• Option 3

Show child attributes

match.createdAt.fromValue

string

required

Starting range (UTC)

match.createdAt.op

enum<string>

required

Date range

Available options:

RANGE

match.createdAt.toValue

string

required

Ending range (UTC)

match.description

object

String search

• Option 1
• Option 2

Show child attributes

match.description.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

match.description.value

string[]

required

match.id

object

Simple string search

• Option 1
• Option 2

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.isCustomFormulaSet

object

Boolean search

Show child attributes

match.isCustomFormulaSet.op

enum<string>

required

Operations that can be performed on a boolean type

Available options:

EQUALS

match.isCustomFormulaSet.value

boolean

required

Sample boolean schema

match.isFormulaSet

object

Boolean search

Show child attributes

match.isFormulaSet.op

enum<string>

required

Operations that can be performed on a boolean type

Available options:

EQUALS

match.isFormulaSet.value

boolean

required

Sample boolean schema

match.isLocalizable

object

Boolean search

Show child attributes

match.isLocalizable.op

enum<string>

required

Operations that can be performed on a boolean type

Available options:

EQUALS

match.isLocalizable.value

boolean

required

Sample boolean schema

match.isMandatory

object

Boolean search

Show child attributes

match.isMandatory.op

enum<string>

required

Operations that can be performed on a boolean type

Available options:

EQUALS

match.isMandatory.value

boolean

required

Sample boolean schema

match.isManualOverwrite

object

Boolean search

Show child attributes

match.isManualOverwrite.op

enum<string>

required

Operations that can be performed on a boolean type

Available options:

EQUALS

match.isManualOverwrite.value

boolean

required

Sample boolean schema

match.name

object

Searches for attributes that matches the query. Append locale and name with a # as a value

• 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.name.locale

string[]

If isLocalizable is true, searches for the requested name in the list of locales provided here. If isLocalizable is false, the search will only be on the non-localized names.

match.subType

object

Searches for attributes of the specified subType

• Option 1
• Option 2

Show child attributes

match.subType.op

enum<string>

required

Operations that can be performed on a string type

Available options:

EQUALS

match.subType.value

enum<string>

required

Single string for an EQUALS operation; comma-separated string for an IN operation

Available options:

SINGLE,

MULTIPLE,

SMALL_TEXT,

TEXT_AREA,

HTML

match.target

object

Attributes of the specified target

• Option 1
• Option 2

Show child attributes

match.target.op

enum<string>

required

Operations supported on a string type.

Available options:

EQUALS

match.target.value

enum<string>

required

Single string for EQUALS operation; comma-separated string for an IN operation

Available options:

PRODUCT,

CATEGORY

match.type

object

Attributes of the specified type

• Option 1
• Option 2

Show child attributes

match.type.op

enum<string>

required

Operations supported on a string type

Available options:

EQUALS

match.type.value

enum<string>

required

Single string for EQUALS operation; comma-separated string for an IN operation

Available options:

TEXT,

NUMBER,

DATETIME,

BOOLEAN,

OPTIONS,

SERIAL

match.updatedAt

object

Date-time search

• Option 1
• Option 2
• Option 3

Show child attributes

match.updatedAt.fromValue

string

required

Starting range (UTC)

match.updatedAt.op

enum<string>

required

Date range

Available options:

RANGE

match.updatedAt.toValue

string

required

Ending range (UTC)

limit

integer

default:

10

Maximum number of records per page <br /> When no value is specified, default is 10.

offset

integer

default:

0

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

sort

string

Criteria to sort response. Sorting is supported only on createdAt, updatedAt, type, name and isMandatory. - refers to descending while + refers to ascending order

Response

200 - application/json

Attribute details

count

integer

Total number of records

data

object[]

Show child attributes

data.createdAt

string

Time of attribute creation (UTC)

data.description

string

Brief description of attribute

data.id

string

Attribute ID

data.isLocalizable

boolean

true: Attribute name is translated into different languages or localized for different regions <br /> false: Attribute name isn't localized Note: Refer to localizedProperties to get relevant attributes based on locale.

data.localizedProperties

object

Names of localized attributes

Show child attributes

data.localizedProperties.{key}

object

Show child attributes

data.localizedProperties.{key}.name

string

Localized name

data.name

string

Non-localized attribute name. Refer to localizedProperties to get the localized name.

data.target

Single string for EQUALS operation; comma-separated string for an IN operation

Available options:

PRODUCT,

CATEGORY

data.type

enum<string>

Attribute type

Available options:

TEXT,

NUMBER,

DATETIME,

BOOLEAN,

OPTIONS,

SERIAL

data.updatedAt

string

Time of last update to attribute (UTC)

data.updatedBy

string

Email of the user who last updated the attribute

data.validation

object

Validation details

Show child attributes

data.validation.acceptedValues

string[]

List of accepted values. Applicable when the attributeType is OPTIONS and subType is MULTIPLE. Note: When non-localized, shows the attribute name as it is. Otherwise, shows the localized name.

data.validation.customValidationFormula

string

JavaScript can be provided here to add custom validations.<br /> Applicable only for attributeType - TEXT, NUMBER, OPTIONS, and DATE.

data.validation.dateFormat

string

Date format. <br /> Applicable when attributeType is DATETIME.

data.validation.formula

string

JavaScript will be evaluated and applied on product. <br /> Applicable only for attributeType - TEXT, NUMBER, OPTIONS, and DATE.

data.validation.increment

integer

Represents number increment in a series. <br /> Applicable only when attributeType is SERIAL. For example, if the startWith is 5 and increment is 5, the next value in the series will 10, 15, and so forth.

data.validation.isDecimal

boolean

default:

false

true: Input can be a float. <br /> false: Input must be an integer. <br /> Applicable only when attributeType is NUMBER.

data.validation.isMandatory

boolean

default:

false

true: Attribute is mandatory. <br /> false: Attribute is optional

data.validation.isManualOverwrite

boolean

default:

false

true: The value isn't computed using formula property <br /> false: The value is computed using formula property. <br /> Note: manualOverwrite is applicable only for formula property.

data.validation.localizedAcceptedValues

object

List of accepted localized values. Applicable when the attributeType is OPTIONS and subType is MULTIPLE. When attribute name is localized, the localized values are shown.

Show child attributes

data.validation.localizedAcceptedValues.{key}

string[]

data.validation.max

number

Maximum value allowed for an attribute. <br /> Applicable only when attributeType is NUMBER.

data.validation.min

number

Minimum value allowed for an attribute. <br /> Applicable only when attributeType is NUMBER.

data.validation.startWith

integer

Starting number in a series. <br /> Applicable only when attributeType is SERIAL.

data.validation.subType

enum<string>

Subtypes such as SINGLE and MULTIPLE are applicable when attributeType is OPTIONS. The rest of the subTypes are applicable when attributeType is TEXT.

Available options:

SINGLE,

MULTIPLE,

SMALL_TEXT,

TEXT_AREA,

HTML

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.