GlobalLists

Global lists define reusable object structures that can be referenced on products, variants, categories or within global lists themselves. A global list uses an attribute to define the data model for values in the global list. Using Complex attributes as the data model allows for complex value models for each global list value object.

Get all global lists created in the system

get

Authorizations

ApiKey

AuthorizationstringRequired

Responses

200

OK

application/json

Global list represents a global collection of reusable objects

Idinteger · int32Optional

Id of global list (readonly)

Uidstring · uuidOptional

Unique id of global list

ViewRequiresPermissionbooleanOptional

Indicates whether a special permission is required to view the global list

ViewPermissionstring · uuid · nullableOptional

Permission required to view the global list, if ViewRequiresPermission is set

CreateRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to create values in the global list

EditRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to update values in the global list

DeleteRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to delete values in the global list

CreatePermissionstring · uuid · nullableOptional

Permission required to create values in the global list, if CreateRequiresPermission is set

EditPermissionstring · uuid · nullableOptional

Permission required to update values in the global list, if EditRequiresPermission is set

DeletePermissionstring · uuid · nullableOptional

Permission required to delete values in the global list, if DeleteRequiresPermission is set

FolderUidstring · uuid · nullableOptional

Uid of folder to place global list in

RequiresSortingbooleanOptional

Defines if values on a global list values should be sorted on creation

GlobalListKeysstring[] · nullableOptional

Defines data elements of the global list, which in combination must be unique across all values of the this global list (format: [rootAttributeUid][subAttributeUid][LanguageId/NA]_[DimensionSegmentUid/NA] - ex. 17ca35af-9cb9-44a2-a2f4-1d30a3617e01_2ee6ac86-77d0-4385-94b7-84dd59e05d0b_NA_NA)

KeyIsCaseInsensitivebooleanOptional

Defines if key value for a global list value is case insensitive

get

/v1/GlobalLists

HTTPcURLJavaScriptPython

GET /v1/GlobalLists HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "Id": 10,
    "Uid": "ca0da146-2c22-4917-9d9c-a48885f50178",
    "Attribute": {
      "SubAttributes": [
        {
          "UseMultiRowInput": false,
          "InputHeight": null,
          "UseRichText": false,
          "RichTextToolbarOptions": [],
          "RegEx": null,
          "RegExDescription": null,
          "Unit": null,
          "ShowCharacterCount": false,
          "MaxLength": null,
          "EnableAIAssistant": false,
          "Uid": "444c6fcd-4b23-4edc-8c8c-467c3ee691bb",
          "Alias": "Name",
          "BackofficeName": "Name",
          "BackofficeDescription": "Localized name of color",
          "Name": {
            "en-GB": "Name",
            "da-DK": "Navn"
          },
          "Description": {},
          "AttributeGroupUid": "7c5183df-2559-47bd-9dd3-330aa3f2b887",
          "AttributeScopes": [],
          "Localized": true,
          "FallbackLanguage": null,
          "DimensionUid": "547c2579-b569-4f0b-a7b3-068b75c38af3",
          "FallbackSegment": "d222bf2f-319a-4715-a099-2a0b6b320f54",
          "ReadOnly": false,
          "Mandatory": false,
          "Columns": 0,
          "Unchangeable": false,
          "AttributeType": "TextAttribute",
          "DisableRevisionLogging": false,
          "DisableIndexing": false
        },
        {
          "UseMultiRowInput": false,
          "InputHeight": null,
          "UseRichText": false,
          "RichTextToolbarOptions": [],
          "RegEx": null,
          "RegExDescription": null,
          "Unit": null,
          "ShowCharacterCount": false,
          "MaxLength": null,
          "EnableAIAssistant": false,
          "Uid": "a8d42b49-4735-4abe-99ae-69b06a2bc342",
          "Alias": "HEXcolor",
          "BackofficeName": "HEX color",
          "BackofficeDescription": "Add a HEX color which can be used to display a color swatch",
          "Name": {},
          "Description": {},
          "AttributeGroupUid": "0f82877c-0e0b-4dbd-9cb3-691df130b9d3",
          "AttributeScopes": [],
          "Localized": false,
          "FallbackLanguage": null,
          "DimensionUid": "934a2bee-5307-4c34-b2bc-0f692d3d8d0e",
          "FallbackSegment": "2f0cbf34-14dd-4fe3-ab19-b5272a542434",
          "ReadOnly": false,
          "Mandatory": false,
          "Columns": 0,
          "Unchangeable": false,
          "AttributeType": "TextAttribute",
          "DisableRevisionLogging": false,
          "DisableIndexing": false
        }
      ],
      "RenderValuesForAttributeFieldUids": [
        "444c6fcd-4b23-4edc-8c8c-467c3ee691bb"
      ],
      "RenderValuesForBackofficeAttributeFieldUids": [
        "444c6fcd-4b23-4edc-8c8c-467c3ee691bb"
      ],
      "RenderedValueSeparator": null,
      "RenderedValueInBackofficeSeparator": null,
      "Uid": "ca0da146-2c22-4917-9d9c-a48885f50178",
      "Alias": "Colors",
      "BackofficeName": "Colors",
      "BackofficeDescription": "Colors variants in the system",
      "Name": {
        "en-GB": "Colors",
        "da-DK": "Farver"
      },
      "Description": {
        "en-GB": "Colors that products can take",
        "da-DK": "Farver produkter kan antage"
      },
      "AttributeGroupUid": "ba2c7743-554d-45c2-a876-96a2906127e0",
      "AttributeScopes": [],
      "Localized": false,
      "FallbackLanguage": null,
      "DimensionUid": "dd40f88c-2c47-41eb-8e43-b843f36f349b",
      "FallbackSegment": "c18a8bf0-0371-4c22-b42b-0b425c24e850",
      "ReadOnly": false,
      "Mandatory": false,
      "Columns": 0,
      "Unchangeable": false,
      "AttributeType": "ComplexAttribute",
      "DisableRevisionLogging": false,
      "DisableIndexing": false
    },
    "ViewRequiresPermission": true,
    "ViewPermission": "0df87ff3-b620-4e99-a60d-de16c1237542",
    "CreateRequiresPermission": true,
    "EditRequiresPermission": true,
    "DeleteRequiresPermission": true,
    "CreatePermission": "32058a53-7bed-4fa2-a721-42d97cb4a6f1",
    "EditPermission": "5ec9a2fa-1e90-4f0e-941b-c299a1be5a8e",
    "DeletePermission": "dc0d8d00-a7c1-410e-b6b5-65d32dacecba",
    "FolderUid": "6dadd4fd-46c8-4880-a8df-a7f426579120",
    "RequiresSorting": false,
    "GlobalListKeys": null,
    "KeyIsCaseInsensitive": false,
    "AvailableInApps": []
  },
  {
    "Id": 11,
    "Uid": "067fadf2-9fce-4d51-b4af-65f7ce7eeb9d",
    "Attribute": {
      "UseMultiRowInput": false,
      "InputHeight": null,
      "UseRichText": false,
      "RichTextToolbarOptions": [],
      "RegEx": null,
      "RegExDescription": null,
      "Unit": null,
      "ShowCharacterCount": false,
      "MaxLength": null,
      "EnableAIAssistant": false,
      "Uid": "067fadf2-9fce-4d51-b4af-65f7ce7eeb9d",
      "Alias": "ProductStatusses",
      "BackofficeName": "Product statusses",
      "BackofficeDescription": "Manage statusses that products can have",
      "Name": {},
      "Description": {},
      "AttributeGroupUid": "159acec4-0cb9-437e-ad63-a12dbde7c853",
      "AttributeScopes": [],
      "Localized": false,
      "FallbackLanguage": null,
      "DimensionUid": "b419d9ed-0744-4f6e-a26b-dc4e86c062d2",
      "FallbackSegment": "77cfe32f-b807-435a-9195-f00be15ddba3",
      "ReadOnly": false,
      "Mandatory": false,
      "Columns": 0,
      "Unchangeable": false,
      "AttributeType": "TextAttribute",
      "DisableRevisionLogging": false,
      "DisableIndexing": false
    },
    "ViewRequiresPermission": false,
    "ViewPermission": "69f4b118-7469-4812-8a56-9868435e172b",
    "CreateRequiresPermission": false,
    "EditRequiresPermission": false,
    "DeleteRequiresPermission": false,
    "CreatePermission": "8bca1372-38ac-412c-8b2a-83d97986a776",
    "EditPermission": "0867aa28-5829-41e8-99b6-ce4b0094b999",
    "DeletePermission": "63cb3f41-8d46-44a0-8f26-6a288f2b1b0b",
    "FolderUid": "08b522d8-eb4a-4db0-824e-f5bf2926d786",
    "RequiresSorting": false,
    "GlobalListKeys": null,
    "KeyIsCaseInsensitive": false,
    "AvailableInApps": []
  }
]

Create a new global list

post

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Global list represents a global collection of reusable objects

Idinteger · int32Optional

Id of global list (readonly)

Uidstring · uuidOptional

Unique id of global list

ViewRequiresPermissionbooleanOptional

Indicates whether a special permission is required to view the global list

ViewPermissionstring · uuid · nullableOptional

Permission required to view the global list, if ViewRequiresPermission is set

CreateRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to create values in the global list

EditRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to update values in the global list

DeleteRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to delete values in the global list

CreatePermissionstring · uuid · nullableOptional

Permission required to create values in the global list, if CreateRequiresPermission is set

EditPermissionstring · uuid · nullableOptional

Permission required to update values in the global list, if EditRequiresPermission is set

DeletePermissionstring · uuid · nullableOptional

Permission required to delete values in the global list, if DeleteRequiresPermission is set

FolderUidstring · uuid · nullableOptional

Uid of folder to place global list in

RequiresSortingbooleanOptional

Defines if values on a global list values should be sorted on creation

