Find attribute mapping

Searches for attribute mapping 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

page

number

required

Page number to be retrieved. <br /> Note: <br /> 1) Applicable only in a paginated response. <br /> 2) Always paired with size

size

number

required

Number of records per page <br /> Note: <br /> 1) Applicable only in a paginated response. <br /> 2) Always paired with page

include

object

Show child attributes

include.attribute

boolean

true: include the attribute in the response; <br /> false: exclude attribute in the response

match

object

Specification for matching attribute mapping.

Show child attributes

match.attributeId

string

A 24-character system-generated Attribute ID

match.description

string

Mapping for an attribute whose description contains the specified value.

match.mapping

string

Attribute mapping

match.name

string

Mapping for an attribute whose name contains the specified value

match.required

boolean

true: Returns only the attribute mappings that are mandatory

match.target

string

Attribute mapping for the specified target

sort

object[]

Sorting preference

Show child attributes

sort.direction

enum<string>

Sorting direction

Available options:

ASC,

DESC

sort.field

enum<string>

The field to sort must be specified. Sorting is based on the attribute's raw value.

Available options:

createdOn,

updatedOn,

mapping

Response

200 - application/json

mappings

object[]

Show child attributes

mappings.attribute

object

Represents the mapped attributes. Only populated when include.attribute is true. <br /> Note: Not applicable for an attribute mapping modify request

Show child attributes

mappings.attribute.createdBy

string

ID that created the attribute

mappings.attribute.createdOn

string

Time of attribute creation

mappings.attribute.description

string

Attribute description

mappings.attribute.files

object[]

Array of file's associated with an item

Show child attributes

mappings.attribute.files.createdBy

string

User ID that created the file

mappings.attribute.files.createdOn

string

Time of file creation

mappings.attribute.files.modifiedBy

string

User ID that last modified the file

mappings.attribute.files.modifiedOn

string

Time when file was last modified

mappings.attribute.files.name

string

File name

mappings.attribute.files.progress

number

Import progress in percentage

mappings.attribute.files.secondsTakenToImport

number

