POST
/
api-category
/
v1
/
category
/
source
/
exclusion
curl --request POST \
  --url https://live.copilot.fabric.inc/api-category/v1/category/source/exclusion \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "id": "6170135a49b4af38190970fe",
  "nodeId": 12,
  "sourceExclusions": [
    {
      "id": "61701259125b7225cbfb21b9",
      "nodeId": 12,
      "action": "SET"
    }
  ]
}'
{
  "id": "6170135a49b4af38190970fe",
  "nodeId": 12,
  "name": "Furniture",
  "sources": [
    {
      "id": "61701259125b7225cbfb21b9",
      "name": "picture",
      "breadcrumbString": "PRIMARY/Furniture/Chairs"
    }
  ],
  "sourceExclusions": [
    {
      "id": "61701259125b7225cbfb21b9",
      "name": "picture",
      "breadcrumbString": "PRIMARY/Furniture/Chairs"
    }
  ]
}

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
​
id
string

A 24-character system-generated category ID. nodeId and id are the two identifier of a category, and one of them must be specified.

Example:

"6170135a49b4af38190970fe"

​
nodeId
number

Numeric category ID. nodeId and id are the two identifier of a category, and one of them must be specified.

Example:

12

​
sourceExclusions
object[]

Response

200
application/json
OK
​
id
string

A 24-character system-generated category ID

Example:

"6170135a49b4af38190970fe"

​
nodeId
number

Numeric category ID

Example:

12

​
name
string

Category name

Example:

"Furniture"

​
sources
object[]
​
sourceExclusions
object[]

Was this page helpful?