GlobalListKeysstring[] · nullableOptional

Defines data elements of the global list, which in combination must be unique across all values of the this global list (format: [rootAttributeUid][subAttributeUid][LanguageId/NA]_[DimensionSegmentUid/NA] - ex. 17ca35af-9cb9-44a2-a2f4-1d30a3617e01_2ee6ac86-77d0-4385-94b7-84dd59e05d0b_NA_NA)

KeyIsCaseInsensitivebooleanOptional

Defines if key value for a global list value is case insensitive

Responses

201

Created

application/json

400

Bad Request

application/json

post

/v1/GlobalLists

HTTPcURLJavaScriptPython

POST /v1/GlobalLists HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3090

{
  "Id": 10,
  "Uid": "87ccceed-119f-4c71-b917-62a3a3c4f59c",
  "Attribute": {
    "SubAttributes": [
      {
        "UseMultiRowInput": false,
        "InputHeight": null,
        "UseRichText": false,
        "RichTextToolbarOptions": [],
        "RegEx": null,
        "RegExDescription": null,
        "Unit": null,
        "ShowCharacterCount": false,
        "MaxLength": null,
        "EnableAIAssistant": false,
        "Uid": "7c80a383-d78f-49be-bbd0-b08660c3746c",
        "Alias": "Name",
        "BackofficeName": "Name",
        "BackofficeDescription": "Localized name of color",
        "Name": {
          "en-GB": "Name",
          "da-DK": "Navn"
        },
        "Description": {},
        "AttributeGroupUid": "49356f92-5ce9-4924-80a1-b3704da7ce4b",
        "AttributeScopes": [],
        "Localized": true,
        "FallbackLanguage": null,
        "DimensionUid": "1f916cfb-628f-493b-b9bd-aeeed95678d3",
        "FallbackSegment": "7c504b28-aa2c-4399-82f1-e2aae847a5d0",
        "ReadOnly": false,
        "Mandatory": false,
        "Columns": 0,
        "Unchangeable": false,
        "AttributeType": "TextAttribute",
        "DisableRevisionLogging": false,
        "DisableIndexing": false
      },
      {
        "UseMultiRowInput": false,
        "InputHeight": null,
        "UseRichText": false,
        "RichTextToolbarOptions": [],
        "RegEx": null,
        "RegExDescription": null,
        "Unit": null,
        "ShowCharacterCount": false,
        "MaxLength": null,
        "EnableAIAssistant": false,
        "Uid": "d3d9d364-5967-46ea-93db-85a6921cd7bc",
        "Alias": "HEXcolor",
        "BackofficeName": "HEX color",
        "BackofficeDescription": "Add a HEX color which can be used to display a color swatch",
        "Name": {},
        "Description": {},
        "AttributeGroupUid": "f066924f-93f0-4e77-8c6b-591fdcbb2dc7",
        "AttributeScopes": [],
        "Localized": false,
        "FallbackLanguage": null,
        "DimensionUid": "b16e9daf-0bd3-435e-8348-57ae0bca1a79",
        "FallbackSegment": "97c040ee-78dc-4025-80f4-fe93157889a9",
        "ReadOnly": false,
        "Mandatory": false,
        "Columns": 0,
        "Unchangeable": false,
        "AttributeType": "TextAttribute",
        "DisableRevisionLogging": false,
        "DisableIndexing": false
      }
    ],
    "RenderValuesForAttributeFieldUids": [
      "7c80a383-d78f-49be-bbd0-b08660c3746c"
    ],
    "RenderValuesForBackofficeAttributeFieldUids": [
      "7c80a383-d78f-49be-bbd0-b08660c3746c"
    ],
    "RenderedValueSeparator": null,
    "RenderedValueInBackofficeSeparator": null,
    "Uid": "87ccceed-119f-4c71-b917-62a3a3c4f59c",
    "Alias": "Colors",
    "BackofficeName": "Colors",
    "BackofficeDescription": "Colors variants in the system",
    "Name": {
      "en-GB": "Colors",
      "da-DK": "Farver"
    },
    "Description": {
      "en-GB": "Colors that products can take",
      "da-DK": "Farver produkter kan antage"
    },
    "AttributeGroupUid": "ebb7b017-cbfc-415f-b042-f06c32665690",
    "AttributeScopes": [],
    "Localized": false,
    "FallbackLanguage": null,
    "DimensionUid": "16d45270-1f28-4977-9d66-8adeae747911",
    "FallbackSegment": "af398470-c7a9-4930-9a3b-b3fc680a6816",
    "ReadOnly": false,
    "Mandatory": false,
    "Columns": 0,
    "Unchangeable": false,
    "AttributeType": "ComplexAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false
  },
  "ViewRequiresPermission": true,
  "ViewPermission": "5a2a3c07-f8c7-428b-90d7-513f58fdb796",
  "CreateRequiresPermission": true,
  "EditRequiresPermission": true,
  "DeleteRequiresPermission": true,
  "CreatePermission": "9064b68f-8af8-41b8-aa3b-4e904e993c72",
  "EditPermission": "1df3517d-66c3-4923-a9dc-80a0e3434688",
  "DeletePermission": "29a8b39f-fa27-4d7b-a761-f7beddd93711",
  "FolderUid": "4fffed81-15a2-4d76-b3ba-0db691768ceb",
  "RequiresSorting": false,
  "GlobalListKeys": null,
  "KeyIsCaseInsensitive": false,
  "AvailableInApps": []
}

[
  {
    "Id": 10,
    "Uid": "04e2b6f6-ee69-400d-8342-1665ff39c709",
    "Attribute": {
      "SubAttributes": [
        {
          "UseMultiRowInput": false,
          "InputHeight": null,
          "UseRichText": false,
          "RichTextToolbarOptions": [],
          "RegEx": null,
          "RegExDescription": null,
          "Unit": null,
          "ShowCharacterCount": false,
          "MaxLength": null,
          "EnableAIAssistant": false,
          "Uid": "061660fc-0489-43eb-a66c-1da8fc5660d2",
          "Alias": "Name",
          "BackofficeName": "Name",
          "BackofficeDescription": "Localized name of color",
          "Name": {
            "en-GB": "Name",
            "da-DK": "Navn"
          },
          "Description": {},
          "AttributeGroupUid": "c625abb0-7ee4-42bc-a80d-55b7338ab9c4",
          "AttributeScopes": [],
          "Localized": true,
          "FallbackLanguage": null,
          "DimensionUid": "e7a93884-f5ea-496e-b595-22c7c8fbaa84",
          "FallbackSegment": "eaf24072-1692-473f-9c96-c93aafd79b98",
          "ReadOnly": false,
          "Mandatory": false,
          "Columns": 0,
          "Unchangeable": false,
          "AttributeType": "TextAttribute",
          "DisableRevisionLogging": false,
          "DisableIndexing": false
        },
        {
          "UseMultiRowInput": false,
          "InputHeight": null,
          "UseRichText": false,
          "RichTextToolbarOptions": [],
          "RegEx": null,
          "RegExDescription": null,
          "Unit": null,
          "ShowCharacterCount": false,
          "MaxLength": null,
          "EnableAIAssistant": false,
          "Uid": "96ab810f-71cf-4147-ad2a-d2d508e27c63",
          "Alias": "HEXcolor",
          "BackofficeName": "HEX color",
          "BackofficeDescription": "Add a HEX color which can be used to display a color swatch",
          "Name": {},
          "Description": {},
          "AttributeGroupUid": "b01149ff-5770-4f5d-8388-12deff22c6e5",
          "AttributeScopes": [],
          "Localized": false,
          "FallbackLanguage": null,
          "DimensionUid": "6d05802c-0d38-401a-9730-582d06080862",
          "FallbackSegment": "67647131-eb3a-44a4-8908-dec4e1146941",
          "ReadOnly": false,
          "Mandatory": false,
          "Columns": 0,
          "Unchangeable": false,
          "AttributeType": "TextAttribute",
          "DisableRevisionLogging": false,
          "DisableIndexing": false
        }
      ],
      "RenderValuesForAttributeFieldUids": [
        "061660fc-0489-43eb-a66c-1da8fc5660d2"
      ],
      "RenderValuesForBackofficeAttributeFieldUids": [
        "061660fc-0489-43eb-a66c-1da8fc5660d2"
      ],
      "RenderedValueSeparator": null,
      "RenderedValueInBackofficeSeparator": null,
      "Uid": "04e2b6f6-ee69-400d-8342-1665ff39c709",
      "Alias": "Colors",
      "BackofficeName": "Colors",
      "BackofficeDescription": "Colors variants in the system",
      "Name": {
        "en-GB": "Colors",
        "da-DK": "Farver"
      },
      "Description": {
        "en-GB": "Colors that products can take",
        "da-DK": "Farver produkter kan antage"
      },
      "AttributeGroupUid": "6aa096de-892d-4cd4-9010-83e36263ddc6",
      "AttributeScopes": [],
      "Localized": false,
      "FallbackLanguage": null,
      "DimensionUid": "afc0013e-34ad-4e9f-96b8-440c423b7e3a",
      "FallbackSegment": "9d19763b-0ba8-41bb-bafb-b4c9d8e22869",
      "ReadOnly": false,
      "Mandatory": false,
      "Columns": 0,
      "Unchangeable": false,
      "AttributeType": "ComplexAttribute",
      "DisableRevisionLogging": false,
      "DisableIndexing": false
    },
    "ViewRequiresPermission": true,
    "ViewPermission": "0de0757e-125a-4f6c-b020-c8932ef7f394",
    "CreateRequiresPermission": true,
    "EditRequiresPermission": true,
    "DeleteRequiresPermission": true,
    "CreatePermission": "9bcdf9d7-db3d-4863-8e24-a87cc93dbc87",
    "EditPermission": "8941f534-f6a8-4ff6-80c2-b7c64cb9571e",
    "DeletePermission": "1562ca07-9765-40e1-b87b-3d4ebe03dad9",
    "FolderUid": "9a40b0fa-ec62-43b6-94fa-ae1a8c3fda18",
    "RequiresSorting": false,
    "GlobalListKeys": null,
    "KeyIsCaseInsensitive": false,
    "AvailableInApps": []
  },
  {
    "Id": 11,
    "Uid": "3befd94a-106a-44ff-b5d2-3830575f0b5c",
    "Attribute": {
      "UseMultiRowInput": false,
      "InputHeight": null,
      "UseRichText": false,
      "RichTextToolbarOptions": [],
      "RegEx": null,
      "RegExDescription": null,
      "Unit": null,
      "ShowCharacterCount": false,
      "MaxLength": null,
      "EnableAIAssistant": false,
      "Uid": "3befd94a-106a-44ff-b5d2-3830575f0b5c",
      "Alias": "ProductStatusses",
      "BackofficeName": "Product statusses",
      "BackofficeDescription": "Manage statusses that products can have",
      "Name": {},
      "Description": {},
      "AttributeGroupUid": "7fa1e05c-1b29-46a4-ab39-d444ce4d00e2",
      "AttributeScopes": [],
      "Localized": false,
      "FallbackLanguage": null,
      "DimensionUid": "7285583c-97ee-4bb1-b202-b844e5b42b88",
      "FallbackSegment": "bb11f9d3-8803-4cbf-8b32-c6fa2564cd98",
      "ReadOnly": false,
      "Mandatory": false,
      "Columns": 0,
      "Unchangeable": false,
      "AttributeType": "TextAttribute",
      "DisableRevisionLogging": false,
      "DisableIndexing": false
    },
    "ViewRequiresPermission": false,
    "ViewPermission": "fe2971cb-ad7a-44f3-8fbe-f72cbf0b4e3a",
    "CreateRequiresPermission": false,
    "EditRequiresPermission": false,
    "DeleteRequiresPermission": false,
    "CreatePermission": "8d45fb0d-3298-4764-8f38-6081ef083d47",
    "EditPermission": "4ed5b69d-56ab-4e85-89ff-8dbbb01f86ef",
    "DeletePermission": "602b7ce3-7072-4302-b601-6902f0979654",
    "FolderUid": "6a6daedf-d15e-47c9-9ce1-f26ef05c8492",
    "RequiresSorting": false,
    "GlobalListKeys": null,
    "KeyIsCaseInsensitive": false,
    "AvailableInApps": []
  }
]

