Attributes

Get all attributes in the system

get

Responses

200

OK

application/json

Uidstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

AliasstringOptional

BackofficeNamestringOptional

BackofficeDescriptionstringOptional

AttributeGroupIdinteger · int32Optional

AttributeScopestring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

AttributeScopesstring · uuid[]Optional

LocalizedbooleanOptional

FallbackLanguageinteger · int32Optional

DimensionUidstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

FallbackSegmentstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

ReadOnlybooleanOptional

MandatorybooleanOptional

UnchangeablebooleanOptional

AttributeTypestringRead-onlyOptional

DisableRevisionLoggingbooleanOptional

DisableIndexingbooleanOptional

get

/attributes

HTTPcURLJavaScriptPython

GET /attributes HTTP/1.1
Host: api.easycatalogue-dev.cloudtest13.structpim.com
Accept: */*

200

OK

[
  {
    "Uid": "00000000-0000-0000-0000-000000000000",
    "Alias": "text",
    "BackofficeName": "text",
    "BackofficeDescription": "text",
    "Name": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "Description": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "AttributeGroupId": 1,
    "AttributeScope": "00000000-0000-0000-0000-000000000000",
    "AttributeScopes": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "Localized": true,
    "FallbackLanguage": 1,
    "DimensionUid": "00000000-0000-0000-0000-000000000000",
    "FallbackSegment": "00000000-0000-0000-0000-000000000000",
    "ReadOnly": true,
    "Mandatory": true,
    "Unchangeable": true,
    "AttributeType": "text",
    "DisableRevisionLogging": true,
    "DisableIndexing": true
  }
]

Create an attribute

post

#Available from v.3.2.0

Body

application/json

Uidstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

AliasstringOptional

BackofficeNamestringOptional

BackofficeDescriptionstringOptional

AttributeGroupIdinteger · int32Optional

AttributeScopestring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

AttributeScopesstring · uuid[]Optional

LocalizedbooleanOptional

FallbackLanguageinteger · int32Optional

DimensionUidstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

FallbackSegmentstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

ReadOnlybooleanOptional

MandatorybooleanOptional

UnchangeablebooleanOptional

AttributeTypestringRead-onlyOptional

DisableRevisionLoggingbooleanOptional

DisableIndexingbooleanOptional

Responses

200

OK

No content

post

/attributes

HTTPcURLJavaScriptPython

POST /attributes HTTP/1.1
Host: api.easycatalogue-dev.cloudtest13.structpim.com
Content-Type: application/json
Accept: */*
Content-Length: 598

{
  "Uid": "00000000-0000-0000-0000-000000000000",
  "Alias": "text",
  "BackofficeName": "text",
  "BackofficeDescription": "text",
  "Name": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "Description": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "AttributeGroupId": 1,
  "AttributeScope": "00000000-0000-0000-0000-000000000000",
  "AttributeScopes": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "Localized": true,
  "FallbackLanguage": 1,
  "DimensionUid": "00000000-0000-0000-0000-000000000000",
  "FallbackSegment": "00000000-0000-0000-0000-000000000000",
  "ReadOnly": true,
  "Mandatory": true,
  "Unchangeable": true,
  "DisableRevisionLogging": true,
  "DisableIndexing": true
}

200

OK

No content

Update an attribute

put

#Available from v.3.2.0

Body

application/json

Uidstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

AliasstringOptional

BackofficeNamestringOptional

BackofficeDescriptionstringOptional

AttributeGroupIdinteger · int32Optional

AttributeScopestring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

AttributeScopesstring · uuid[]Optional

LocalizedbooleanOptional

FallbackLanguageinteger · int32Optional

DimensionUidstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

FallbackSegmentstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

ReadOnlybooleanOptional

MandatorybooleanOptional

UnchangeablebooleanOptional

AttributeTypestringRead-onlyOptional

DisableRevisionLoggingbooleanOptional

DisableIndexingbooleanOptional

Responses

200

OK

No content

put

/attributes

HTTPcURLJavaScriptPython

