Skip to main content
POST
/
api-product
/
v1
/
product
/
attribute
/
mapping
/
search
Find attribute mapping
curl --request POST \
  --url https://live.copilot.fabric.inc/api-product/v1/product/attribute/mapping/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "page": 0,
  "size": 10,
  "include": {
    "attribute": true
  },
  "sort": [
    {
      "field": "createdOn",
      "direction": "ASC"
    }
  ],
  "match": {
    "target": "<string>",
    "mapping": "<string>",
    "attributeId": "62e2ae29c3004a000950ad5f",
    "name": "<string>",
    "description": "<string>",
    "required": true
  }
}
'
{
  "totalSize": 100,
  "pageSize": 10,
  "pages": 10,
  "mappings": [
    {
      "attributeId": "62e2ae29c3004a000950ad5f",
      "attribute": {
        "id": "<string>",
        "statuses": [
          {
            "code": "<string>",
            "type": "ATTRIBUTE",
            "source": "PIM",
            "name": "<string>",
            "description": "<string>",
            "createdOn": "2023-11-07T05:31:56Z",
            "createdBy": "broma0",
            "modifiedOn": "2023-11-07T05:31:56Z",
            "modifiedBy": "broma0"
          }
        ],
        "files": [
          {
            "type": "IMPORT",
            "name": "<string>",
            "statuses": [
              {
                "code": "<string>",
                "type": "ATTRIBUTE",
                "source": "PIM",
                "name": "<string>",
                "description": "<string>",
                "createdOn": "2023-11-07T05:31:56Z",
                "createdBy": "broma0",
                "modifiedOn": "2023-11-07T05:31:56Z",
                "modifiedBy": "broma0"
              }
            ],
            "progress": 100,
            "createdOn": "2023-11-07T05:31:56Z",
            "createdBy": "broma0",
            "modifiedOn": "2023-11-07T05:31:56Z",
            "modifiedBy": "broma0",
            "secondsTakenToImport": 123,
            "secondsTakenToProcess": 123
          }
        ],
        "name": "<string>",
        "description": "<string>",
        "locales": [
          {
            "locale": "fr-ca",
            "name": "Un Nom Français"
          }
        ],
        "localizable": true,
        "mapping": "<string>",
        "type": "TEXT",
        "serialStart": 123,
        "target": "NODE",
        "format": "YYYY-MM-DD",
        "formula": "value < 10 || value > 20",
        "validation": {
          "required": true,
          "inheritable": true,
          "inverse": false,
          "unique": true,
          "exact": "<string>",
          "attributeTypes": [
            "TEXT"
          ],
          "contains": "<string>",
          "range": {
            "min": "<string>",
            "max": "<string>"
          },
          "formula": "value < 10 || value > 20",
          "oneOf": [
            "<string>"
          ]
        },
        "createdOn": "2023-11-07T05:31:56Z",
        "createdBy": "broma0",
        "modifiedOn": "2023-11-07T05:31:56Z",
        "modifiedBy": "broma0"
      },
      "mapping": "SKU",
      "target": "ITEM",
      "name": "Item SKU",
      "description": "Item SKU",
      "required": true,
      "validation": {
        "required": true,
        "inheritable": true,
        "inverse": false,
        "unique": true,
        "exact": "<string>",
        "attributeTypes": [
          "TEXT"
        ],
        "contains": "<string>",
        "range": {
          "min": "<string>",
          "max": "<string>"
        },
        "formula": "value < 10 || value > 20",
        "oneOf": [
          "<string>"
        ]
      },
      "createdOn": "2021-09-23T17:47:04.231Z",
      "createdBy": "broma0",
      "modifiedOn": "2023-11-07T05:31:56Z",
      "modifiedBy": "broma0"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developer.fabric.inc/llms.txt

Use this file to discover all available pages before exploring further.

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.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Body

application/json
​
page
number
required

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

Example:

0

​
size
number
required

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

Example:

10

​
include
object
​
sort
object[]

Sorting preference

​
match
object

Specification for matching attribute mapping.

Response

OK

​
totalSize
number

Total number of records

Example:

100

​
pageSize
number

Number of records in a page

Example:

10

​
pages
number

Total number of pages in the response

Example:

10

​
mappings
object[]