Update a global list

put

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Global list represents a global collection of reusable objects

Idinteger · int32Optional

Id of global list (readonly)

Uidstring · uuidOptional

Unique id of global list

ViewRequiresPermissionbooleanOptional

Indicates whether a special permission is required to view the global list

ViewPermissionstring · uuid · nullableOptional

Permission required to view the global list, if ViewRequiresPermission is set

CreateRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to create values in the global list

EditRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to update values in the global list

DeleteRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to delete values in the global list

CreatePermissionstring · uuid · nullableOptional

Permission required to create values in the global list, if CreateRequiresPermission is set

EditPermissionstring · uuid · nullableOptional

Permission required to update values in the global list, if EditRequiresPermission is set

DeletePermissionstring · uuid · nullableOptional

Permission required to delete values in the global list, if DeleteRequiresPermission is set

FolderUidstring · uuid · nullableOptional

Uid of folder to place global list in

RequiresSortingbooleanOptional

Defines if values on a global list values should be sorted on creation

GlobalListKeysstring[] · nullableOptional

Defines data elements of the global list, which in combination must be unique across all values of the this global list (format: [rootAttributeUid][subAttributeUid][LanguageId/NA]_[DimensionSegmentUid/NA] - ex. 17ca35af-9cb9-44a2-a2f4-1d30a3617e01_2ee6ac86-77d0-4385-94b7-84dd59e05d0b_NA_NA)

KeyIsCaseInsensitivebooleanOptional

Defines if key value for a global list value is case insensitive

Responses

200

OK

No content

put

/v1/GlobalLists

HTTPcURLJavaScriptPython

PUT /v1/GlobalLists HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3090

{
  "Id": 10,
  "Uid": "52c9d7bd-1747-44ea-b3ae-5ed193e3352c",
  "Attribute": {
    "SubAttributes": [
      {
        "UseMultiRowInput": false,
        "InputHeight": null,
        "UseRichText": false,
        "RichTextToolbarOptions": [],
        "RegEx": null,
        "RegExDescription": null,
        "Unit": null,
        "ShowCharacterCount": false,
        "MaxLength": null,
        "EnableAIAssistant": false,
        "Uid": "df73eb74-315e-4600-aea7-774cfbe5fc30",
        "Alias": "Name",
        "BackofficeName": "Name",
        "BackofficeDescription": "Localized name of color",
        "Name": {
          "en-GB": "Name",
          "da-DK": "Navn"
        },
        "Description": {},
        "AttributeGroupUid": "a65184a0-bce1-41dd-a8a4-a15760593e8f",
        "AttributeScopes": [],
        "Localized": true,
        "FallbackLanguage": null,
        "DimensionUid": "accd4dcb-9c40-49b4-9dbf-d674ba4a2184",
        "FallbackSegment": "dec49606-e4b0-41fd-8f6f-b0108eb46952",
        "ReadOnly": false,
        "Mandatory": false,
        "Columns": 0,
        "Unchangeable": false,
        "AttributeType": "TextAttribute",
        "DisableRevisionLogging": false,
        "DisableIndexing": false
      },
      {
        "UseMultiRowInput": false,
        "InputHeight": null,
        "UseRichText": false,
        "RichTextToolbarOptions": [],
        "RegEx": null,
        "RegExDescription": null,
        "Unit": null,
        "ShowCharacterCount": false,
        "MaxLength": null,
        "EnableAIAssistant": false,
        "Uid": "1c726a21-0679-46f1-a2f3-8fdf71bac761",
        "Alias": "HEXcolor",
        "BackofficeName": "HEX color",
        "BackofficeDescription": "Add a HEX color which can be used to display a color swatch",
        "Name": {},
        "Description": {},
        "AttributeGroupUid": "172173a2-48b7-4d9e-a446-501695385629",
        "AttributeScopes": [],
        "Localized": false,
        "FallbackLanguage": null,
        "DimensionUid": "48df43ea-33f3-46df-ae31-76519ce470d8",
        "FallbackSegment": "156fc0c3-48b4-44f0-875e-526e2b021ffd",
        "ReadOnly": false,
        "Mandatory": false,
        "Columns": 0,
        "Unchangeable": false,
        "AttributeType": "TextAttribute",
        "DisableRevisionLogging": false,
        "DisableIndexing": false
      }
    ],
    "RenderValuesForAttributeFieldUids": [
      "df73eb74-315e-4600-aea7-774cfbe5fc30"
    ],
    "RenderValuesForBackofficeAttributeFieldUids": [
      "df73eb74-315e-4600-aea7-774cfbe5fc30"
    ],
    "RenderedValueSeparator": null,
    "RenderedValueInBackofficeSeparator": null,
    "Uid": "52c9d7bd-1747-44ea-b3ae-5ed193e3352c",
    "Alias": "Colors",
    "BackofficeName": "Colors",
    "BackofficeDescription": "Colors variants in the system",
    "Name": {
      "en-GB": "Colors",
      "da-DK": "Farver"
    },
    "Description": {
      "en-GB": "Colors that products can take",
      "da-DK": "Farver produkter kan antage"
    },
    "AttributeGroupUid": "a7e72d9e-5f8f-4d56-8b4d-bcde115c609b",
    "AttributeScopes": [],
    "Localized": false,
    "FallbackLanguage": null,
    "DimensionUid": "ca2a99b8-7a87-4cab-8842-0e05bda95d2e",
    "FallbackSegment": "cffdc73c-142c-4666-89be-7da139e741d6",
    "ReadOnly": false,
    "Mandatory": false,
    "Columns": 0,
    "Unchangeable": false,
    "AttributeType": "ComplexAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false
  },
  "ViewRequiresPermission": true,
  "ViewPermission": "d788a26d-22f9-4c25-85ce-50d28b3a64fa",
  "CreateRequiresPermission": true,
  "EditRequiresPermission": true,
  "DeleteRequiresPermission": true,
  "CreatePermission": "8e6cd07f-d2e6-41d4-9453-336707ad437d",
  "EditPermission": "742a7dfa-f9af-469f-a67c-1854aab6fcd2",
  "DeletePermission": "b11c9133-f0bf-483e-bad3-cad939655958",
  "FolderUid": "f58a64ca-211e-4f35-aa0b-4b6ca890e117",
  "RequiresSorting": false,
  "GlobalListKeys": null,
  "KeyIsCaseInsensitive": false,
  "AvailableInApps": []
}

200

OK

No content

Delete a global list

delete

Authorizations

ApiKey

AuthorizationstringRequired

Query parameters

uidstring · uuidOptional

the Unique id of the global list

Responses

200

OK

No content

delete

/v1/GlobalLists

HTTPcURLJavaScriptPython

DELETE /v1/GlobalLists HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

No content

Get a specific global list

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Unique id of global list

Responses

200

OK

application/json

Global list represents a global collection of reusable objects

Idinteger · int32Optional

Id of global list (readonly)

Uidstring · uuidOptional

Unique id of global list

ViewRequiresPermissionbooleanOptional

Indicates whether a special permission is required to view the global list

ViewPermissionstring · uuid · nullableOptional

Permission required to view the global list, if ViewRequiresPermission is set

CreateRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to create values in the global list

EditRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to update values in the global list

DeleteRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to delete values in the global list

CreatePermissionstring · uuid · nullableOptional

Permission required to create values in the global list, if CreateRequiresPermission is set

