Find attribute groups

Find attribute groups based on the given search criteria. You will get a paginated response, which you can narrow down using filter criteria such as page and size.

Authorizations

Authorization

string

header

required

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

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Body

application/json

include

object

Show child attributes

include.attributes

boolean

true: Includes attributes <br /> false: Excludes attributes

match

object

Show child attributes

match.or

object[]

Show child attributes

match.or.name

string

Attribute group name

match.target

string

Search target. Currently, supports only ITEM.

page

number

Page number to be retrieved

size

number

Number of records (attribute groups) per page

sort

object[]

Show child attributes

sort.direction

enum<string>

Direction (ascending or descending) or sorting the response

Available options:

ASC,

DESC

sort.field

string

Field on which the results must be sorted

Response

200 - application/json

attributeGroups

object[]

Show child attributes

attributeGroups._id

string

A 24-character system-generated ID of the attribute group

attributeGroups.createdOn

string

Time of attribute group creation (UTC format)

attributeGroups.description

string

Accurate description of the attribute and what it represents

attributeGroups.EditableAttributes

object[]

Show child attributes

attributeGroups.EditableAttributes._id

string

A 24-character system-generated ID, for internal use

attributeGroups.EditableAttributes.attribute

object[]

Show child attributes

attributeGroups.EditableAttributes.attribute._id

string

A 24-character system-generated attribute ID

attributeGroups.EditableAttributes.attribute.attributeValidationId

string

Attribute validation ID

attributeGroups.EditableAttributes.attribute.createdOn

string

Time of attribute creation (UTC format)

attributeGroups.EditableAttributes.attribute.description

string

Accurate description of attribute and what it represents

attributeGroups.EditableAttributes.attribute.formula

string

Formula for the item attribute

attributeGroups.EditableAttributes.attribute.formulaManuallyOverWritten

boolean

true: Formula can be manually overwritten <br /> false: Formula cannot be manually overwritten

attributeGroups.EditableAttributes.attribute.modifiedBy

string

User ID that modified item attribute

attributeGroups.EditableAttributes.attribute.modifiedOn

string

Time when the attribute was last modified (UTC format)

attributeGroups.EditableAttributes.attribute.name

string

Attribute name

attributeGroups.EditableAttributes.attribute.textSubType

string

Conditionally required sub-type for TEXT attribute type

attributeGroups.EditableAttributes.attribute.type

string

Attribute type

attributeGroups.EditableAttributes.attributeGroupId

string

A 24-character system-generated ID of attribute group

attributeGroups.EditableAttributes.attributeId

string

A 24-character system-generated attribute ID

attributeGroups.EditableAttributes.createdOn

string

Time of attribute creation (UTC format)

attributeGroups.EditableAttributes.isEditable

boolean

true: Attribute is editable <br /> false: Attribute is non-editable

attributeGroups.EditableAttributes.modifiedOn

string

Time when attribute was last updated (UTC format)

attributeGroups.EditableAttributes.order

number

Order of items within the attribute group

attributeGroups.ImpactedAttributes

object[]

attributeGroups.modifiedOn

string

Time when attribute group was last modified (UTC format)

attributeGroups.name

string

Attribute group name

attributeGroups.priorityOrder

number

Priority order of attribute group

attributeGroups.ReadOnlyAttributes

object[]

Show child attributes

attributeGroups.ReadOnlyAttributes._id

string

A 24-character system-generated ID, for internal use

attributeGroups.ReadOnlyAttributes.attribute

object[]

Show child attributes

attributeGroups.ReadOnlyAttributes.attribute._id

string

A 24-character system-generated attribute ID

attributeGroups.ReadOnlyAttributes.attribute.attributeValidationId

string

Attribute validation ID

attributeGroups.ReadOnlyAttributes.attribute.createdOn

string

Time of attribute creation (UTC format)

attributeGroups.ReadOnlyAttributes.attribute.description

string

Accurate description of attribute and what it represents

attributeGroups.ReadOnlyAttributes.attribute.formula

string

Formula for the item attribute

attributeGroups.ReadOnlyAttributes.attribute.formulaManuallyOverWritten

boolean

true: Formula can be manually overwritten <br /> false: Formula cannot be manually overwritten

attributeGroups.ReadOnlyAttributes.attribute.modifiedBy

string

User ID that modified item attribute

attributeGroups.ReadOnlyAttributes.attribute.modifiedOn

string

Time when the attribute was last modified (UTC format)

attributeGroups.ReadOnlyAttributes.attribute.name

string

Attribute name

attributeGroups.ReadOnlyAttributes.attribute.textSubType

string

Conditionally required sub-type for TEXT attribute type

attributeGroups.ReadOnlyAttributes.attribute.type

string

Attribute type

attributeGroups.ReadOnlyAttributes.attributeGroupId

string

A 24-character system-generated ID of attribute group

attributeGroups.ReadOnlyAttributes.attributeId

string

A 24-character system-generated attribute ID

attributeGroups.ReadOnlyAttributes.createdOn

string

Time of attribute creation (UTC format)

attributeGroups.ReadOnlyAttributes.isEditable

boolean

true: Attribute is editable <br /> false: Attribute is non-editable

attributeGroups.ReadOnlyAttributes.modifiedOn

string

Time when attribute was last updated (UTC format)

attributeGroups.ReadOnlyAttributes.order

number

Order of items within the attribute group

attributeGroups.totalAttributes

number

Number of attributes in the attribute group

attributeGroups.type

enum<string>

Attribute group type

Available options:

WORKFLOW,

COLLECTION

attributeGroups.WorkflowAttributes

object[]

pages

number

Number of pages for the given pageSize

pageSize

number

Number of records (attribute group) per page

totalSize

number

Total number of records (attribute group)