{
  "openapi": "3.0.1",
  "info": {
    "title": "Attribute Dictionary Attributes",
    "description": "Create and administer the attributes in an attribute dictionary.",
    "version": "9.1.20.0",
    "x-introduced": "9.1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}:{port}/rest/admin/v2",
      "variables": {
        "port": {
          "default": "443",
          "enum": [
            "443",
            "8000"
          ]
        },
        "hostname": {
          "default": "localhost",
          "enum": [
            "localhost",
            "test.hcl.com"
          ]
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Attribute Dictionary Attributes",
      "description": "Provide RESTful services to retrieve attribute dictionary attribute resources."
    }
  ],
  "paths": {
    "/attribute-dictionary-attributes": {
      "get": {
        "tags": [
          "Attribute Dictionary Attributes"
        ],
        "operationId": "getAttributeDictionaryAttributes",
        "summary": "Get the attribute dictionary attributes in an attribute dictionary.",
        "parameters": [
          {
            "name": "attributeDictionaryId",
            "in": "query",
            "description": "The unique numeric ID for identifying the attribute dictionary.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId"
            },
            "x-context-data": "storeId"
          },
          {
            "name": "dataLanguageIds",
            "in": "query",
            "description": "The data language IDs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/get/recordSetStartNumber"
            },
            "x-entity-path": "dataArea/get/recordSetStartNumber"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/get/maxItems"
            },
            "x-entity-path": "dataArea/get/maxItems"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AttributeDictionaryAttributeCollection"
                }
              }
            },
            "x-entity-path": "dataArea/attributeDictionaryAttribute"
          }
        },
        "x-expression-template": "{_wcf.ap={accessProfile};_wcf.dataLanguageIds='{dataLanguageIds}'}/AttributeDictionaryAttribute[AttributeIdentifier[ExternalIdentifier[AttributeDictionaryIdentifier[(UniqueID='{attributeDictionaryId}')]] and ParentAttributeGroup]]",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "getAttributeDictionaryAttribute",
        "x-parameters": {
          "accessProfile": "IBM_Admin_Details"
        },
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.GetAttributeDictionaryAttributeType"
      },
      "post": {
        "tags": [
          "Attribute Dictionary Attributes"
        ],
        "operationId": "createAttributeDictionaryAttribute",
        "summary": "Create an attribute dictionary attribute.",
        "parameters": [
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId",
              "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeIdentifier/externalIdentifier/storeIdentifier/uniqueID"
            },
            "x-context-data": "storeId",
            "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeIdentifier/externalIdentifier/storeIdentifier/uniqueID"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AttributeDictionaryAttributes"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation is successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the attribute dictionary attributes.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetAttributeDictionaryAttributesById": {
                "operationRef": "#/paths/~1attribute-dictionary-attributes~1{id}/get",
                "parameters": {
                  "id": "$response.header.Location",
                  "storeId": "$request.query.storeId"
                },
                "description": "The `id`, `storeId` value used in the request body can be used as the `id`,`storeId` parameter in `GET /attribute-dictionary-attributes/{id}.\n"
              },
              "DeleteAttributeDictionaryAttributesById": {
                "operationRef": "#/paths/~1attribute-dictionary-attributes~1{id}/delete",
                "parameters": {
                  "id": "$response.header.Location",
                  "storeId": "$request.query.storeId"
                },
                "description": "The `id`, `storeId` value used in the request body can be used as the `id`,`storeId` parameter in `DELETE /attribute-dictionary-attributes/{id}.\n"
              },
              "UpdateAttributeDictionaryAttributesById": {
                "operationRef": "#/paths/~1attribute-dictionary-attributes~1{id}/patch",
                "parameters": {
                  "id": "$response.header.Location",
                  "storeId": "$request.query.storeId"
                },
                "description": "The `id`, `storeId` value used in the request body can be used as the `id`,`storeId` parameter in `PATCH /attribute-dictionary-attributes/{id}.\n"
              },
              "CreateAllowedValuesByAttributeDictionaryAttributesIdAndStoreId": {
                "operationRef": "#/paths/~1attribute-dictionary-attributes~1{id}~1allowed-values/post",
                "parameters": {
                  "id": "$response.header.Location",
                  "storeId": "$request.query.storeId"
                },
                "description": "The `id`, `storeId` value used in the request body can be used as the `id`,`storeId` parameter in `POST /attribute-dictionary-attributes/{id}/allowed-values.\n"
              },
              "CreateDescriptionsByAttributeDictionaryAttributesIdAndStoreId": {
                "operationRef": "#/paths/~1attribute-dictionary-attributes~1{id}~1descriptions/post",
                "parameters": {
                  "id": "$response.header.Location",
                  "storeId": "$request.query.storeId"
                },
                "description": "The `id`, `storeId` value used in the request body can be used as the `id`,`storeId` parameter in `POST /attribute-dictionary-attributes/{id}/descriptions.\n"
              }
            },
            "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeIdentifier/uniqueID"
          }
        },
        "x-action-code": "Create",
        "x-expression-template": "/AttributeDictionaryAttribute[1]",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "processAttributeDictionaryAttribute",
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ProcessAttributeDictionaryAttributeType",
        "x-codegen-request-body-name": "body"
      }
    },
    "/attribute-dictionary-attributes/by-name-or-description": {
      "get": {
        "tags": [
          "Attribute Dictionary Attributes"
        ],
        "operationId": "getAttributeDictionaryAttributesByNameOrDescription",
        "summary": "Search attribute dictionary attributes by name or description.",
        "parameters": [
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId"
            },
            "x-context-data": "storeId"
          },
          {
            "name": "searchText",
            "in": "query",
            "description": "The name pattern to search.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/get/recordSetStartNumber"
            },
            "x-entity-path": "dataArea/get/recordSetStartNumber"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/get/maxItems"
            },
            "x-entity-path": "dataArea/get/maxItems"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AttributeDictionaryAttributeCollection"
                }
              }
            },
            "x-entity-path": "dataArea/attributeDictionaryAttribute"
          }
        },
        "x-expression-builder-class": "com.ibm.commerce.catalog.internal.client.taglib.util.CatalogSearchExpressionBuilder",
        "x-expression-builder-method": "formatExpression",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "getAttributeDictionaryAttribute",
        "x-parameters": {
          "accessProfile": "IBM_Admin_Details",
          "searchType": "attribute-basic",
          "template": "/AttributeDictionaryAttribute[search(AttributeIdentifier/ExternalIdentifier/Identifier='$searchText$' or AttributeDescription/Name='$searchText$')]"
        },
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.GetAttributeDictionaryAttributeType"
      }
    },
    "/attribute-dictionary-attributes/by-identifier": {
      "get": {
        "tags": [
          "Attribute Dictionary Attributes"
        ],
        "operationId": "getAttributeDictionaryAttributesByIdentifier",
        "summary": "Get attribute dictionary attributes by identifier.",
        "x-introduced": "9.1.12.0",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "getAttributeDictionaryAttribute",
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.GetAttributeDictionaryAttributeType",
        "x-expression-template": "{_wcf.ap='IBM_Admin_Details';_wcf.dataLanguageIds='{dataLanguageIds}'}/AttributeDictionaryAttribute[AttributeIdentifier[ExternalIdentifier[(Identifier='{identifier}')]]]",
        "x-parameters": {
          "accessProfile": "IBM_Admin_Details"
        },
        "parameters": [
          {
            "name": "storeId",
            "description": "The unique numeric ID for identifying the store.",
            "in": "query",
            "required": true,
            "x-context-data": "storeId",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "identifier",
            "description": "The attribute identifier.",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "dataLanguageIds",
            "description": "The data language IDs.",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "x-entity-path": "dataArea/attributeDictionaryAttribute",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AttributeDictionaryAttributeCollection"
                }
              }
            }
          }
        }
      }
    },
    "/attribute-dictionary-attributes/{id}": {
      "get": {
        "tags": [
          "Attribute Dictionary Attributes"
        ],
        "operationId": "getAttributeDictionaryAttributeById",
        "summary": "Get an attribute dictionary attribute.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the attribute dictionary attribute.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId"
            },
            "x-context-data": "storeId"
          },
          {
            "name": "dataLanguageIds",
            "in": "query",
            "description": "The data language IDs.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AttributeDictionaryAttribute"
                }
              }
            },
            "x-entity-path": "dataArea/attributeDictionaryAttribute[1]"
          }
        },
        "x-expression-template": "{_wcf.ap={accessProfile};_wcf.dataLanguageIds='{dataLanguageIds}'}/AttributeDictionaryAttribute[AttributeIdentifier[(UniqueID='{id}')]]",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "getAttributeDictionaryAttribute",
        "x-parameters": {
          "accessProfile": "IBM_Admin_Details"
        },
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.GetAttributeDictionaryAttributeType"
      },
      "delete": {
        "tags": [
          "Attribute Dictionary Attributes"
        ],
        "operationId": "deleteAttributeDictionaryAttribute",
        "summary": "Delete a attribute dictionary attribute.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the attribute dictionary attribute.",
            "required": true,
            "schema": {
              "type": "string",
              "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeIdentifier/uniqueID"
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId"
            },
            "x-context-data": "storeId"
          }
        ],
        "responses": {
          "204": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Delete",
        "x-expression-template": "/AttributeDictionaryAttribute[1]",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "processAttributeDictionaryAttribute",
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ProcessAttributeDictionaryAttributeType"
      },
      "patch": {
        "tags": [
          "Attribute Dictionary Attributes"
        ],
        "operationId": "updateAttributeDictionaryAttribute",
        "summary": "Update an attribute dictionary attribute.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the attribute dictionary attribute.",
            "required": true,
            "schema": {
              "type": "string",
              "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeIdentifier/uniqueID"
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId"
            },
            "x-context-data": "storeId"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AttributeDictionaryAttributeCollection"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Change",
        "x-expression-template": "/AttributeDictionaryAttribute[1]",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "changeAttributeDictionaryAttribute",
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeAttributeDictionaryAttributeType",
        "x-codegen-request-body-name": "body"
      }
    },
    "/attribute-dictionary-attributes/{id}/allowed-values": {
      "get": {
        "tags": [
          "Attribute Dictionary Attributes"
        ],
        "operationId": "getAttributeDictionaryAttributeAllowedValues",
        "summary": "Get the allowed values of an attribute dictionary attribute.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The attribute dictionary attribute ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId"
            },
            "x-context-data": "storeId"
          },
          {
            "name": "dataLanguageIds",
            "in": "query",
            "description": "The data language IDs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/get/recordSetStartNumber"
            },
            "x-entity-path": "dataArea/get/recordSetStartNumber"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 25,
              "x-entity-path": "dataArea/get/maxItems"
            },
            "x-entity-path": "dataArea/get/maxItems"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AllowedValueCollection"
                }
              }
            },
            "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/allowedValue"
          }
        },
        "x-expression-template": "{_wcf.ap={accessProfile};_wcf.dataLanguageIds='{dataLanguageIds}'}/AttributeDictionaryAttribute[AttributeIdentifier[UniqueID='{id}']]/AllowedValue",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "getAttributeDictionaryAttribute",
        "x-parameters": {
          "accessProfile": "IBM_Admin_AttributeDictionaryAttributeAllowedValues_Paging"
        },
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.GetAttributeDictionaryAttributeType"
      },
      "post": {
        "tags": [
          "Attribute Dictionary Attributes"
        ],
        "operationId": "createAttributeDictionaryAttributeAllowedValue",
        "summary": "Add an allowed value to an attribute dictionary attribute.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the attribute dictionary attribute.",
            "required": true,
            "schema": {
              "type": "string",
              "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeIdentifier/uniqueID"
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId"
            },
            "x-context-data": "storeId"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AllowedValues"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation is successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the attribute dictionary attributes.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetAllowedValuesByAttributeDictionaryAttributesIdAndStoreId": {
                "operationRef": "#/paths/~1attribute-dictionary-attributes~1{id}~1allowed-values/get",
                "parameters": {
                  "id": "$request.path.id",
                  "storeId": "$request.query.storeId"
                },
                "description": "The `id`, `storeId` value used in the request body can be used as the `id`,`storeId` parameter in `GET /attribute-dictionary-attributes/{id}/allowed-values.\n"
              },
              "DeleteAttributeDictionaryAttributesByIdAndValueId": {
                "operationRef": "#/paths/~1attribute-dictionary-attributes~1{id}~1allowed-values~1{valueId}/delete",
                "parameters": {
                  "id": "$request.path.id",
                  "valueId": "$response.header.Location"
                },
                "description": "The `id`, `valueId` value used in the request body can be used as the `id`,`valueId` parameter in `DELETE /attribute-dictionary-attributes/{id}/allowed-values/{valueId}.\n"
              },
              "UpdateAttributeDictionaryAttributesByIdAndValueId": {
                "operationRef": "#/paths/~1attribute-dictionary-attributes~1{id}~1allowed-values~1{valueId}/patch",
                "parameters": {
                  "id": "$request.path.id",
                  "valueId": "$response.header.Location"
                },
                "description": "The `id`, `valueId` value used in the request body can be used as the `id`,`valueId` parameter in `PATCH /attribute-dictionary-attributes/{id}/allowed-values/{valueId}.\n"
              }
            },
            "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/allowedValue[1]/identifier"
          }
        },
        "x-action-code": "Add",
        "x-expression-template": "/AttributeDictionaryAttribute[1]/AllowedValue[1]",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "changeAttributeDictionaryAttribute",
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeAttributeDictionaryAttributeType",
        "x-request-verb": "change",
        "x-response-verb": "respond",
        "x-codegen-request-body-name": "body"
      }
    },
    "/attribute-dictionary-attributes/{id}/allowed-values/by-identifier": {
      "get": {
        "tags": [
          "Attribute Dictionary Attributes"
        ],
        "operationId": "getAttributeDictionaryAttributeAllowedValuesByIdentifier",
        "summary": "Get the allowed values of an attribute dictionary attribute.",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "getAttributeDictionaryAttribute",
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.GetAttributeDictionaryAttributeType",
        "x-expression-template": "{_wcf.ap='IBM_Admin_AttributeDictionaryAttributeAllowedValues';_wcf.dataLanguageIds='{dataLanguageIds}'}/AttributeDictionaryAttribute[AttributeIdentifier[UniqueID='{id}']/AllowedValue[(ExtendedValue='{identifier}')]",
        "parameters": [
          {
            "name": "id",
            "description": "The attribute dictionary attribute ID",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "storeId",
            "description": "The unique numeric ID for identifying the store.",
            "in": "query",
            "required": true,
            "x-context-data": "storeId",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "identifier",
            "description": "The attribute dictionary attribute allowed value identifier",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "dataLanguageIds",
            "description": "The data language IDs.",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/allowedValue",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AllowedValueCollection"
                }
              }
            }
          }
        }
      }
    },
    "/attribute-dictionary-attributes/{id}/allowed-values/{valueId}": {
      "delete": {
        "tags": [
          "Attribute Dictionary Attributes"
        ],
        "operationId": "deleteAttributeDictionaryAttributeAllowedValue",
        "summary": "Delete a attribute dictionary attribute.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the attribute dictionary attribute.",
            "required": true,
            "schema": {
              "type": "string",
              "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeIdentifier/uniqueID"
          },
          {
            "name": "valueId",
            "in": "path",
            "description": "The unique numeric ID for identifying the attribute allowed value.",
            "required": true,
            "schema": {
              "type": "string",
              "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/allowedValue[1]/identifier"
            },
            "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/allowedValue[1]/identifier"
          }
        ],
        "responses": {
          "204": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Delete",
        "x-expression-template": "/AttributeDictionaryAttribute[1]/AllowedValue[1]",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "changeAttributeDictionaryAttribute",
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeAttributeDictionaryAttributeType",
        "x-request-verb": "change",
        "x-response-verb": "respond"
      },
      "patch": {
        "tags": [
          "Attribute Dictionary Attributes"
        ],
        "operationId": "updateAttributeDictionaryAttributeAllowedValue",
        "summary": "Update a attribute dictionary attribute.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the attribute dictionary attribute.",
            "required": true,
            "schema": {
              "type": "string",
              "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeIdentifier/uniqueID"
          },
          {
            "name": "valueId",
            "in": "path",
            "description": "The unique numeric ID for identifying the attribute allowed value.",
            "required": true,
            "schema": {
              "type": "string",
              "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/allowedValue/identifier"
            },
            "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/allowedValue/identifier"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AllowedValues"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Change",
        "x-expression-template": "/AttributeDictionaryAttribute[1]/AllowedValue[1]",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "changeAttributeDictionaryAttribute",
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeAttributeDictionaryAttributeType",
        "x-codegen-request-body-name": "body"
      }
    },
    "/attribute-dictionary-attributes/{id}/descriptions": {
      "post": {
        "tags": [
          "Attribute Dictionary Attributes"
        ],
        "operationId": "createAttributeDictionaryAttributeDescription",
        "summary": "Add a new description to attribute dictoinary attribute.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the attribute dictionary attribute.",
            "required": true,
            "schema": {
              "type": "string",
              "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeIdentifier/uniqueID"
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId"
            },
            "x-context-data": "storeId"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AttributeDescription"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation is successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the attribute dictionary attributes.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetAttributeDictionaryAttributesByIdAndLanguageIdAndStoreId": {
                "operationRef": "#/paths/~1attribute-dictionary-attributes~1{id}~1descriptions~1{languageId}/get",
                "parameters": {
                  "id": "$request.path.id",
                  "languageId": "$request.body#/languageId",
                  "storeId": "$request.query.storeId"
                },
                "description": "The `id`, `languageId` and `storeId`  value used in the request body can be used as the `id`, `languageId` and `storeId` parameter in `GET /attribute-dictionary-attributes/{id}/descriptions/{languageId}.\n"
              },
              "UpdateAttributeDictionaryAttributesByIdAndLanguageIdAndStoreId": {
                "operationRef": "#/paths/~1attribute-dictionary-attributes~1{id}~1descriptions~1{languageId}/patch",
                "parameters": {
                  "id": "$request.path.id",
                  "languageId": "$request.body#/languageId",
                  "storeId": "$request.path.storeId"
                },
                "description": "The `id`, `languageId` and `storeId` value used in the request body can be used as the `id`, `languageId` and `storeId` parameter in `PATCH /attribute-dictionary-attributes/{id}/descriptions/{languageId}.\n"
              }
            },
            "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeDescription[1]/language"
          }
        },
        "x-action-code": "Add",
        "x-expression-template": "/AttributeDictionaryAttribute[1]/AttributeDescription[1]",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "changeAttributeDictionaryAttribute",
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeAttributeDictionaryAttributeType",
        "x-request-verb": "change",
        "x-response-verb": "respond",
        "x-codegen-request-body-name": "body"
      }
    },
    "/attribute-dictionary-attributes/{id}/descriptions/{languageId}": {
      "get": {
        "tags": [
          "Attribute Dictionary Attributes"
        ],
        "operationId": "getAttributeDictionaryAttributeDescriptionById",
        "summary": "Get the descriptions that are part of an attribute dictionary attribute for a specific language.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the attribute dictionary attribute.",
            "required": true,
            "schema": {
              "type": "string",
              "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeIdentifier/uniqueID"
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The integer for identifying the language of the attribute dictionary attribute description. For a list of the integers that map to the supported default languages, refer to the Knowledge Center.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId"
            },
            "x-context-data": "storeId"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AttributeDescription"
                }
              }
            },
            "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeDescription[1]"
          }
        },
        "x-expression-template": "{_wcf.ap='IBM_Admin_Details';_wcf.dataLanguageIds='{languageId}'}/AttributeDictionaryAttribute[AttributeIdentifier[(UniqueID='{id}')]]",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "getAttributeDictionaryAttribute",
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.GetAttributeDictionaryAttributeType"
      },
      "patch": {
        "summary": "Update the description of an attribute dictionary attribute.",
        "tags": [
          "Attribute Dictionary Attributes"
        ],
        "operationId": "updateAttributeDictionaryAttributeDescription",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the attribute dictionary attribute.",
            "required": true,
            "schema": {
              "type": "string",
              "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeIdentifier/uniqueID"
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The langauge ID of the attribute description.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeDescription[1]/language"
            },
            "x-entity-path": "dataArea/attributeDictionaryAttribute[1]/attributeDescription[1]/language"
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId"
            },
            "x-context-data": "storeId"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AttributeDescription"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Change",
        "x-expression-template": "/AttributeDictionaryAttribute[1]/AttributeDescription[1]",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "changeAttributeDictionaryAttribute",
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeAttributeDictionaryAttributeType",
        "x-codegen-request-body-name": "body"
      }
    }
  },
  "components": {
    "schemas": {
      "AllowedValue": {
        "type": "object",
        "properties": {
          "default": {
            "type": "boolean",
            "description": "Whether or not this is the default value."
          },
          "extendedData": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "The extended data of the attribute value.",
            "x-entity-path": "extendedValue"
          },
          "id": {
            "type": "string",
            "description": "The ID of the attribute value.",
            "x-entity-path": "identifier"
          },
          "languageId": {
            "type": "integer",
            "format": "int32",
            "description": "The language for this attribute description.",
            "x-entity-path": "language"
          },
          "sequence": {
            "type": "number",
            "description": "The display order of attributes in an attribute group or in the root of the attribute dictionary.",
            "format": "double",
            "x-entity-path": "displaySequence"
          },
          "storeId": {
            "type": "integer",
            "description": "The ID of the store the attribute value belongs.",
            "format": "int32",
            "x-entity-path": "storeID"
          },
          "value": {
            "type": "string",
            "description": "The value of the attribute.",
            "x-entity-path": "value"
          }
        },
        "description": "An allowed value of an attribute dictonary attribute.",
        "x-entity-class": "com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType"
      },
      "AllowedValues": {
        "type": "object",
        "properties": {
          "default": {
            "type": "boolean",
            "description": "Whether or not this is the default value."
          },
          "extendedData": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "The extended data of the attribute value.",
            "x-entity-path": "extendedValue"
          },
          "identifier": {
            "type": "string",
            "description": "The identifier of the attribute value.",
            "x-entity-path": "value"
          },
          "languageId": {
            "type": "integer",
            "format": "int32",
            "description": "The language for this attribute description.",
            "x-entity-path": "language"
          },
          "sequence": {
            "type": "number",
            "description": "The display order of attributes in an attribute group or in the root of the attribute dictionary.",
            "format": "double",
            "x-entity-path": "displaySequence"
          },
          "storeId": {
            "type": "integer",
            "description": "The ID of the store the attribute value belongs.",
            "format": "int32",
            "x-entity-path": "storeID"
          },
          "value": {
            "type": "string",
            "description": "The value of the attribute.",
            "x-entity-path": "value"
          }
        },
        "description": "An allowed value of an attribute dictonary attribute.",
        "x-entity-class": "com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType"
      },
      "AllowedValueCollection": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AllowedValue"
            }
          }
        },
        "description": "A collection of attribute allowed values."
      },
      "AttributeDescription": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "description": "The attribute description."
          },
          "extendedData": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "The extended data of the attribute description."
          },
          "languageId": {
            "type": "integer",
            "format": "int32",
            "description": "The language for this attribute description.",
            "x-entity-path": "language"
          },
          "name": {
            "type": "string",
            "description": "The name of the attribute."
          }
        },
        "description": "An description of an attribute dictonary attribute.",
        "x-entity-class": "com.ibm.commerce.catalog.facade.datatypes.AttributeDescriptionType"
      },
      "AttributeDictionaryAttribute": {
        "type": "object",
        "properties": {
          "attributeDictionaryId": {
            "type": "string",
            "description": "The attribute dictionary ID.",
            "x-entity-path": "attributeIdentifier/externalIdentifier/attributeDictionaryIdentifier/uniqueID"
          },
          "attributeType": {
            "type": "string",
            "description": "Defines the type of the attribute. AllowedValues - Attribute with allowed values. When assign this type of attribute to catalog entry, user need to choose from the predefined allowed values. AssignedValues - Attribute with assigned values.This type of attribute does not have predefined allowed value. When assign this type of attribute to catalog entry, user need to input a value. This value belongs to the catalog entry."
          },
          "comparable": {
            "type": "boolean",
            "description": "Indicates that customers  can use this attribute for comparisions in the store."
          },
          "dataType": {
            "type": "string",
            "description": "The data type of the attribute. For example, String, Integer, or Float.",
            "x-entity-path": "attributeDataType"
          },
          "descriptions": {
            "type": "array",
            "description": "The descriptions of the attribute.",
            "items": {
              "$ref": "#/components/schemas/AttributeDescription"
            },
            "x-entity-path": "attributeDescription"
          },
          "displayable": {
            "type": "boolean",
            "description": "Indicates if this attribute is displayable on the store front."
          },
          "extendedData": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "The extended data of the attribute."
          },
          "facetProperties": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "The properties related to facet."
          },
          "facetable": {
            "type": "boolean",
            "description": "Specifies that the attribute is used as a facet in the storefront for faceted navigation."
          },
          "id": {
            "type": "string",
            "description": "The attribute dictionary attribute ID",
            "x-entity-path": "attributeIdentifier/uniqueID"
          },
          "identifier": {
            "type": "string",
            "description": "An external identifier for the attribute.",
            "x-entity-path": "attributeIdentifier/externalIdentifier/identifier"
          },
          "merchandisable": {
            "type": "boolean",
            "description": "Specifies that the attribute is used in creating merchandising rules. This indicates that the attribute is for internal business use only and does not display to customers unless it is also set to be displayable, searchable, or facetable."
          },
          "searchable": {
            "type": "boolean",
            "description": "Indicates that customers can search this attribute in the store."
          },
          "sequence": {
            "type": "number",
            "description": "The display order of attributes in an attribute group or in the root of the attribute dictionary.",
            "format": "double",
            "x-entity-path": "displaySequence"
          },
          "storeDisplay": {
            "type": "string",
            "description": "Reserved for IBM internal use. 1 - This attribute is used as a ribbon ad (image overlays)."
          },
          "storeId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the store.",
            "format": "int32",
            "x-entity-path": "attributeIdentifier/externalIdentifier/storeIdentifier/uniqueID"
          }
        },
        "description": "An attribute dictonary attribute.",
        "x-entity-class": "com.ibm.commerce.catalog.facade.datatypes.AttributeDictionaryAttributeType"
      },
      "AttributeDictionaryAttributes": {
        "type": "object",
        "properties": {
          "attributeDictionaryId": {
            "type": "string",
            "description": "The attribute dictionary ID.",
            "x-entity-path": "attributeIdentifier/externalIdentifier/attributeDictionaryIdentifier/uniqueID"
          },
          "attributeType": {
            "type": "string",
            "description": "Defines the type of the attribute. AllowedValues - Attribute with allowed values. When assign this type of attribute to catalog entry, user need to choose from the predefined allowed values. AssignedValues - Attribute with assigned values.This type of attribute does not have predefined allowed value. When assign this type of attribute to catalog entry, user need to input a value. This value belongs to the catalog entry."
          },
          "comparable": {
            "type": "boolean",
            "description": "Indicates that customers  can use this attribute for comparisions in the store."
          },
          "dataType": {
            "type": "string",
            "description": "The data type of the attribute. For example, String, Integer, or Float.",
            "x-entity-path": "attributeDataType"
          },
          "descriptions": {
            "type": "array",
            "description": "The descriptions of the attribute.",
            "items": {
              "$ref": "#/components/schemas/AttributeDescription"
            },
            "x-entity-path": "attributeDescription"
          },
          "displayable": {
            "type": "boolean",
            "description": "Indicates if this attribute is displayable on the store front."
          },
          "extendedData": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "The extended data of the attribute."
          },
          "facetProperties": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "The properties related to facet."
          },
          "facetable": {
            "type": "boolean",
            "description": "Specifies that the attribute is used as a facet in the storefront for faceted navigation."
          },
          "identifier": {
            "type": "string",
            "description": "An external identifier for the attribute.",
            "x-entity-path": "attributeIdentifier/externalIdentifier/identifier"
          },
          "merchandisable": {
            "type": "boolean",
            "description": "Specifies that the attribute is used in creating merchandising rules. This indicates that the attribute is for internal business use only and does not display to customers unless it is also set to be displayable, searchable, or facetable."
          },
          "searchable": {
            "type": "boolean",
            "description": "Indicates that customers can search this attribute in the store."
          },
          "sequence": {
            "type": "number",
            "description": "The display order of attributes in an attribute group or in the root of the attribute dictionary.",
            "format": "double",
            "x-entity-path": "displaySequence"
          },
          "storeDisplay": {
            "type": "string",
            "description": "Reserved for IBM internal use. 1 - This attribute is used as a ribbon ad (image overlays)."
          },
          "storeId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the store.",
            "format": "int32",
            "x-entity-path": "attributeIdentifier/externalIdentifier/storeIdentifier/uniqueID"
          }
        },
        "description": "An attribute dictonary attribute.",
        "x-entity-class": "com.ibm.commerce.catalog.facade.datatypes.AttributeDictionaryAttributeType"
      },
      "AttributeDictionaryAttributeCollection": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AttributeDictionaryAttribute"
            }
          }
        },
        "description": "A collection of attribute dictonary attributes."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}