EditPermissionstring · uuid · nullableOptional

Permission required to update values in the global list, if EditRequiresPermission is set

DeletePermissionstring · uuid · nullableOptional

Permission required to delete values in the global list, if DeleteRequiresPermission is set

FolderUidstring · uuid · nullableOptional

Uid of folder to place global list in

RequiresSortingbooleanOptional

Defines if values on a global list values should be sorted on creation

GlobalListKeysstring[] · nullableOptional

Defines data elements of the global list, which in combination must be unique across all values of the this global list (format: [rootAttributeUid][subAttributeUid][LanguageId/NA]_[DimensionSegmentUid/NA] - ex. 17ca35af-9cb9-44a2-a2f4-1d30a3617e01_2ee6ac86-77d0-4385-94b7-84dd59e05d0b_NA_NA)

KeyIsCaseInsensitivebooleanOptional

Defines if key value for a global list value is case insensitive

get

/v1/GlobalLists/{uid}

HTTPcURLJavaScriptPython

GET /v1/GlobalLists/{uid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "Id": 10,
  "Uid": "244d6305-2efd-41fd-97b3-eb0baf84b1ac",
  "Attribute": {
    "SubAttributes": [
      {
        "UseMultiRowInput": false,
        "InputHeight": null,
        "UseRichText": false,
        "RichTextToolbarOptions": [],
        "RegEx": null,
        "RegExDescription": null,
        "Unit": null,
        "ShowCharacterCount": false,
        "MaxLength": null,
        "EnableAIAssistant": false,
        "Uid": "3226a56d-5793-42fe-9b1e-6606b4426cdd",
        "Alias": "Name",
        "BackofficeName": "Name",
        "BackofficeDescription": "Localized name of color",
        "Name": {
          "en-GB": "Name",
          "da-DK": "Navn"
        },
        "Description": {},
        "AttributeGroupUid": "a9890b73-5892-4af3-b4ae-230f6ac04589",
        "AttributeScopes": [],
        "Localized": true,
        "FallbackLanguage": null,
        "DimensionUid": "6ba09d4e-5f14-4a6b-9476-433ae749bfbf",
        "FallbackSegment": "468aad0c-f5c7-4df9-b409-3bea836aa008",
        "ReadOnly": false,
        "Mandatory": false,
        "Columns": 0,
        "Unchangeable": false,
        "AttributeType": "TextAttribute",
        "DisableRevisionLogging": false,
        "DisableIndexing": false
      },
      {
        "UseMultiRowInput": false,
        "InputHeight": null,
        "UseRichText": false,
        "RichTextToolbarOptions": [],
        "RegEx": null,
        "RegExDescription": null,
        "Unit": null,
        "ShowCharacterCount": false,
        "MaxLength": null,
        "EnableAIAssistant": false,
        "Uid": "4a216823-9bf4-4a63-a2ab-d2cf879252e1",
        "Alias": "HEXcolor",
        "BackofficeName": "HEX color",
        "BackofficeDescription": "Add a HEX color which can be used to display a color swatch",
        "Name": {},
        "Description": {},
        "AttributeGroupUid": "de5b0917-1050-4e09-980d-761334236fa6",
        "AttributeScopes": [],
        "Localized": false,
        "FallbackLanguage": null,
        "DimensionUid": "09c65179-9464-48c9-83db-31be21284f36",
        "FallbackSegment": "a1402920-df50-43e6-a0e8-75d6399f2a04",
        "ReadOnly": false,
        "Mandatory": false,
        "Columns": 0,
        "Unchangeable": false,
        "AttributeType": "TextAttribute",
        "DisableRevisionLogging": false,
        "DisableIndexing": false
      }
    ],
    "RenderValuesForAttributeFieldUids": [
      "3226a56d-5793-42fe-9b1e-6606b4426cdd"
    ],
    "RenderValuesForBackofficeAttributeFieldUids": [
      "3226a56d-5793-42fe-9b1e-6606b4426cdd"
    ],
    "RenderedValueSeparator": null,
    "RenderedValueInBackofficeSeparator": null,
    "Uid": "244d6305-2efd-41fd-97b3-eb0baf84b1ac",
    "Alias": "Colors",
    "BackofficeName": "Colors",
    "BackofficeDescription": "Colors variants in the system",
    "Name": {
      "en-GB": "Colors",
      "da-DK": "Farver"
    },
    "Description": {
      "en-GB": "Colors that products can take",
      "da-DK": "Farver produkter kan antage"
    },
    "AttributeGroupUid": "b2d83e8b-c037-4c3d-a8e0-063258f96ec9",
    "AttributeScopes": [],
    "Localized": false,
    "FallbackLanguage": null,
    "DimensionUid": "b91b262c-3202-48bb-a803-7492709911a0",
    "FallbackSegment": "c06eed67-080b-4f79-b9f0-0107f702f389",
    "ReadOnly": false,
    "Mandatory": false,
    "Columns": 0,
    "Unchangeable": false,
    "AttributeType": "ComplexAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false
  },
  "ViewRequiresPermission": true,
  "ViewPermission": "77ef3231-dff7-469a-bc46-6750002be2b6",
  "CreateRequiresPermission": true,
  "EditRequiresPermission": true,
  "DeleteRequiresPermission": true,
  "CreatePermission": "8a7c4877-fac2-4393-9da9-6e847c81ffd5",
  "EditPermission": "e2a417db-17d5-4a9f-b5f7-8345b0904584",
  "DeletePermission": "2bc9a446-62e6-4e60-8293-0f508144783c",
  "FolderUid": "ad165fde-c8ba-492a-81f3-7e4f917f8d23",
  "RequiresSorting": false,
  "GlobalListKeys": null,
  "KeyIsCaseInsensitive": false,
  "AvailableInApps": []
}

Get a specific global list by its alias

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

aliasstringRequired

Alias of the global list to return

Responses

200

OK

application/json

Global list represents a global collection of reusable objects

Idinteger · int32Optional

Id of global list (readonly)

Uidstring · uuidOptional

Unique id of global list

ViewRequiresPermissionbooleanOptional

Indicates whether a special permission is required to view the global list

ViewPermissionstring · uuid · nullableOptional

Permission required to view the global list, if ViewRequiresPermission is set

CreateRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to create values in the global list

EditRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to update values in the global list

DeleteRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to delete values in the global list

CreatePermissionstring · uuid · nullableOptional

Permission required to create values in the global list, if CreateRequiresPermission is set

EditPermissionstring · uuid · nullableOptional

Permission required to update values in the global list, if EditRequiresPermission is set

DeletePermissionstring · uuid · nullableOptional

Permission required to delete values in the global list, if DeleteRequiresPermission is set

FolderUidstring · uuid · nullableOptional

Uid of folder to place global list in

RequiresSortingbooleanOptional

Defines if values on a global list values should be sorted on creation

GlobalListKeysstring[] · nullableOptional

Defines data elements of the global list, which in combination must be unique across all values of the this global list (format: [rootAttributeUid][subAttributeUid][LanguageId/NA]_[DimensionSegmentUid/NA] - ex. 17ca35af-9cb9-44a2-a2f4-1d30a3617e01_2ee6ac86-77d0-4385-94b7-84dd59e05d0b_NA_NA)

KeyIsCaseInsensitivebooleanOptional

Defines if key value for a global list value is case insensitive

get

/v1/GlobalLists/ByAlias/{alias}

HTTPcURLJavaScriptPython

GET /v1/GlobalLists/ByAlias/{alias} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "Id": 10,
  "Uid": "43e9e12c-ee0c-4063-9654-189c8ec9dc41",
  "Attribute": {
    "SubAttributes": [
      {
        "UseMultiRowInput": false,
        "InputHeight": null,
        "UseRichText": false,
        "RichTextToolbarOptions": [],
        "RegEx": null,
        "RegExDescription": null,
        "Unit": null,
        "ShowCharacterCount": false,
        "MaxLength": null,
        "EnableAIAssistant": false,
        "Uid": "db879dd1-4396-470f-a62b-b2ebdf9dc9dd",
        "Alias": "Name",
        "BackofficeName": "Name",
        "BackofficeDescription": "Localized name of color",
        "Name": {
          "en-GB": "Name",
          "da-DK": "Navn"
        },
        "Description": {},
        "AttributeGroupUid": "951f5570-40f7-4628-9afc-4dd45acd7b5a",
        "AttributeScopes": [],
        "Localized": true,
        "FallbackLanguage": null,
        "DimensionUid": "8d9dd191-25ae-4db7-aed7-02c36279778f",
        "FallbackSegment": "08fcfcb9-f3a0-4a08-8d77-77d9da60430e",
        "ReadOnly": false,
        "Mandatory": false,
        "Columns": 0,
        "Unchangeable": false,
        "AttributeType": "TextAttribute",
        "DisableRevisionLogging": false,
        "DisableIndexing": false
      },
      {
        "UseMultiRowInput": false,
        "InputHeight": null,
        "UseRichText": false,
        "RichTextToolbarOptions": [],
        "RegEx": null,
        "RegExDescription": null,
        "Unit": null,
        "ShowCharacterCount": false,
        "MaxLength": null,
        "EnableAIAssistant": false,
        "Uid": "a8d3afad-11fe-4b21-b695-edc8fb7d5ccb",
        "Alias": "HEXcolor",
        "BackofficeName": "HEX color",
        "BackofficeDescription": "Add a HEX color which can be used to display a color swatch",
        "Name": {},
        "Description": {},
        "AttributeGroupUid": "eae86eb0-27f8-49fe-a985-0832952a341a",
        "AttributeScopes": [],
        "Localized": false,
        "FallbackLanguage": null,
        "DimensionUid": "7404611d-c790-4cf3-9e8d-912f604fdbb5",
        "FallbackSegment": "9f9354a0-ee33-436f-aa93-e2d692abab5c",
        "ReadOnly": false,
        "Mandatory": false,
        "Columns": 0,
        "Unchangeable": false,
        "AttributeType": "TextAttribute",
        "DisableRevisionLogging": false,
        "DisableIndexing": false
      }
    ],
    "RenderValuesForAttributeFieldUids": [
      "db879dd1-4396-470f-a62b-b2ebdf9dc9dd"
    ],
    "RenderValuesForBackofficeAttributeFieldUids": [
      "db879dd1-4396-470f-a62b-b2ebdf9dc9dd"
    ],
    "RenderedValueSeparator": null,
    "RenderedValueInBackofficeSeparator": null,
    "Uid": "43e9e12c-ee0c-4063-9654-189c8ec9dc41",
    "Alias": "Colors",
    "BackofficeName": "Colors",
    "BackofficeDescription": "Colors variants in the system",
    "Name": {
      "en-GB": "Colors",
      "da-DK": "Farver"
    },
    "Description": {
      "en-GB": "Colors that products can take",
      "da-DK": "Farver produkter kan antage"
    },
    "AttributeGroupUid": "1cf3ae64-90c8-43fd-98f4-e1511969386e",
    "AttributeScopes": [],
    "Localized": false,
    "FallbackLanguage": null,
    "DimensionUid": "14e39ce2-b818-46ea-8f04-b00b193cad0f",
    "FallbackSegment": "5b53292d-9eda-4319-b522-c8245d4e8234",
    "ReadOnly": false,
    "Mandatory": false,
    "Columns": 0,
    "Unchangeable": false,
    "AttributeType": "ComplexAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false
  },
  "ViewRequiresPermission": true,
  "ViewPermission": "2e4254e5-0b1d-4823-85b6-a0f910b1e977",
  "CreateRequiresPermission": true,
  "EditRequiresPermission": true,
  "DeleteRequiresPermission": true,
  "CreatePermission": "7d7c7cea-4d1c-4e9c-9d99-2f3e99edb040",
  "EditPermission": "4f687871-685a-4dcd-b6a0-46ac77632ec7",
  "DeletePermission": "1740146e-f194-4cff-a405-f467a0eafc8a",
  "FolderUid": "81281128-600d-45e6-ad07-fa45efd8941d",
  "RequiresSorting": false,
  "GlobalListKeys": null,
  "KeyIsCaseInsensitive": false,
  "AvailableInApps": []
}

