# AttributeGroups
Attribute groups are used to organize attributes in the system for easy presentation in groups on different channels. Eg. if you want to display a long list of technical specifications, but grouped under different headlines, attribute groups are here for that purpose.
GET /attributegroups Get all attribute groups in the system
[
{
"Id": 2,
"Uid": "b425001f-a287-48d7-b912-2d7591c051cf",
"Alias": "SizeAndWeight",
"SortOrder": 1,
"Name": {
"en-GB": "Size & weight",
"da-DK": "Størrelse & vægt"
}
},
{
"Id": 4,
"Uid": "0fe9c182-ad37-404c-91b3-f57cde46c932",
"Alias": "MechanicalProperties",
"SortOrder": 2,
"Name": {
"en-GB": "Mechanical properties",
"da-DK": "Mekaniske egenskaber"
}
}
]Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| Id | integer |
Unique id of attribute group |
| Uid | string |
Unique id of attribute group |
| Alias | string |
Unique alias of attribute group |
| SortOrder | integer |
Sort order of the attribute group used to sort attribute groups between each other |
| Name | object |
Localized name of attribute group used for displaying the attribute group on ex. a webshop (Dictionary of ISO culturecode and localized name) |
| BackofficeName | string |
The name of the attribute group displayed to the editor in the PIM backoffice |
| BackofficeDescription | string |
The description of the attribute group displayed to the editor in the PIM backoffice |
PUT /attributegroups Update an attribute group
{
"Id": 4,
"Uid": "00000000-0000-0000-0000-000000000000",
"Alias": "MechanicalProperties",
"SortOrder": 4,
"Name": {
"en-GB": "Mechanical properties",
"da-DK": "Mekaniske egenskaber"
}
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| attributeGroup | body | object : AttributeGroup |
Updated attribute group |
| Property name | Data type | Description |
|---|---|---|
| Id | integer |
Unique id of attribute group |
| Uid | string |
Unique id of attribute group |
| Alias | string |
Unique alias of attribute group |
| SortOrder | integer |
Sort order of the attribute group used to sort attribute groups between each other |
| Name | object |
Localized name of attribute group used for displaying the attribute group on ex. a webshop (Dictionary of ISO culturecode and localized name) |
| BackofficeName | string |
The name of the attribute group displayed to the editor in the PIM backoffice |
| BackofficeDescription | string |
The description of the attribute group displayed to the editor in the PIM backoffice |
Response status OK (200)
POST /attributegroups Create an attribute group
{
"Id": 0,
"Uid": "0fe9c182-ad37-404c-91b3-f57cde46c932",
"Alias": "MechanicalProperties",
"SortOrder": 2,
"Name": {
"en-GB": "Mechanical properties",
"da-DK": "Mekaniske egenskaber"
}
}4Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| attributeGroup | body | object : AttributeGroup |
Attribute group to create |
| Property name | Data type | Description |
|---|---|---|
| Id | integer |
Unique id of attribute group |
| Uid | string |
Unique id of attribute group |
| Alias | string |
Unique alias of attribute group |
| SortOrder | integer |
Sort order of the attribute group used to sort attribute groups between each other |
| Name | object |
Localized name of attribute group used for displaying the attribute group on ex. a webshop (Dictionary of ISO culturecode and localized name) |
| BackofficeName | string |
The name of the attribute group displayed to the editor in the PIM backoffice |
| BackofficeDescription | string |
The description of the attribute group displayed to the editor in the PIM backoffice |
Response status OK (200)
DELETE /attributegroups Delete an attribute group
Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| id | query | integer |
Id of attribute group to delete |
Response status OK (200)
GET /attributegroups/{id} Get a attribute group from its id
{
"Id": 4,
"Uid": "0fe9c182-ad37-404c-91b3-f57cde46c932",
"Alias": "MechanicalProperties",
"SortOrder": 2,
"Name": {
"en-GB": "Mechanical properties",
"da-DK": "Mekaniske egenskaber"
}
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| id | path | integer |
Id of attribute group to get |
Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| Id | integer |
Unique id of attribute group |
| Uid | string |
Unique id of attribute group |
| Alias | string |
Unique alias of attribute group |
| SortOrder | integer |
Sort order of the attribute group used to sort attribute groups between each other |
| Name | object |
Localized name of attribute group used for displaying the attribute group on ex. a webshop (Dictionary of ISO culturecode and localized name) |
| BackofficeName | string |
The name of the attribute group displayed to the editor in the PIM backoffice |
| BackofficeDescription | string |
The description of the attribute group displayed to the editor in the PIM backoffice |