Time taken to import the file (doesn't include the whole time for the full bulk import process).

mappings.attribute.files.secondsTakenToProcess

number

Time taken to process the file after the file was read

mappings.attribute.files.statuses

object[]

Current status of the file

Show child attributes

mappings.attribute.files.statuses.code

string

Status code

mappings.attribute.files.statuses.createdBy

string

User ID that created the file

mappings.attribute.files.statuses.createdOn

string

Time of file creation

mappings.attribute.files.statuses.description

string

Status description

mappings.attribute.files.statuses.modifiedBy

string

User ID that last modified the file

mappings.attribute.files.statuses.modifiedOn

string

Time when file was last modified

mappings.attribute.files.statuses.name

string

Status name

mappings.attribute.files.statuses.source

enum<string>

Status source

Available options:

PIM,

WAM

mappings.attribute.files.statuses.type

enum<string>

Status type

Available options:

ATTRIBUTE,

ATTRIBUTE_VALUE,

ITEM,

BUNDLE,

NODE,

HIERARCHY

mappings.attribute.files.type

enum<string>

Status type

Available options:

IMPORT,

EXPORT

mappings.attribute.format

string

Attribute format. Currently used only for the attribute type DATETIME.

mappings.attribute.formula

string

JavaScript expression to dynamically compute the attribute's value. <br /> Note: The type returned must match the attribute's type.

mappings.attribute.id

string

Attribute ID

mappings.attribute.locales

object[]

Show child attributes

mappings.attribute.locales.locale

string

Locale identifier

mappings.attribute.locales.name

string

Localized string value

mappings.attribute.localizable

boolean

true: attribute can be localized <br /> false: attribute cannot be localized

mappings.attribute.mapping

string | null

Attribute mapping. <br /> Note: Most attributes will not have a mapping, resulting in null value.

mappings.attribute.modifiedBy

string

User ID that last modified the attribute

mappings.attribute.modifiedOn

string

Time when the attribute was last modified

mappings.attribute.name

string

Attribute name

mappings.attribute.serialStart

number

Conditionally required to indicate the starting value of SERIAL attribute type. When enabled, the subsequent attribute values increment by 1.

mappings.attribute.statuses

object[]

For 'attribute modify request', the PIM statuses (if applicable). For 'attribute search request', the statuses defined by the include.status request parameter.

Show child attributes

mappings.attribute.statuses.code

string

Status code

mappings.attribute.statuses.createdBy

string

User ID that created the file

mappings.attribute.statuses.createdOn

string

Time of file creation

mappings.attribute.statuses.description

string

Status description

mappings.attribute.statuses.modifiedBy

string

User ID that last modified the file

mappings.attribute.statuses.modifiedOn

string

Time when file was last modified

mappings.attribute.statuses.name

string

Status name

mappings.attribute.statuses.source

enum<string>

Status source

Available options:

PIM,

WAM

mappings.attribute.statuses.type

enum<string>

Status type

Available options:

ATTRIBUTE,

ATTRIBUTE_VALUE,

ITEM,

BUNDLE,

NODE,

HIERARCHY

mappings.attribute.target

enum<string>

Indicates whether the attribute is for categories or items.

Available options:

NODE,

ITEM

mappings.attribute.type

enum<string>

Data type of the attribute

Available options:

TEXT,

BOOLEAN,

SERIAL,

DECIMAL,

INTEGER,

DATETIME

mappings.attribute.validation

object

Show child attributes

mappings.attribute.validation.attributeTypes

enum<string>[]

Attribute types

Available options:

TEXT,

BOOLEAN,

SERIAL,

DECIMAL,

INTEGER,

ASSET,

DATETIME

mappings.attribute.validation.contains

string

Specified value must contain this string

mappings.attribute.validation.exact

Specified value must exactly match this value

mappings.attribute.validation.formula

string

JavaScript expression to determine if the value matches

mappings.attribute.validation.inheritable

boolean

true: Parent attributes are inherited to children items <br /> false: Parent attributes are not inherited to children items.

mappings.attribute.validation.inverse

boolean

true: Inverts existing validation (example - requires that the validation does not pass) <br /> false: Follows existing validation

mappings.attribute.validation.oneOf

Match the value if it is one of these.

mappings.attribute.validation.range

object

Specified range of values must be between this min and/or max

Show child attributes

mappings.attribute.validation.range.max

Specified value must be less than or equal to this value

mappings.attribute.validation.range.min

Specified value must be greater than or equal to this value

mappings.attribute.validation.required

boolean

Indicates mandatory attribute

mappings.attribute.validation.unique

boolean

true: Value is unique across all items or categories <br /> false: Value is not unique

mappings.attributeId

string

A 24-character system-generated attribute ID

mappings.createdBy

string

User ID that created item attribute

mappings.createdOn

string

Time of attribute creation (UTC format)

mappings.description

string

Description for attribute mapping

mappings.mapping

string

Attribute mapping

mappings.modifiedBy

string

User ID that last modified item attribute

mappings.modifiedOn

string

Time of when the attribute was last modified

mappings.name

string

Name of attribute mapping

mappings.required

boolean

true: Mapping is mandatory; <br /> false: mapping is optional

mappings.target

string

Returns attribute mapping for the specified target

mappings.validation

object

Show child attributes

mappings.validation.attributeTypes

enum<string>[]

Attribute types

Available options:

TEXT,

BOOLEAN,

SERIAL,

DECIMAL,

INTEGER,

ASSET,

DATETIME

mappings.validation.contains

string

Specified value must contain this string

mappings.validation.exact

Specified value must exactly match this value

mappings.validation.formula

string

JavaScript expression to determine if the value matches

mappings.validation.inheritable

boolean

true: Parent attributes are inherited to children items <br /> false: Parent attributes are not inherited to children items.

mappings.validation.inverse

boolean

true: Inverts existing validation (example - requires that the validation does not pass) <br /> false: Follows existing validation

mappings.validation.oneOf

Match the value if it is one of these.

mappings.validation.range

object

Specified range of values must be between this min and/or max

Show child attributes

mappings.validation.range.max

Specified value must be less than or equal to this value

mappings.validation.range.min

Specified value must be greater than or equal to this value

mappings.validation.required

boolean

Indicates mandatory attribute

mappings.validation.unique

boolean

true: Value is unique across all items or categories <br /> false: Value is not unique

pages

number

Total number of pages in the response

pageSize

number

Number of records in a page

totalSize

number

Total number of records