Get a batch of global lists by their aliases

post

Authorizations

ApiKey

AuthorizationstringRequired

Bodystring[]

application/json

string[]Optional

Responses

200

OK

application/json

Global list represents a global collection of reusable objects

Idinteger · int32Optional

Id of global list (readonly)

Uidstring · uuidOptional

Unique id of global list

ViewRequiresPermissionbooleanOptional

Indicates whether a special permission is required to view the global list

ViewPermissionstring · uuid · nullableOptional

Permission required to view the global list, if ViewRequiresPermission is set

CreateRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to create values in the global list

EditRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to update values in the global list

DeleteRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to delete values in the global list

CreatePermissionstring · uuid · nullableOptional

Permission required to create values in the global list, if CreateRequiresPermission is set

EditPermissionstring · uuid · nullableOptional

Permission required to update values in the global list, if EditRequiresPermission is set

DeletePermissionstring · uuid · nullableOptional

Permission required to delete values in the global list, if DeleteRequiresPermission is set

FolderUidstring · uuid · nullableOptional

Uid of folder to place global list in

RequiresSortingbooleanOptional

Defines if values on a global list values should be sorted on creation

GlobalListKeysstring[] · nullableOptional

Defines data elements of the global list, which in combination must be unique across all values of the this global list (format: [rootAttributeUid][subAttributeUid][LanguageId/NA]_[DimensionSegmentUid/NA] - ex. 17ca35af-9cb9-44a2-a2f4-1d30a3617e01_2ee6ac86-77d0-4385-94b7-84dd59e05d0b_NA_NA)

KeyIsCaseInsensitivebooleanOptional

Defines if key value for a global list value is case insensitive

post

/v1/GlobalLists/ByAlias/batch

HTTPcURLJavaScriptPython

POST /v1/GlobalLists/ByAlias/batch HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

200

OK

[
  {
    "Id": 10,
    "Uid": "f5efb7fe-c9d9-4d6d-90b6-421ae4401880",
    "Attribute": {
      "SubAttributes": [
        {
          "UseMultiRowInput": false,
          "InputHeight": null,
          "UseRichText": false,
          "RichTextToolbarOptions": [],
          "RegEx": null,
          "RegExDescription": null,
          "Unit": null,
          "ShowCharacterCount": false,
          "MaxLength": null,
          "EnableAIAssistant": false,
          "Uid": "4d9b31f0-dd13-475d-aa4b-478432dbd9c0",
          "Alias": "Name",
          "BackofficeName": "Name",
          "BackofficeDescription": "Localized name of color",
          "Name": {
            "en-GB": "Name",
            "da-DK": "Navn"
          },
          "Description": {},
          "AttributeGroupUid": "dd335328-d537-45db-8b61-2da4f89a466e",
          "AttributeScopes": [],
          "Localized": true,
          "FallbackLanguage": null,
          "DimensionUid": "8c1cf4fc-653b-4f93-af5a-7aa64de55487",
          "FallbackSegment": "7c239816-d77c-495a-bab5-6c2a3fc44f42",
          "ReadOnly": false,
          "Mandatory": false,
          "Columns": 0,
          "Unchangeable": false,
          "AttributeType": "TextAttribute",
          "DisableRevisionLogging": false,
          "DisableIndexing": false
        },
        {
          "UseMultiRowInput": false,
          "InputHeight": null,
          "UseRichText": false,
          "RichTextToolbarOptions": [],
          "RegEx": null,
          "RegExDescription": null,
          "Unit": null,
          "ShowCharacterCount": false,
          "MaxLength": null,
          "EnableAIAssistant": false,
          "Uid": "4b1d1f72-74c4-4e43-8d66-ae4fb7840861",
          "Alias": "HEXcolor",
          "BackofficeName": "HEX color",
          "BackofficeDescription": "Add a HEX color which can be used to display a color swatch",
          "Name": {},
          "Description": {},
          "AttributeGroupUid": "af4a5de2-1d89-4723-8e5c-ff53b1dba25d",
          "AttributeScopes": [],
          "Localized": false,
          "FallbackLanguage": null,
          "DimensionUid": "c97e12a1-05b8-4c8b-b42c-76675572cb06",
          "FallbackSegment": "35c79f15-d91d-4d21-b39a-75c82d9aac81",
          "ReadOnly": false,
          "Mandatory": false,
          "Columns": 0,
          "Unchangeable": false,
          "AttributeType": "TextAttribute",
          "DisableRevisionLogging": false,
          "DisableIndexing": false
        }
      ],
      "RenderValuesForAttributeFieldUids": [
        "4d9b31f0-dd13-475d-aa4b-478432dbd9c0"
      ],
      "RenderValuesForBackofficeAttributeFieldUids": [
        "4d9b31f0-dd13-475d-aa4b-478432dbd9c0"
      ],
      "RenderedValueSeparator": null,
      "RenderedValueInBackofficeSeparator": null,
      "Uid": "f5efb7fe-c9d9-4d6d-90b6-421ae4401880",
      "Alias": "Colors",
      "BackofficeName": "Colors",
      "BackofficeDescription": "Colors variants in the system",
      "Name": {
        "en-GB": "Colors",
        "da-DK": "Farver"
      },
      "Description": {
        "en-GB": "Colors that products can take",
        "da-DK": "Farver produkter kan antage"
      },
      "AttributeGroupUid": "3c84af66-6f8c-4e80-b415-3851b2b6b463",
      "AttributeScopes": [],
      "Localized": false,
      "FallbackLanguage": null,
      "DimensionUid": "759b42df-054d-4b01-a255-9e93b1d8ec1b",
      "FallbackSegment": "8aa9f3d6-d2ef-424b-aec0-13baebd2f4b8",
      "ReadOnly": false,
      "Mandatory": false,
      "Columns": 0,
      "Unchangeable": false,
      "AttributeType": "ComplexAttribute",
      "DisableRevisionLogging": false,
      "DisableIndexing": false
    },
    "ViewRequiresPermission": true,
    "ViewPermission": "9f374d16-37b0-4560-98fe-a296613e205f",
    "CreateRequiresPermission": true,
    "EditRequiresPermission": true,
    "DeleteRequiresPermission": true,
    "CreatePermission": "a56ba9b8-6898-4b11-94cd-1105a127e3ee",
    "EditPermission": "78815ffe-e475-46d9-a6f1-2764008f10ec",
    "DeletePermission": "b7a015ac-671d-4158-9fef-720ce2baec8c",
    "FolderUid": "64c75bcf-86de-4d1d-8e35-a1e9d93fb658",
    "RequiresSorting": false,
    "GlobalListKeys": null,
    "KeyIsCaseInsensitive": false,
    "AvailableInApps": []
  },
  {
    "Id": 11,
    "Uid": "a0f02d3f-4636-4b54-b845-7b25d07adbb1",
    "Attribute": {
      "UseMultiRowInput": false,
      "InputHeight": null,
      "UseRichText": false,
      "RichTextToolbarOptions": [],
      "RegEx": null,
      "RegExDescription": null,
      "Unit": null,
      "ShowCharacterCount": false,
      "MaxLength": null,
      "EnableAIAssistant": false,
      "Uid": "a0f02d3f-4636-4b54-b845-7b25d07adbb1",
      "Alias": "ProductStatusses",
      "BackofficeName": "Product statusses",
      "BackofficeDescription": "Manage statusses that products can have",
      "Name": {},
      "Description": {},
      "AttributeGroupUid": "05e5bba3-e37b-49bd-9cd4-7b5e966c5bc9",
      "AttributeScopes": [],
      "Localized": false,
      "FallbackLanguage": null,
      "DimensionUid": "0043ecd4-6405-4b28-bdee-df70121edb82",
      "FallbackSegment": "9e38d8b3-e482-4062-9c0d-7f900f198013",
      "ReadOnly": false,
      "Mandatory": false,
      "Columns": 0,
      "Unchangeable": false,
      "AttributeType": "TextAttribute",
      "DisableRevisionLogging": false,
      "DisableIndexing": false
    },
    "ViewRequiresPermission": false,
    "ViewPermission": "5da49b80-1bb9-4460-a59e-522ca9352965",
    "CreateRequiresPermission": false,
    "EditRequiresPermission": false,
    "DeleteRequiresPermission": false,
    "CreatePermission": "06e2721a-3321-4007-bf2b-beb78ff10809",
    "EditPermission": "b267ae39-afbe-430e-b87d-f041ebd4a6b2",
    "DeletePermission": "1fde0ab3-ae52-4764-a89f-a59b2b49f5bb",
    "FolderUid": "3a0cc92e-8bdd-49a8-b82e-a74813da6c79",
    "RequiresSorting": false,
    "GlobalListKeys": null,
    "KeyIsCaseInsensitive": false,
    "AvailableInApps": []
  }
]