PUT /attributes HTTP/1.1
Host: api.easycatalogue-dev.cloudtest13.structpim.com
Content-Type: application/json
Accept: */*
Content-Length: 598

{
  "Uid": "00000000-0000-0000-0000-000000000000",
  "Alias": "text",
  "BackofficeName": "text",
  "BackofficeDescription": "text",
  "Name": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "Description": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "AttributeGroupId": 1,
  "AttributeScope": "00000000-0000-0000-0000-000000000000",
  "AttributeScopes": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "Localized": true,
  "FallbackLanguage": 1,
  "DimensionUid": "00000000-0000-0000-0000-000000000000",
  "FallbackSegment": "00000000-0000-0000-0000-000000000000",
  "ReadOnly": true,
  "Mandatory": true,
  "Unchangeable": true,
  "DisableRevisionLogging": true,
  "DisableIndexing": true
}

200

OK

No content

Get a specific attribute

get

Path parameters

uidstring · uuidRequired

Unique id of attribute to get

Responses

200

OK

application/json

Uidstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

AliasstringOptional

BackofficeNamestringOptional

BackofficeDescriptionstringOptional

AttributeGroupIdinteger · int32Optional

AttributeScopestring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

AttributeScopesstring · uuid[]Optional

LocalizedbooleanOptional

FallbackLanguageinteger · int32Optional

DimensionUidstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

FallbackSegmentstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

ReadOnlybooleanOptional

MandatorybooleanOptional

UnchangeablebooleanOptional

AttributeTypestringRead-onlyOptional

DisableRevisionLoggingbooleanOptional

DisableIndexingbooleanOptional

get

/attributes/{uid}

HTTPcURLJavaScriptPython

GET /attributes/{uid} HTTP/1.1
Host: api.easycatalogue-dev.cloudtest13.structpim.com
Accept: */*

200

OK

{
  "Uid": "00000000-0000-0000-0000-000000000000",
  "Alias": "text",
  "BackofficeName": "text",
  "BackofficeDescription": "text",
  "Name": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "Description": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "AttributeGroupId": 1,
  "AttributeScope": "00000000-0000-0000-0000-000000000000",
  "AttributeScopes": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "Localized": true,
  "FallbackLanguage": 1,
  "DimensionUid": "00000000-0000-0000-0000-000000000000",
  "FallbackSegment": "00000000-0000-0000-0000-000000000000",
  "ReadOnly": true,
  "Mandatory": true,
  "Unchangeable": true,
  "AttributeType": "text",
  "DisableRevisionLogging": true,
  "DisableIndexing": true
}

Get references to a attribute from other attributes

get

#Available from v.3.5.0

Path parameters

uidstring · uuidRequired

Uid of attribute

Responses

200

OK

application/json

AttributeUidstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

ReferencingCategoriesinteger · int32[]Optional

ReferencingGlobalListValuesstring · uuid[]Optional

ReferencingProductStructuresstring · uuid[]Optional

ReferencingVariationDefinitionsstring · uuid[]Optional

get

/attributes/{uid}/references

HTTPcURLJavaScriptPython

GET /attributes/{uid}/references HTTP/1.1
Host: api.easycatalogue-dev.cloudtest13.structpim.com
Accept: */*

200

OK

{
  "AttributeUid": "00000000-0000-0000-0000-000000000000",
  "ReferencingCategories": [
    1
  ],
  "ReferencesOnCategoryAttributes": [
    {
      "EntityId": 1,
      "AttributeUid": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "ReferencesOnProductAttributes": [
    {
      "EntityId": 1,
      "AttributeUid": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "ReferencesOnVariantAttributes": [
    {
      "EntityId": 1,
      "AttributeUid": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "ReferencingGlobalListValues": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "ReferencingProductStructures": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "ReferencingVariationDefinitions": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

Get a batch of attributes

post

Bodystring · uuid[]

application/json

string · uuid[]Optional

Responses

200

OK

application/json

Uidstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

AliasstringOptional

BackofficeNamestringOptional

BackofficeDescriptionstringOptional

AttributeGroupIdinteger · int32Optional

AttributeScopestring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

AttributeScopesstring · uuid[]Optional

LocalizedbooleanOptional

FallbackLanguageinteger · int32Optional

DimensionUidstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

FallbackSegmentstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

ReadOnlybooleanOptional

MandatorybooleanOptional

UnchangeablebooleanOptional

AttributeTypestringRead-onlyOptional

DisableRevisionLoggingbooleanOptional

DisableIndexingbooleanOptional

post

/attributes/batch

HTTPcURLJavaScriptPython

POST /attributes/batch HTTP/1.1
Host: api.easycatalogue-dev.cloudtest13.structpim.com
Content-Type: application/json
Accept: */*
Content-Length: 40

[
  "00000000-0000-0000-0000-000000000000"
]

200

OK

[
  {
    "Uid": "00000000-0000-0000-0000-000000000000",
    "Alias": "text",
    "BackofficeName": "text",
    "BackofficeDescription": "text",
    "Name": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "Description": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "AttributeGroupId": 1,
    "AttributeScope": "00000000-0000-0000-0000-000000000000",
    "AttributeScopes": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "Localized": true,
    "FallbackLanguage": 1,
    "DimensionUid": "00000000-0000-0000-0000-000000000000",
    "FallbackSegment": "00000000-0000-0000-0000-000000000000",
    "ReadOnly": true,
    "Mandatory": true,
    "Unchangeable": true,
    "AttributeType": "text",
    "DisableRevisionLogging": true,
    "DisableIndexing": true
  }
]

