# AttributeScopes

Attribute scopes are used to organize your attributes in different scopes, so you can easily work with collections of attributes based on their attribute scopes. If for example you want to render a table with all technical specifications for a product on your website, what are the tehcnical specification attributes? By adding the technical specifications attributes to a specific attribute scope, your can easily find the collection of attributes to render in this table.

GET /attributescopes Get all attribute scopes in the system

Response status OK (200)

array : AttributeScope
AttributeScope
Property name Data type Description
Uid string

Unique id of scope

Alias string

Unique alias of scope used to be easily identifiable by humans


PUT /attributescopes Update an attribute scope

Request parameters

Property name Parameter type Data type Description
attributeScope body object : AttributeScope

Attribute scope to update

AttributeScope
Property name Data type Description
Uid string

Unique id of scope

Alias string

Unique alias of scope used to be easily identifiable by humans

Response status OK (200)

No body message is returned

POST /attributescopes Create an attribute scope

Request parameters

Property name Parameter type Data type Description
attributeScope body object : AttributeScope

Attribute scope to create

AttributeScope
Property name Data type Description
Uid string

Unique id of scope

Alias string

Unique alias of scope used to be easily identifiable by humans

Response status OK (200)

No body message is returned

DELETE /attributescopes Delete an attribute scope

Attribute scopes can only be deleted if no attributes reference the scope

Request parameters

Property name Parameter type Data type Description
uid query string

Unique id of attribute scope to delete

Response status OK (200)

No body message is returned

GET /attributescopes/{uid} Get a attribute scope from its uid

Request parameters

Property name Parameter type Data type Description
uid path string

Unique id of attribute scope to get

Response status OK (200)

object : AttributeScope
AttributeScope
Property name Data type Description
Uid string

Unique id of scope

Alias string

Unique alias of scope used to be easily identifiable by humans


POST /attributescopes/batch/attributes Get uids of attributes in scopes

Request parameters

Property name Parameter type Data type Description
model body object : AttributeScopeAttributesModel
AttributeScopeAttributesModel
Property name Data type Description
AttributeScopeUids array

Attribute scope uids to request attributes for

Response status OK (200)

object