Get a batch of global lists

post

Authorizations

ApiKey

AuthorizationstringRequired

Bodystring · uuid[]

application/json

string · uuid[]Optional

Responses

200

OK

application/json

Global list represents a global collection of reusable objects

Idinteger · int32Optional

Id of global list (readonly)

Uidstring · uuidOptional

Unique id of global list

ViewRequiresPermissionbooleanOptional

Indicates whether a special permission is required to view the global list

ViewPermissionstring · uuid · nullableOptional

Permission required to view the global list, if ViewRequiresPermission is set

CreateRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to create values in the global list

EditRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to update values in the global list

DeleteRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to delete values in the global list

CreatePermissionstring · uuid · nullableOptional

Permission required to create values in the global list, if CreateRequiresPermission is set

EditPermissionstring · uuid · nullableOptional

Permission required to update values in the global list, if EditRequiresPermission is set

DeletePermissionstring · uuid · nullableOptional

Permission required to delete values in the global list, if DeleteRequiresPermission is set

FolderUidstring · uuid · nullableOptional

Uid of folder to place global list in

RequiresSortingbooleanOptional

Defines if values on a global list values should be sorted on creation

GlobalListKeysstring[] · nullableOptional

Defines data elements of the global list, which in combination must be unique across all values of the this global list (format: [rootAttributeUid][subAttributeUid][LanguageId/NA]_[DimensionSegmentUid/NA] - ex. 17ca35af-9cb9-44a2-a2f4-1d30a3617e01_2ee6ac86-77d0-4385-94b7-84dd59e05d0b_NA_NA)

KeyIsCaseInsensitivebooleanOptional

Defines if key value for a global list value is case insensitive

post

/v1/GlobalLists/batch

HTTPcURLJavaScriptPython

POST /v1/GlobalLists/batch HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

[
  "123e4567-e89b-12d3-a456-426614174000"
]

200

OK

[
  {
    "Id": 10,
    "Uid": "db966299-f070-4b07-878d-ca9726e3b6b7",
    "Attribute": {
      "SubAttributes": [
        {
          "UseMultiRowInput": false,
          "InputHeight": null,
          "UseRichText": false,
          "RichTextToolbarOptions": [],
          "RegEx": null,
          "RegExDescription": null,
          "Unit": null,
          "ShowCharacterCount": false,
          "MaxLength": null,
          "EnableAIAssistant": false,
          "Uid": "5589500a-4207-4208-ac87-b4fd1858cb67",
          "Alias": "Name",
          "BackofficeName": "Name",
          "BackofficeDescription": "Localized name of color",
          "Name": {
            "en-GB": "Name",
            "da-DK": "Navn"
          },
          "Description": {},
          "AttributeGroupUid": "c0201061-52c0-4ad9-9b9b-5b255d72126f",
          "AttributeScopes": [],
          "Localized": true,
          "FallbackLanguage": null,
          "DimensionUid": "0a9835c9-4b6e-42c0-8181-d7aae32a323c",
          "FallbackSegment": "eccf84a0-4c20-498c-a474-5e094b14b4f3",
          "ReadOnly": false,
          "Mandatory": false,
          "Columns": 0,
          "Unchangeable": false,
          "AttributeType": "TextAttribute",
          "DisableRevisionLogging": false,
          "DisableIndexing": false
        },
        {
          "UseMultiRowInput": false,
          "InputHeight": null,
          "UseRichText": false,
          "RichTextToolbarOptions": [],
          "RegEx": null,
          "RegExDescription": null,
          "Unit": null,
          "ShowCharacterCount": false,
          "MaxLength": null,
          "EnableAIAssistant": false,
          "Uid": "8e5bea3f-f41b-4406-b1ed-82c0463b6038",
          "Alias": "HEXcolor",
          "BackofficeName": "HEX color",
          "BackofficeDescription": "Add a HEX color which can be used to display a color swatch",
          "Name": {},
          "Description": {},
          "AttributeGroupUid": "a9c360bc-bfc2-4b43-816a-8583b5be24b5",
          "AttributeScopes": [],
          "Localized": false,
          "FallbackLanguage": null,
          "DimensionUid": "6a53ed19-359b-4b3f-ab51-c002f01ae7e1",
          "FallbackSegment": "132cd8d7-ca45-44b7-bb49-8715f11ef1cd",
          "ReadOnly": false,
          "Mandatory": false,
          "Columns": 0,
          "Unchangeable": false,
          "AttributeType": "TextAttribute",
          "DisableRevisionLogging": false,
          "DisableIndexing": false
        }
      ],
      "RenderValuesForAttributeFieldUids": [
        "5589500a-4207-4208-ac87-b4fd1858cb67"
      ],
      "RenderValuesForBackofficeAttributeFieldUids": [
        "5589500a-4207-4208-ac87-b4fd1858cb67"
      ],
      "RenderedValueSeparator": null,
      "RenderedValueInBackofficeSeparator": null,
      "Uid": "db966299-f070-4b07-878d-ca9726e3b6b7",
      "Alias": "Colors",
      "BackofficeName": "Colors",
      "BackofficeDescription": "Colors variants in the system",
      "Name": {
        "en-GB": "Colors",
        "da-DK": "Farver"
      },
      "Description": {
        "en-GB": "Colors that products can take",
        "da-DK": "Farver produkter kan antage"
      },
      "AttributeGroupUid": "c14adc44-f2b0-423b-b993-144babd35295",
      "AttributeScopes": [],
      "Localized": false,
      "FallbackLanguage": null,
      "DimensionUid": "08a196a7-d66a-4e93-a6c9-46930ca2ccf1",
      "FallbackSegment": "a8bdf546-1506-4e8a-b9de-46c0b7199b9e",
      "ReadOnly": false,
      "Mandatory": false,
      "Columns": 0,
      "Unchangeable": false,
      "AttributeType": "ComplexAttribute",
      "DisableRevisionLogging": false,
      "DisableIndexing": false
    },
    "ViewRequiresPermission": true,
    "ViewPermission": "6d3189b5-bcf3-4c53-8744-9212da6499bb",
    "CreateRequiresPermission": true,
    "EditRequiresPermission": true,
    "DeleteRequiresPermission": true,
    "CreatePermission": "2d949d04-6e8f-48bf-9bc1-18fd144704ff",
    "EditPermission": "c6dd2578-752d-464d-8a2b-5d2797f98a8b",
    "DeletePermission": "bfbfc897-efb0-44dd-893a-be6fbf2a1ce0",
    "FolderUid": "82a07e5b-2ec4-46b9-a440-319341305526",
    "RequiresSorting": false,
    "GlobalListKeys": null,
    "KeyIsCaseInsensitive": false,
    "AvailableInApps": []
  },
  {
    "Id": 11,
    "Uid": "1d9f60e9-c182-43fd-a727-232921b8788e",
    "Attribute": {
      "UseMultiRowInput": false,
      "InputHeight": null,
      "UseRichText": false,
      "RichTextToolbarOptions": [],
      "RegEx": null,
      "RegExDescription": null,
      "Unit": null,
      "ShowCharacterCount": false,
      "MaxLength": null,
      "EnableAIAssistant": false,
      "Uid": "1d9f60e9-c182-43fd-a727-232921b8788e",
      "Alias": "ProductStatusses",
      "BackofficeName": "Product statusses",
      "BackofficeDescription": "Manage statusses that products can have",
      "Name": {},
      "Description": {},
      "AttributeGroupUid": "62c3d872-c37e-4ea8-ab7d-16c65439a3ce",
      "AttributeScopes": [],
      "Localized": false,
      "FallbackLanguage": null,
      "DimensionUid": "70aec108-7500-4bea-bd51-7f1d68c5068d",
      "FallbackSegment": "564a55a3-aafb-44ee-8d05-39f992c311c1",
      "ReadOnly": false,
      "Mandatory": false,
      "Columns": 0,
      "Unchangeable": false,
      "AttributeType": "TextAttribute",
      "DisableRevisionLogging": false,
      "DisableIndexing": false
    },
    "ViewRequiresPermission": false,
    "ViewPermission": "aafa5526-e10c-4eb7-9f64-72bd8a6e117d",
    "CreateRequiresPermission": false,
    "EditRequiresPermission": false,
    "DeleteRequiresPermission": false,
    "CreatePermission": "2c12e4f8-0254-4ba6-bd64-f352d0e0e04c",
    "EditPermission": "789bfd00-07a0-455e-8e26-6180c42d97f2",
    "DeletePermission": "5a11a488-537b-469c-8d0f-7bfb8c7dfe05",
    "FolderUid": "e5f2abe4-962d-43ac-9e4f-e2da9f6ed13e",
    "RequiresSorting": false,
    "GlobalListKeys": null,
    "KeyIsCaseInsensitive": false,
    "AvailableInApps": []
  }
]

