# Global lists
GET /GetGlobalListValuesByGlobalListId
See Attributes section for more info on attributes. When working with AttributeValues the API will only return the relevant data depending on what type the attributevalue is. All attributevalues contain the same metadata
{
"Attribute": {
"ValueIsTranslatable": false,
"UseRichText": false,
"TranslatedUnit": {
"LocalizedValues": [
{
"LanguageId": 1,
"LocalizedVal": "String"
},
{
"LanguageId": 2,
"LocalizedVal": "String"
}
]
},
"UnitIsTranslatable": false,
"Uid": "810be254-fd5d-4e28-a995-46df10ec1359",
"Alias": "String",
"BackofficeName": "String",
"BackofficeDescription": "String",
"Name": {
"LocalizedValues": [
{
"LanguageId": 1,
"LocalizedVal": "String"
},
{
"LanguageId": 2,
"LocalizedVal": "String"
}
]
},
"Description": {
"LocalizedValues": [
{
"LanguageId": 1,
"LocalizedVal": "String"
},
{
"LanguageId": 2,
"LocalizedVal": "String"
}
]
},
"WhichIsBetter": 5,
"AttributeType": "TextAttribute"
},
"GlobalListValues": [
{
"Uid": "628728bc-a2f7-4ee0-9ff4-7c6d544d913c",
"AttributeUid": "810be254-fd5d-4e28-a995-46df10ec1359",
"AttributeValueType": "TextAttributeValue",
"SortOrder": 1,
"Text": "String",
"IsLocalized": false,
"AttributeAlias": "String"
},
{
"Uid": "2a5f24f5-96b2-4635-b19a-df35ddf5aa55",
"AttributeUid": "810be254-fd5d-4e28-a995-46df10ec1359",
"AttributeValueType": "TextAttributeValue",
"SortOrder": 3,
"Text": "String",
"IsLocalized": false,
"AttributeAlias": "String"
},
{
"Uid": "bbcd1dab-a101-abb8-9896-14ebe732088b",
"AttributeUid": "810be254-fd5d-4e28-a995-46df10ec1359",
"AttributeValueType": "TextAttributeValue",
"SortOrder": 2,
"Text": "String",
"IsLocalized": false,
"AttributeAlias": "String"
}
]
}Request
Query parameters:
| Property name | Type | Description |
|---|---|---|
| id | int | Unique id for global list |
Response status OK (200)
Return value: GlobalList
| GlobalList | ||
|---|---|---|
| Property name | Type | Description |
| Attribute | Attribute | Attribute for global list |
| GlobalListValues | AttributeValue[] | Attributevalues for globallist |
| Attribute | ||
| Property name | Type | Description |
| Uid | Guid | Unique identifier of attribute |
| AttributeGroupId | int | Id of attribute group for attribute |
| Alias | string | Alias of attribute |
| BackofficeName | string | Name used in Umbraco backoffice for attribute |
| BackofficeDescription | string | Description used in Umbraco backoffice for attribute |
| Name | TranslatedValue<string> | Translated values of attribute name |
| Description | TranslatedValue<string> | Translated values of attribute Description |
| WhichIsBetter | int | Derived from enum value |
| AttributeType | string | The attribute type |
| AttributeValue | ||
| Property name | Type | Description |
| Uid | guid | Unique identifier for value |
| AttributeUid | guid | Unique identifier for attribute |
| AttributeValueType | string | Type of value as string |
| SortOrder | int | Sort order of value |
| AttributeAlias | string | Alias of the attribute. Properties for the AttributeValue will depend on this |
| IsTrue | bool | If value is true |
| CalculatedValue | string | Caluclated value if value can be calculated |
| LocalizedCalculatedValue | TranslatedValue<string> | localized value if the value is translateable |
| SubAttributeValues | AttributeValue[] | Array of sub attributes (ComplexAttributeValue) |
| DateTime | DateTimeOffset | Datetime value with timezone offset (DateTimeAttributeValue) |
| ReferencedAttributeValueUids | guid[] | Array of guids refering to another globallist attributevalues (FixedListAttributeValue) |
| ReferencedAttributeValues | AttributeValue[] | Array of attributevalues from another globallist (FixedListAttributeValue) |
| LocalizedImageId | TranslatedValue<int> | Localized value for image |
| ItemReferences | ProductReference[] | Array of productreferences (ProductAttributeValue) |
| LocalizedX | TranslatedValue<decimal> | translated decimal value. AttributeValueType: (LocalizedAreaAttributeValue, LocalizedRangeAttributeValue) |
| LocalizedY | TranslatedValue<decimal> | translated decimal value AttributeValueType: (LocalizedAreaAttributeValue, LocalizedRangeAttributeValue) |
| LocalizedZ | TranslatedValue<decimal> | translated decimal value AttributeValueType: (LocalizedAreaAttributeValue, LocalizedRangeAttributeValue) |
| LocalizedFrom | TranslatedValue<decimal> | translated decimal value |
| LocalizedTo | TranslatedValue<decimal> | translated decimal value |
| LocalizedMediaIds | TranslatedValue<int[]> | translated list of media ids |
| LocalizedContentIds | TranslatedValue<int[]> | translated list of content ids |
| From | decimal | |
| To | decimal | |
| LocalizedText | TranslatedValue<string> | Translated string values |
| Text | string | |
| X | decimal | AttributeValueType: (VolumeAttributeValue, AreaAttributeValue) |
| ProductReference | ||
| Property name | Type | Description |
| ItemId | string | Unique item id of referenced product |
| ItemName | string | Name of referenced product |
| ReferenceType | int | Reference type derived from Enum (ProductGroup = 10, Product = 20, Variant = 30, Collection = 40) |
| TranslatedValue<type> | ||
| Property name | Type | Description |
| LocalizedValues | LocalizedValue[] | List of translated names with language ids |
| LocalizedValue | ||
| Property name | Type | Description |
| LanguageId | int | Unique id of language |
| LocalizedVal | type | Value of variable type |
GET /GetGlobalListValuesByGlobalListAlias
See Attributes section for more info on attributes. When working with AttributeValues the API will only return the relevant data depending on what type the attributevalue is. All attributevalues contain the same metadata
{
"Attribute": {
"ValueIsTranslatable": false,
"UseRichText": false,
"TranslatedUnit": {
"LocalizedValues": [
{
"LanguageId": 1,
"LocalizedVal": "String"
},
{
"LanguageId": 2,
"LocalizedVal": "String"
}
]
},
"UnitIsTranslatable": false,
"Uid": "810be254-fd5d-4e28-a995-46df10ec1359",
"Alias": "String",
"BackofficeName": "String",
"BackofficeDescription": "String",
"Name": {
"LocalizedValues": [
{
"LanguageId": 1,
"LocalizedVal": "String"
},
{
"LanguageId": 2,
"LocalizedVal": "String"
}
]
},
"Description": {
"LocalizedValues": [
{
"LanguageId": 1,
"LocalizedVal": "String"
},
{
"LanguageId": 2,
"LocalizedVal": "String"
}
]
},
"WhichIsBetter": 5,
"AttributeType": "TextAttribute"
},
"GlobalListValues": [
{
"Uid": "628728bc-a2f7-4ee0-9ff4-7c6d544d913c",
"AttributeUid": "810be254-fd5d-4e28-a995-46df10ec1359",
"AttributeValueType": "TextAttributeValue",
"SortOrder": 1,
"Text": "String",
"IsLocalized": false,
"AttributeAlias": "String"
},
{
"Uid": "2a5f24f5-96b2-4635-b19a-df35ddf5aa55",
"AttributeUid": "810be254-fd5d-4e28-a995-46df10ec1359",
"AttributeValueType": "TextAttributeValue",
"SortOrder": 3,
"Text": "String",
"IsLocalized": false,
"AttributeAlias": "String"
},
{
"Uid": "bbcd1dab-a101-abb8-9896-14ebe732088b",
"AttributeUid": "810be254-fd5d-4e28-a995-46df10ec1359",
"AttributeValueType": "TextAttributeValue",
"SortOrder": 2,
"Text": "String",
"IsLocalized": false,
"AttributeAlias": "String"
}
]
}Request
Query parameters:
| Property name | Type | Description |
|---|---|---|
| alias | string | Unique alias for global list |
Response status OK (200)
Return value: GlobaList
| GlobalList | ||
|---|---|---|
| Property name | Type | Description |
| Attribute | Attribute | Attribute for global list |
| GlobalListValues | AttributeValue[] | Attributevalues for globallist |
| Attribute | ||
| Property name | Type | Description |
| Uid | Guid | Unique identifier of attribute |
| AttributeGroupId | int | Id of attribute group for attribute |
| Alias | string | Alias of attribute |
| BackofficeName | string | Name used in Umbraco backoffice for attribute |
| BackofficeDescription | string | Description used in Umbraco backoffice for attribute |
| Name | TranslatedValue<string> | Translated values of attribute name |
| Description | TranslatedValue<string> | Translated values of attribute Description |
| WhichIsBetter | int | Derived from enum value |
| AttributeType | string | The attribute type |
| AttributeValue | ||
| Property name | Type | Description |
| Uid | guid | Unique identifier for value |
| AttributeUid | guid | Unique identifier for attribute |
| AttributeValueType | string | Type of value as string |
| SortOrder | int | Sort order of value |
| AttributeAlias | string | Alias of the attribute. Properties for the AttributeValue will depend on this |
| IsTrue | bool | If value is true |
| CalculatedValue | string | Caluclated value if value can be calculated |
| LocalizedCalculatedValue | TranslatedValue<string> | localized value if the value is translateable |
| SubAttributeValues | AttributeValue[] | Array of sub attributes (ComplexAttributeValue) |
| DateTime | DateTimeOffset | Datetime value with timezone offset (DateTimeAttributeValue) |
| ReferencedAttributeValueUids | guid[] | Array of guids refering to another globallist attributevalues (FixedListAttributeValue) |
| ReferencedAttributeValues | AttributeValue[] | Array of attributevalues from another globallist (FixedListAttributeValue) |
| LocalizedImageId | TranslatedValue<int> | Localized value for image |
| ItemReferences | ProductReference[] | Array of productreferences (ProductAttributeValue) |
| LocalizedX | TranslatedValue<decimal> | translated decimal value. AttributeValueType: (LocalizedAreaAttributeValue, LocalizedRangeAttributeValue) |
| LocalizedY | TranslatedValue<decimal> | translated decimal value AttributeValueType: (LocalizedAreaAttributeValue, LocalizedRangeAttributeValue) |
| LocalizedZ | TranslatedValue<decimal> | translated decimal value AttributeValueType: (LocalizedAreaAttributeValue, LocalizedRangeAttributeValue) |
| LocalizedFrom | TranslatedValue<decimal> | translated decimal value |
| LocalizedTo | TranslatedValue<decimal> | translated decimal value |
| LocalizedMediaIds | TranslatedValue<int[]> | translated list of media ids |
| LocalizedContentIds | TranslatedValue<int[]> | translated list of content ids |
| From | decimal | |
| To | decimal | |
| LocalizedText | TranslatedValue<string> | Translated string values |
| Text | string | |
| X | decimal | AttributeValueType: (VolumeAttributeValue, AreaAttributeValue) |
| ProductReference | ||
| Property name | Type | Description |
| ItemId | string | Unique item id of referenced product |
| ItemName | string | Name of referenced product |
| ReferenceType | int | Reference type derived from Enum (ProductGroup = 10, Product = 20, Variant = 30, Collection = 40) |
| TranslatedValue<type> | ||
| Property name | Type | Description |
| LocalizedValues | LocalizedValue[] | List of translated names with language ids |
| LocalizedValue | ||
| Property name | Type | Description |
| LanguageId | int | Unique id of language |
| LocalizedVal | type | Value of variable type |
GET /GetGlobalLists
Request
Parameters: none
Response status OK (200)
Return value: GlobaList[]
| GlobalList | ||
|---|---|---|
| Property name | Type | Description |
| Id | int | Unique identifier of global list |
| Attribute | Attribute | Attribute definition for global list |
| ViewRequiresPermission | bool | True if global list requires permission to view |
| ManageRequiresPermission | bool | True if global list requires permission to edit |
| GlobalListKeys | Guid[] | Array of global list keys |
| Attribute | ||
| Property name | Type | Description |
| Uid | Guid | Unique identifier of attribute |
| AttributeGroupId | int | Id of attribute group for attribute |
| Alias | string | Alias of attribute |
| BackofficeName | string | Name used in Umbraco backoffice for attribute |
| BackofficeDescription | string | Description used in Umbraco backoffice for attribute |
| Name | TranslatedValue<string> | Translated values of attribute name |
| Description | TranslatedValue<string> | Translated values of attribute Description |
| WhichIsBetter | int | Derived from enum value |
| AttributeType | string | The attribute type |
| TranslatedValue<type> | ||
| Property name | Type | Description |
| LocalizedValues | LocalizedValue[] | List of translated names with language ids |
| LocalizedValue | ||
| Property name | Type | Description |
| LanguageId | int | Unique id of language |
| LocalizedVal | type | Value of variable type |
POST /CreateGlobalList
{
"Id": 0,
"Attribute": {
"Uid": "00000000-0000-0000-0000-000000000000",
"Alias": "string",
"BackofficeName": "string",
"BackofficeDescription": "string",
"Name": {
"LocalizedValues": [
{
"LanguageId": 0,
"LocalizedVal": "string"
}
]
},
"Description": {
"LocalizedValues": [
{
"LanguageId": 0,
"LocalizedVal": "string"
}
]
},
"WhichIsBetter": 0,
"AttributeGroupId": 0,
"Affiliation": 0,
"AttributeType": "string",
"ShowIfEmpty": true
},
"ViewRequiresPermission": true,
"ViewPermission": "00000000-0000-0000-0000-000000000000",
"ManageRequiresPermission": true,
"ManagePermission": "00000000-0000-0000-0000-000000000000",
"FolderUid": "00000000-0000-0000-0000-000000000000",
"GlobalListKeys": [
"00000000-0000-0000-0000-000000000000"
]
}Request
Body parameters: #GlobalList
| GlobalList | ||
|---|---|---|
| Property name | Type | Description |
| Id | int | Unique Id for global list |
| Attribute | Attribute | Attribute for global list |
| ViewRequiresPermission | bool | Determine if this global list requires specific permission to be viewed |
| ViewPermission | guid | If permission is required to view, send guid of required permission (optional) |
| ManageRequiresPermission | bool | Determine if this global list requires specific permission to be managed |
| ManagePermission | guid | If permission is required to manage, send guid of required permission (optional) |
| FolderUid | guid | Folder guid of designated importfolder (optional) |
| GlobalListKeys | guid[] | Global list keys as an array of guids |
| Attribute | ||
| Property name | Type | Description |
| Uid | guid | Unique identifier of attribute |
| AttributeGroupId | int | Id of attribute group for attribute |
| Alias | string | Alias of attribute |
| BackofficeName | string | Name used in Umbraco backoffice for attribute |
| BackofficeDescription | string | Description used in Umbraco backoffice for attribute |
| Name | TranslatedValue<string> | Translated values of attribute name |
| Description | TranslatedValue<string> | Translated values of attribute Description |
| WhichIsBetter | int | Derived from enum value |
| AttributeType | string | The attribute type |
Response status OK (200)
Return value: none
POST /UpdateGlobalList
{
"Id": 0,
"Attribute": {
"Uid": "00000000-0000-0000-0000-000000000000",
"Alias": "string",
"BackofficeName": "string",
"BackofficeDescription": "string",
"Name": {
"LocalizedValues": [
{
"LanguageId": 0,
"LocalizedVal": "string"
}
]
},
"Description": {
"LocalizedValues": [
{
"LanguageId": 0,
"LocalizedVal": "string"
}
]
},
"WhichIsBetter": 0,
"AttributeGroupId": 0,
"Affiliation": 0,
"AttributeType": "string",
"ShowIfEmpty": true
},
"ViewRequiresPermission": true,
"ViewPermission": "00000000-0000-0000-0000-000000000000",
"ManageRequiresPermission": true,
"ManagePermission": "00000000-0000-0000-0000-000000000000",
"FolderUid": "00000000-0000-0000-0000-000000000000",
"GlobalListKeys": [
"00000000-0000-0000-0000-000000000000"
]
}Request
Body parameters: GlobalList
| GlobalList | ||
|---|---|---|
| Property name | Type | Description |
| Id | int | Unique Id for global list |
| Attribute | Attribute | Attribute for global list |
| ViewRequiresPermission | bool | Determine if this global list requires specific permission to be viewed |
| ViewPermission | guid | If permission is required to view, send guid of required permission (optional) |
| ManageRequiresPermission | bool | Determine if this global list requires specific permission to be managed |
| ManagePermission | guid | If permission is required to manage, send guid of required permission (optional) |
| FolderUid | guid | Folder guid of designated importfolder (optional) |
| GlobalListKeys | guid[] | Global list keys as an array of guids |
| Attribute | ||
| Property name | Type | Description |
| Uid | guid | Unique identifier of attribute |
| AttributeGroupId | int | Id of attribute group for attribute |
| Alias | string | Alias of attribute |
| BackofficeName | string | Name used in Umbraco backoffice for attribute |
| BackofficeDescription | string | Description used in Umbraco backoffice for attribute |
| Name | TranslatedValue<string> | Translated values of attribute name |
| Description | TranslatedValue<string> | Translated values of attribute Description |
| WhichIsBetter | int | Derived from enum value |
| AttributeType | string | The attribute type |
Response status OK (200)
Return value: none
POST /DeleteGlobalList
Request
Query parameters:
| Property name | Type | Description |
|---|---|---|
| id | int | Unique id for global list |
Response status OK (200)
Return value: none
GET /GetGlobalListFolders
This endpoint will return an array of all global list folders in the PIM.
[
{
"Uid": "3fc73707-a841-4c92-a5b6-25e0d0a36100",
"Name": "String"
},
{
"Uid": "8e35870b-80b6-4d8d-b602-89b775da813e",
"Name": "String"
},
{
"Uid": "fd6ce1d0-8815-4c8c-a0da-a3d3c43d3664",
"Name": "String"
}
]Request
Parameters: none
Response status OK (200)
Return value: globalListFolder[]
| Property name | Type | Description |
|---|---|---|
| Uid | guid | Unique identifier for the folder |
| Name | string | Text string with the backoffice name |
POST /CreateGlobalListFolder
{
"Uid": "00000000-0000-0000-0000-000000000000",
"Name": "string"
}Request
Body parameters: GlobalListFolder
| Property name | Type | Description |
|---|---|---|
| Uid | guid | Unique identifier for the folder |
| Name | string | Text string with the backoffice name |
Response status OK (200)
Return value: none
POST /UpdateGlobalListFolder
{
"Uid": "00000000-0000-0000-0000-000000000000",
"Name": "string"
}Request
Body parameters: GlobalListFolder
| Property name | Type | Description |
|---|---|---|
| Uid | guid | Unique identifier for the folder |
| Name | string | Text string with the backoffice name |
Response status OK (200)
Return value: none
POST /DeleteGlobalListFolder
Request
Query parameters:
| Property name | Type | Description |
|---|---|---|
| uid | guid | Unique identifier of the global list folder |
Response status OK (200)
Return value: none
POST /CreateOrUpdateGlobalListValues
{
"GlobalListAlias": "string",
"GlobalListValues": [
{
"IsKey": true,
"IsParentKey": true,
"Alias": "string",
"Value": {},
"KeyHash": "string"
}
]
}Request
Body parameters: GlobalListCreateUpdateDTO
| GlobalListCreateUpdateDTO | ||
|---|---|---|
| Property name | Type | Description |
| GlobalListAlias | string | Alias of global list to create or update value in |
| GlobalListValues | ApiWriteObject[] | Array of values to create or update including meta data of the values |
| ApiWriteObject | ||
| Property name | Type | Description |
| IsKey | boolean | If the value is the key for determining if there is a value that should be updated |
| IsParentKey | boolean | If object is a key of a parent |
| Alias | string | Alias to identify what field the value is representing |
| Value | object | The value itself, the API accepts object that match the setup of the global list |
| KeyHash | string | |
Response status OK (200)
Return value: none
POST /DeleteGlobalListValues
{
"GlobalListAlias": "string",
"GlobalListValuesToDelete": [
{
"IsKey": true,
"IsParentKey": true,
"Alias": "string",
"Value": {},
"KeyHash": "string"
}
]
}Request
Body parameters: GlobalListDeleteDTO
| GlobalListDeleteDTO | ||
|---|---|---|
| Property name | Type | Description |
| GlobalListAlias | string | Alias of global list to create or update value in |
| GlobalListValuesToDelete | ApiWriteObject[] | Array of values to create or update including meta data of the values |
| ApiWriteObject | ||
| Property name | Type | Description |
| IsKey | boolean | If the value is the key for determining if there is a value that should be updated |
| IsParentKey | boolean | If object is a key of a parent |
| Alias | string | Alias to identify what field the value is representing |
| Value | object | The value itself, the API accepts object that match the setup of the global list |
| KeyHash | string | |