This model is an abstract type and can attain any of the below concrete models. The AttributeType property is used to define the actual model type.

AttributeReferenceAttribute

Property name	Data type	Description
AllowMultipleValues	boolean	Indicates whether users can select more than one attribute
AllowedAttributeScopes	array	Attribute scopes from which attributes can be selected
AllowedAttributeTypes	array	The attribute types that is allowed to be referenced
UnfoldComplexTypes	boolean	Indicates whether user can select sub attributes of complex attributes
Uid	string	Unique id of attribute
Alias	string	Unique alias of attribute. Max length is 50 characters and can only consist of letters a-z/A-Z and numbers 0-9 (but cannot start with a number)
BackofficeName	string	The name of the attribute displayed to the editor in the PIM backoffice
BackofficeDescription	string	The description of the attribute displayed to the editor in the PIM backoffice
Name	object	The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)
Description	object	The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)
AttributeGroupId	integer	The id of the attribute group this attribute is placed within
AttributeScope	string	Unique id of the attribute scope this attribute is placed within
AttributeScopes	array	Unique ids of the attribute scopes this attribute is placed within
Localized	boolean	Indicates whether values of this attribute are localized
FallbackLanguage	integer	Indicates a fallback language in case attribute is localized and no value is added to a specific language
DimensionUid	string	Unique id of Dimension to segment values of this attribute on
FallbackSegment	string	Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension
ReadOnly	boolean	Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.
Mandatory	boolean	Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.
Unchangeable	boolean	Indicates whether this attribute cannot change its value, once it has a value assigned. NOTE: Only applied when attribute is a sub attribute of a complex attribute.
AttributeType	string	Type of attribute
DisableRevisionLogging	boolean	Disable all revision logging for this attribute
DisableIndexing	boolean	Disable indexing for this attribute

BooleanAttribute

Property name	Data type	Description
Uid	string	Unique id of attribute
Alias	string	Unique alias of attribute. Max length is 50 characters and can only consist of letters a-z/A-Z and numbers 0-9 (but cannot start with a number)
BackofficeName	string	The name of the attribute displayed to the editor in the PIM backoffice
BackofficeDescription	string	The description of the attribute displayed to the editor in the PIM backoffice
Name	object	The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)
Description	object	The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)
AttributeGroupId	integer	The id of the attribute group this attribute is placed within
AttributeScope	string	Unique id of the attribute scope this attribute is placed within
AttributeScopes	array	Unique ids of the attribute scopes this attribute is placed within
Localized	boolean	Indicates whether values of this attribute are localized
FallbackLanguage	integer	Indicates a fallback language in case attribute is localized and no value is added to a specific language
DimensionUid	string	Unique id of Dimension to segment values of this attribute on
FallbackSegment	string	Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension
ReadOnly	boolean	Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.
Mandatory	boolean	Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.
Unchangeable	boolean	Indicates whether this attribute cannot change its value, once it has a value assigned. NOTE: Only applied when attribute is a sub attribute of a complex attribute.
AttributeType	string	Type of attribute
DisableRevisionLogging	boolean	Disable all revision logging for this attribute
DisableIndexing	boolean	Disable indexing for this attribute

Get references from other attributes to a batch of attributes

post

#Available from v.3.5.0 No more than 5000 values can be requested at a time.

Bodystring · uuid[]

application/json

string · uuid[]Optional

Responses

200

OK

application/json

AttributeUidstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

ReferencingCategoriesinteger · int32[]Optional

ReferencingGlobalListValuesstring · uuid[]Optional

ReferencingProductStructuresstring · uuid[]Optional

ReferencingVariationDefinitionsstring · uuid[]Optional

post

/attributes/batch/references

HTTPcURLJavaScriptPython

POST /attributes/batch/references HTTP/1.1
Host: api.easycatalogue-dev.cloudtest13.structpim.com
Content-Type: application/json
Accept: */*
Content-Length: 40

[
  "00000000-0000-0000-0000-000000000000"
]

200

OK

[
  {
    "AttributeUid": "00000000-0000-0000-0000-000000000000",
    "ReferencingCategories": [
      1
    ],
    "ReferencesOnCategoryAttributes": [
      {
        "EntityId": 1,
        "AttributeUid": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "ReferencesOnProductAttributes": [
      {
        "EntityId": 1,
        "AttributeUid": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "ReferencesOnVariantAttributes": [
      {
        "EntityId": 1,
        "AttributeUid": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "ReferencingGlobalListValues": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "ReferencingProductStructures": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "ReferencingVariationDefinitions": [
      "00000000-0000-0000-0000-000000000000"
    ]
  }
]