Get all global list folders in the system

get

Authorizations

ApiKey

AuthorizationstringRequired

Responses

200

OK

application/json

Folder holding global lists

Uidstring · uuidOptional

Unique id of folder

Namestring · nullableOptional

Presented name of folder in backoffice

get

/v1/GlobalLists/folders

HTTPcURLJavaScriptPython

GET /v1/GlobalLists/folders HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "Uid": "5e23ca75-854b-4d2e-ae1a-4bee9eee2af0",
    "Name": "General"
  },
  {
    "Uid": "b24796b2-c56a-4cac-a2bd-b0e0e29fb0d4",
    "Name": "Electronics"
  },
  {
    "Uid": "ae3f0b5f-33fc-4f6e-8958-41fad6ed2523",
    "Name": "Clothing"
  }
]

Create new global list folder

post

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Folder holding global lists

Uidstring · uuidOptional

Unique id of folder

Namestring · nullableOptional

Presented name of folder in backoffice

Responses

200

OK

application/json

Folder holding global lists

Uidstring · uuidOptional

Unique id of folder

Namestring · nullableOptional

Presented name of folder in backoffice

400

Bad Request

application/json

post

/v1/GlobalLists/folders

HTTPcURLJavaScriptPython

POST /v1/GlobalLists/folders HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "Uid": "da5d9f69-218e-499d-b720-9efecc90b95b",
  "Name": "General"
}

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Name": "text"
}

Update existing global list folder

put

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Folder holding global lists

Uidstring · uuidOptional

Unique id of folder

Namestring · nullableOptional

Presented name of folder in backoffice

Responses

200

OK

No content

400

Bad Request

application/json

put

/v1/GlobalLists/folders

HTTPcURLJavaScriptPython

PUT /v1/GlobalLists/folders HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "Uid": "a9157026-aa86-40c4-8b57-dfe74187c380",
  "Name": "General"
}

No content

Deletes the global list folder with the specified uid

delete

Authorizations

ApiKey

AuthorizationstringRequired

Query parameters

uidstring · uuidOptional

Uid of folder to delete

Responses

200

OK

No content

delete

/v1/GlobalLists/folders

HTTPcURLJavaScriptPython

DELETE /v1/GlobalLists/folders HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

No content

Get a specific global list folder

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Unique id of folder

Responses

200

OK

application/json

Folder holding global lists

Uidstring · uuidOptional

Unique id of folder

Namestring · nullableOptional

Presented name of folder in backoffice

get

/v1/GlobalLists/folders/{uid}

HTTPcURLJavaScriptPython

GET /v1/GlobalLists/folders/{uid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "Uid": "a0733999-86cb-450b-8e97-ce936fb71e9b",
  "Name": "General"
}

Get values for a specific global list

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Unique id of global list to get values for

Query parameters

limitinteger · int32Optional

Max number of items to return

Default: 1000000

afterIdstring · uuidOptional

Only get values sorted after this id

globalListValueReferencesOnlybooleanOptional

Indicate if only uids of referenced to global list values shall be returned instead of the materialized values

Default: false

Responses

200

OK

application/json

Resultset for requested global list values

Totalinteger · int32Optional

Total number of global list values in global list

Remaininginteger · int32Optional

Remaining values after the LastId in this result set

LastIdstring · uuid · nullableOptional

Last id of values in this resultset. Use as pointer to fetch next batch of values

get

/v1/GlobalLists/{uid}/values

HTTPcURLJavaScriptPython

GET /v1/GlobalLists/{uid}/values HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "Total": 201,
  "Remaining": 199,
  "LastId": "6749cc19-c105-4770-a519-a172c0210c69",
  "GlobalListValues": [
    {
      "Uid": "8a38740e-4ab4-44e3-b9b0-1089edf30e72",
      "SortOrder": 1,
      "Value": {
        "Name": [
          {
            "CultureCode": "en-GB",
            "Data": "Blue"
          },
          {
            "CultureCode": "da-DK",
            "Data": "Blå"
          }
        ],
        "HEXColor": "0000FF"
      }
    },
    {
      "Uid": "0e3f1ab0-43a0-44e6-bc44-697e6130d0ba",
      "SortOrder": 2,
      "Value": {
        "Name": [
          {
            "CultureCode": "en-GB",
            "Data": "Green"
          },
          {
            "CultureCode": "da-DK",
            "Data": "Grøn"
          }
        ],
        "HEXColor": "00FF00"
      }
    },
    {
      "Uid": "6749cc19-c105-4770-a519-a172c0210c69",
      "SortOrder": 2,
      "Value": {
        "Name": [
          {
            "CultureCode": "en-GB",
            "Data": "Red"
          },
          {
            "CultureCode": "da-DK",
            "Data": "Rød"
          }
        ],
        "HEXColor": "FF0000"
      }
    }
  ]
}

Create values in a global list

post

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Unique id of global list to create values in

Bodyobject[]

application/json

Global list value object representing data on a specific object in a global list. The data type of the value property differs depending on the underlying attribute on the global list of this value.

Uidstring · uuidOptional

Unique id of global list value

SortOrderinteger · int32 · nullableOptional

Sort order of this value compared to other values in the same global list

Valueany · nullableOptional

The value dynamic value model. The data type of this model depends on the Global list attribute setup. If the global list attribute is a Text attribute, this value will be a string If it is a Number attribute, this value will be a decimal and so on.

Responses

200

OK

No content

post

/v1/GlobalLists/{uid}/values

HTTPcURLJavaScriptPython

POST /v1/GlobalLists/{uid}/values HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 530

[
  {
    "Uid": "89cff238-ff65-4129-98c1-9c21f7e4cd65",
    "SortOrder": 1,
    "Value": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Blue"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Blå"
        }
      ],
      "HEXColor": "0000FF"
    }
  },
  {
    "Uid": "7b747d91-918e-4a9c-a282-d8e0df9e62dc",
    "SortOrder": 2,
    "Value": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Green"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Grøn"
        }
      ],
      "HEXColor": "00FF00"
    }
  },
  {
    "Uid": "949df7db-1d25-400d-abce-978388997466",
    "SortOrder": 2,
    "Value": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Red"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Rød"
        }
      ],
      "HEXColor": "FF0000"
    }
  }
]

200

OK

No content

Update values in a global list

put

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Unique id of global list to update values in

Bodyobject[]

application/json

Global list value object representing data on a specific object in a global list. The data type of the value property differs depending on the underlying attribute on the global list of this value.

Uidstring · uuidOptional

Unique id of global list value

SortOrderinteger · int32 · nullableOptional

Sort order of this value compared to other values in the same global list

Valueany · nullableOptional

The value dynamic value model. The data type of this model depends on the Global list attribute setup. If the global list attribute is a Text attribute, this value will be a string If it is a Number attribute, this value will be a decimal and so on.

Responses

200

OK

No content

put

/v1/GlobalLists/{uid}/values

HTTPcURLJavaScriptPython

PUT /v1/GlobalLists/{uid}/values HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 530

[
  {
    "Uid": "014dabb0-9e1f-40b6-80d9-d1309053bffc",
    "SortOrder": 1,
    "Value": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Blue"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Blå"
        }
      ],
      "HEXColor": "0000FF"
    }
  },
  {
    "Uid": "7864c096-3cda-46a1-92e0-ac110909cefc",
    "SortOrder": 2,
    "Value": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Green"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Grøn"
        }
      ],
      "HEXColor": "00FF00"
    }
  },
  {
    "Uid": "54a2ca33-9f57-436e-b9e3-d7feef434e60",
    "SortOrder": 2,
    "Value": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Red"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Rød"
        }
      ],
      "HEXColor": "FF0000"
    }
  }
]

200

OK

No content

Get a global list value

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Unique id of global list value

Query parameters

globalListValueReferencesOnlybooleanOptional

Indicate if only uids of referenced to global list values shall be returned instead of the materialized values

Default: false

Responses

200

OK

application/json

Global list value object representing data on a specific object in a global list. The data type of the value property differs depending on the underlying attribute on the global list of this value.

Uidstring · uuidOptional

Unique id of global list value

SortOrderinteger · int32 · nullableOptional

Sort order of this value compared to other values in the same global list

Valueany · nullableOptional

The value dynamic value model. The data type of this model depends on the Global list attribute setup. If the global list attribute is a Text attribute, this value will be a string If it is a Number attribute, this value will be a decimal and so on.

400

Bad Request

application/json

get

/v1/GlobalLists/values/{uid}

HTTPcURLJavaScriptPython

GET /v1/GlobalLists/values/{uid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "Uid": "98eaf8fb-54bf-4916-8c36-2b93463859dc",
  "SortOrder": 1,
  "Value": {
    "Name": [
      {
        "CultureCode": "en-GB",
        "Data": "Blue"
      },
      {
        "CultureCode": "da-DK",
        "Data": "Blå"
      }
    ],
    "HEXColor": "0000FF"
  }
}

Get references to a global list value

get

#Available from v.3.5.0

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Unique id of global list value

Responses

200

OK

application/json

Model holding references from other entities to global list value

GlobalListValueUidstring · uuidOptional

Uid of the referenced global list value

ReferencingGlobalListValuesstring · uuid[] · nullableOptional

List of other global list values referencing this global list value

get

/v1/GlobalLists/values/{uid}/references

HTTPcURLJavaScriptPython

