# 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
[
{
"Uid": "b5e31f2d-4f9c-4ec9-9910-79f492222969",
"Alias": "ProductMasterData"
},
{
"Uid": "3f766c10-5579-401e-a31f-85aa91f019bd",
"Alias": "SpecificationData"
}
]Response status OK (200)
| 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
{
"Uid": "56603af8-bace-4b3b-8ce3-3b85e135e7aa",
"Alias": "NewScopeAlias"
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| attributeScope | body | object : AttributeScope |
Attribute scope to update |
| 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)
POST /attributescopes Create an attribute scope
{
"Uid": "36b487ac-dbb4-40c7-b7c6-fb5e5df85446",
"Alias": "ProductMasterData"
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| attributeScope | body | object : AttributeScope |
Attribute scope to create |
| 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)
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)
GET /attributescopes/{uid} Get a attribute scope from its uid
{
"Uid": "17c90f22-e20a-4c26-90c2-c436615c1d73",
"Alias": "ProductMasterData"
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | path | string |
Unique id of attribute scope to get |
Response status OK (200)
| 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
{
"e025d8cf-dfbb-4900-b12a-29e6d1a9792c": [
"69bd67c0-b022-42c9-b787-293b9fdcac1c",
"aec68380-47f7-4822-97f1-16a9ffd8eff7"
],
"9798e80b-6441-4bf9-8237-ccb48e54001d": [
"479b84f4-49bc-4e7b-b650-254899116816",
"2a4d52ad-2719-472e-9a4e-0bdab9949b57"
]
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| model | body | object : AttributeScopeAttributesModel |
| Property name | Data type | Description |
|---|---|---|
| AttributeScopeUids | array |
Attribute scope uids to request attributes for |