GET /v1/GlobalLists/values/{uid}/references HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "GlobalListValueUid": "1202ea20-0e5f-485f-976e-c668d3ed831e",
  "ReferencingCategories": [
    {
      "EntityId": 100,
      "AttributeUid": "2932064a-aac3-45bd-982a-5c68c25be004"
    },
    {
      "EntityId": 101,
      "AttributeUid": "2932064a-aac3-45bd-982a-5c68c25be004"
    }
  ],
  "ReferencingProducts": [
    {
      "EntityId": 100010,
      "AttributeUid": "2f910bdf-e8dd-4d95-ab4f-83cfe450647a"
    },
    {
      "EntityId": 100011,
      "AttributeUid": "2f910bdf-e8dd-4d95-ab4f-83cfe450647a"
    },
    {
      "EntityId": 102354,
      "AttributeUid": "47d2b3ae-3d82-4679-9a2f-791433817e30"
    }
  ],
  "ReferencingVariantGroups": [],
  "ReferencingVariants": [
    {
      "EntityId": 100,
      "AttributeUid": "2f910bdf-e8dd-4d95-ab4f-83cfe450647a"
    }
  ],
  "ReferencingGlobalListValues": [
    "234759ca-14bf-43c9-b7ed-93610af47dd7",
    "36335b91-1249-40b2-a92c-68816d5d1831"
  ]
}

Get references to a batch of global list values

post

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

Authorizations

ApiKey

AuthorizationstringRequired

Bodystring · uuid[]

application/json

string · uuid[]Optional

Responses

200

OK

application/json

Model holding references from other entities to global list value

GlobalListValueUidstring · uuidOptional

Uid of the referenced global list value

ReferencingGlobalListValuesstring · uuid[] · nullableOptional

List of other global list values referencing this global list value

post

/v1/GlobalLists/values/batch/references

HTTPcURLJavaScriptPython

POST /v1/GlobalLists/values/batch/references HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

[
  "123e4567-e89b-12d3-a456-426614174000"
]

200

OK

[
  {
    "GlobalListValueUid": "9dc5c647-6beb-4fd7-9d25-2a83362ca3f6",
    "ReferencingCategories": [
      {
        "EntityId": 100,
        "AttributeUid": "b21b375a-38de-4035-8659-680e5ed19e06"
      },
      {
        "EntityId": 101,
        "AttributeUid": "b21b375a-38de-4035-8659-680e5ed19e06"
      }
    ],
    "ReferencingProducts": [
      {
        "EntityId": 100010,
        "AttributeUid": "8929bf2d-c61e-4475-b6c7-9edebe214ca0"
      },
      {
        "EntityId": 100011,
        "AttributeUid": "8929bf2d-c61e-4475-b6c7-9edebe214ca0"
      },
      {
        "EntityId": 102354,
        "AttributeUid": "2082bcc8-93ba-4014-8ea1-0e0a0d741174"
      }
    ],
    "ReferencingVariantGroups": [],
    "ReferencingVariants": [
      {
        "EntityId": 100,
        "AttributeUid": "8929bf2d-c61e-4475-b6c7-9edebe214ca0"
      }
    ],
    "ReferencingGlobalListValues": [
      "26bc78fb-eec2-4840-a769-a9cd7880cfc3",
      "db7458cf-3225-4aa8-b2cb-346d23345115"
    ]
  },
  {
    "GlobalListValueUid": "cdb3711b-2e85-434a-9b52-40797610d3ef",
    "ReferencingCategories": [
      {
        "EntityId": 100,
        "AttributeUid": "b21b375a-38de-4035-8659-680e5ed19e06"
      }
    ],
    "ReferencingProducts": [
      {
        "EntityId": 23553,
        "AttributeUid": "8929bf2d-c61e-4475-b6c7-9edebe214ca0"
      },
      {
        "EntityId": 5656,
        "AttributeUid": "8929bf2d-c61e-4475-b6c7-9edebe214ca0"
      }
    ],
    "ReferencingVariantGroups": [],
    "ReferencingVariants": [
      {
        "EntityId": 568323,
        "AttributeUid": "2082bcc8-93ba-4014-8ea1-0e0a0d741174"
      }
    ],
    "ReferencingGlobalListValues": [
      "dfcb6ecf-0c63-4951-824e-4425b385c5ff",
      "e21f5e77-3f06-45b8-92ba-3c8f8f9d0a70"
    ]
  }
]

Get a batch of global list values

post

No more than 5000 values can be requested at a time.

Authorizations

ApiKey

AuthorizationstringRequired

Query parameters

globalListValueReferencesOnlybooleanOptional

Indicate if only uids of referenced to global list values shall be returned instead of the materialized values

Default: false

Bodystring · uuid[]

application/json

string · uuid[]Optional

Responses

200

OK

application/json

Global list value object representing data on a specific object in a global list. The data type of the value property differs depending on the underlying attribute on the global list of this value.

Uidstring · uuidOptional

Unique id of global list value

SortOrderinteger · int32 · nullableOptional

Sort order of this value compared to other values in the same global list

Valueany · nullableOptional

The value dynamic value model. The data type of this model depends on the Global list attribute setup. If the global list attribute is a Text attribute, this value will be a string If it is a Number attribute, this value will be a decimal and so on.

400

Bad Request

application/json

post

/v1/GlobalLists/values/batch

HTTPcURLJavaScriptPython

POST /v1/GlobalLists/values/batch HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

[
  "123e4567-e89b-12d3-a456-426614174000"
]

{
  "Total": 201,
  "Remaining": 199,
  "LastId": "63b5f500-83c3-43b5-afb1-c968154d4ec7",
  "GlobalListValues": [
    {
      "Uid": "e7a03181-d058-4d52-ab40-76f94bb10b40",
      "SortOrder": 1,
      "Value": {
        "Name": [
          {
            "CultureCode": "en-GB",
            "Data": "Blue"
          },
          {
            "CultureCode": "da-DK",
            "Data": "Blå"
          }
        ],
        "HEXColor": "0000FF"
      }
    },
    {
      "Uid": "0a91b4ef-56a5-44f9-9a89-1795c5be4d2c",
      "SortOrder": 2,
      "Value": {
        "Name": [
          {
            "CultureCode": "en-GB",
            "Data": "Green"
          },
          {
            "CultureCode": "da-DK",
            "Data": "Grøn"
          }
        ],
        "HEXColor": "00FF00"
      }
    },
    {
      "Uid": "63b5f500-83c3-43b5-afb1-c968154d4ec7",
      "SortOrder": 2,
      "Value": {
        "Name": [
          {
            "CultureCode": "en-GB",
            "Data": "Red"
          },
          {
            "CultureCode": "da-DK",
            "Data": "Rød"
          }
        ],
        "HEXColor": "FF0000"
      }
    }
  ]
}

Delete a range of global list values

delete

Authorizations

ApiKey

AuthorizationstringRequired

Bodystring · uuid[]

application/json

string · uuid[]Optional

Responses

200

OK

No content

delete

/v1/GlobalLists/values

HTTPcURLJavaScriptPython

DELETE /v1/GlobalLists/values HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

[
  "123e4567-e89b-12d3-a456-426614174000"
]

200

OK

No content

Get uids of global list values matching certain criteria

post

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Uid of global list to search

Body

application/json

Definition of general query model

BooleanOperatorinteger · enumOptional

Boolean operator

• 0 = And: All conditions must be met
• 1 = Or: At least one condition must be met

Possible values:

QueryModelTypestring · nullableRead-onlyOptional

The type of query model. Name matches exact name of concrete model implementation

Responses

200

OK

application/json

string · uuid[]Optional

post

/v1/GlobalLists/search/{uid}

HTTPcURLJavaScriptPython

POST /v1/GlobalLists/search/{uid} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 408

{
  "SubQueries": [
    {
      "Filters": [
        {
          "FieldUid": "03d1fc91-69c9-4b31-a09c-2c815f20aa12_NA_NA",
          "QueryOperator": {},
          "FilterValue": "DK"
        }
      ],
      "BooleanOperator": {},
      "QueryModelType": "SimpleQueryModel"
    },
    {
      "Filters": [
        {
          "FieldUid": "ddf07a35-7aa5-4dec-baed-f33863be2fb8_NA_1",
          "QueryOperator": {},
          "FilterValue": "red"
        }
      ],
      "BooleanOperator": {},
      "QueryModelType": "SimpleQueryModel"
    }
  ],
  "BooleanOperator": {},
  "QueryModelType": "BooleanQueryModel"
}

200

OK

[
  "d42301d9-5baa-4f07-8743-6c4c27217abd",
  "c5f18807-f2f6-41b5-882c-c04d3c4c8af1",
  "462578bb-a895-435a-a6f3-3f379a87c020"
]

Get available query fields for a specific global list

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Uid of global list

Responses

200

OK

application/json

Representation of a queryable field in PIM

Uidstring · nullableOptional

Unique id of field in PIM

Namestring · nullableOptional

The display name of the field

SupportsSortingbooleanOptional

If true field can be used for sorting

get

/v1/GlobalLists/queryablefields/{uid}

HTTPcURLJavaScriptPython

GET /v1/GlobalLists/queryablefields/{uid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "Uid": "03d1fc91-69c9-4b31-a09c-2c815f20aa12_NA_NA",
    "Name": "Id",
    "SupportsSorting": false
  },
  {
    "Uid": "ddf07a35-7aa5-4dec-baed-f33863be2fb8_NA_1",
    "Name": "Name (en-GB)",
    "SupportsSorting": false
  },
  {
    "Uid": "ddf07a35-7aa5-4dec-baed-f33863be2fb8_NA_2",
    "Name": "Name (da-DK)",
    "SupportsSorting": false
  },
  {
    "Uid": "9f06c2ea-d008-49a1-9245-900cad8432b5_NA_1",
    "Name": "Description (en-GB)",
    "SupportsSorting": false
  },
  {
    "Uid": "9f06c2ea-d008-49a1-9245-900cad8432b5_NA_2",
    "Name": "Description (da-DK)",
    "SupportsSorting": false
  }
]