Catalog: AttributeDictionaryAttribute Noun

AttributeDictionaryAttribute noun is used to model an attribute dictionary attribute.
An attribute dictionary provides a central place to manage common attributes shared by products.

BOD Summary

Access Profile and Expression Builder columns are for Get BOD only.
BOD Action Code / Access Profile Action Expression Service Provided Sample XML Message Client Library / Expression Builder
ProcessAttributeDictionaryAttribute Create /AttributeDictionaryAttribute[i] Creates a new attribute dictionary attribute and corresponding data (like allowed values in the database.

Exceptions: An error results if one of the following conditions occurs:
  • The attribute data type is not specified.
  • Attribute identifier already exists.
  • Attribute name in default language is missing.
 Request
Response

Delete /AttributeDictionaryAttribute[i] Delete an attribute dictionary attribute and corresponding data (like allowed values in the database.

Exceptions: An error results if one of the following conditions occurs:
  • This attribute is referenced by at least one catalog entry.
 Request
Response

ChangeAttributeDictionaryAttribute Change /AttributeDictionaryAttribute[i] Updates the base properties of an attribute dictionary attribute.

 Request
Response

CatalogFacadeClient.changeAttributeDictionaryAttribute(ChangeAttributeDictionaryAttributeType)
Add /AttributeDictionaryAttribute[i]/AllowedValue[i] Adds a new allowed value and allowed value description for the given attribute based on the value, data type of value, display sequence provided in the request BOD

Exceptions: An error results if one of the following conditions occur:
  • The attribute value to be created already exists.
  • If this attribute is defined as assigned value attribute, no allowed value can be added to this attribute.
  • The data type of the attribute value is not the same as the one defined in the attribute.
Request
Response

CatalogFacadeClient.changeAttributeDictionaryAttribute(ChangeAttributeDictionaryAttributeType)
Change /AttributeDictionaryAttribute[i]/AllowedValue[i] Updates the attribute dictionary attribute allowed value of a string data type by specifying a new value. Request
Response

CatalogFacadeClient.changeAttributeDictionaryAttribute(ChangeAttributeDictionaryAttributeType)
Change /AttributeDictionaryAttribute[i]/AllowedValue[i] Updates the attribute dictionary attribute allowed value of a integer data type by specifying a new value. Request
Response

CatalogFacadeClient.changeAttributeDictionaryAttribute(ChangeAttributeDictionaryAttributeType)
Change /AttributeDictionaryAttribute[i]/AllowedValue[i] Updates the attribute dictionary attribute allowed value of a float data type by specifying a new value. Request
Response

CatalogFacadeClient.changeAttributeDictionaryAttribute(ChangeAttributeDictionaryAttributeType)
Change /AttributeDictionaryAttribute[i]/AllowedValue[i] Updates the attribute dictionary attribute allowed value in a different language (languageID is provided in the noun part). Request
Response

CatalogFacadeClient.changeAttributeDictionaryAttribute(ChangeAttributeDictionaryAttributeType)
Change /AttributeDictionaryAttribute[i]/AllowedValue[i] Updates the attribute dictionary attribute allowed value by specifying a new value (custom fields and additional data for the value and value descriptions are provided). Request
Response

CatalogFacadeClient.changeAttributeDictionaryAttribute(ChangeAttributeDictionaryAttributeType)
Delete /AttributeDictionaryAttribute[i]/AllowedValue[i] Deletes the attribute dictionary attribute allowed value from an attribute. Request
Response

CatalogFacadeClient.changeAttributeDictionaryAttribute(ChangeAttributeDictionaryAttributeType)
Change /AttributeDictionaryAttribute[i]/AttributeIdentifier Updates the external identifier of an attribute dictionary attribute.

Exceptions: An error results if one of the following conditions occur:
  • The identifier is null or empty string.
  • The identifier already exists for another attribute in the dictionary.
 Request
Response

CatalogFacadeClient.changeAttributeDictionaryAttribute(ChangeAttributeDictionaryAttributeType)
Change /AttributeDictionaryAttribute[i]/AttributeDescription[i] Updates the description of an attribute dictionary attribute.
If the language-dependent description is not found in the database, then a new one is created.
You can use this action to change the following fields:
  • Name
  • Description
  • Extended Data including Secondary Description, Footnote, UnitOfMeasure, Field1 and DisplayGroupName

Exceptions: An error results if one of the following conditions occurs:
  • The language ID provided is not supported in the given store.
 Request
Response

CatalogFacadeClient.changeAttributeDictionaryAttribute(ChangeAttributeDictionaryAttributeType)
GetAttributeDictionaryAttribute Access profiles 'IBM_Admin_Summary' and 'IBM_Admin_Details' listed in the 'Access Profile' section can be applied to this expression. /AttributeDictionaryAttribute[AttributeIdentifier[ExternalIdentifier[AttributeDictionaryIdentifier[(UniqueID=)]]and ParentAttributeGroup]] Get Attribute by Attribute Dictionary ID.

Returns the orphan attributes(with out parent attribute groups) for the given attribute dictionary ID. 		Request
Response

getAttrByAttrDictID
Access profiles 'IBM_Admin_Summary' and 'IBM_Admin_Details' listed in the 'Access Profile' section can be applied to this expression. /AttributeDictionaryAttribute[AttributeIdentifier[(UniqueID=)]] Get Attribute by Attribute Unique ID.

 Request
Response

getAttributeDictionaryAttributeSummaryByIDs
Access profile 'IBM_Admin_AttributeDictionaryAttributeAllowedValues_Paging' listed in the 'Access Profile' section can be applied to this expression. /AttributeDictionaryAttribute[AttributeIdentifier[UniqueID=]]/AllowedValue Get attribute allowed values of current page by attribute unique id.

 Request
Response

getAttributeDictionaryAttributeAllowedValuesWithPaging
Access profiles 'IBM_Admin_Summary' and 'IBM_Admin_Details' listed in the 'Access Profile' section can be applied to this expression. /AttributeDictionaryAttribute[search($searchCriteria$) and searchable=] Get Searchable Attribute Dictionary Attributes
Returns the attribute dictionary attributes that are searchable and match the specified search criteria, belonging to the store ID in the context.

Search is case insensitive and can be performed using one field with wild-card characters included.
The following fields can be used to specify search criteria.
  • Attribute Identifier
  • Attribute Name
 Request
Response

getSearchableAttributeDictionaryAttributeByIdentifierOrName
Access profiles 'IBM_Admin_Summary' and 'IBM_Admin_Details' listed in the 'Access Profile' section can be applied to this expression. /AttributeDictionaryAttribute[merchandisable= and search($searchCriteria$)] Get Merchandisable Attribute Dictionary Attributes
Returns the attribute dictionary attributes that are merchandisable and match the specified search criteria, belonging to the store ID in the context.

Search is case insensitive and can be performed using one field with wild-card characters included.
The following fields can be used to specify search criteria.
  • Attribute Identifier
  • Attribute Name
 Request
Response

Access profiles 'IBM_Admin_Summary' and 'IBM_Admin_Details' listed in the 'Access Profile' section can be applied to this expression. /AttributeDictionaryAttribute[facetable= and search($searchCriteria$)] Get Facetable Attribute Dictionary Attributes
Returns the attribute dictionary attributes that are facetable and match the specified search criteria, belonging to the store ID in the context.

Search is case insensitive and can be performed using one field with wild-card characters included.
The following fields can be used to specify search criteria.
  • Attribute Identifier
  • Attribute Name
 Request
Response

Access profiles 'IBM_Admin_Summary' and 'IBM_Admin_Details' listed in the 'Access Profile' section can be applied to this expression. /AttributeDictionaryAttribute[search($searchCriteria$)] Search Attribute Dictionary Attributes
Returns the attribute dictionary attributes match the specified search criteria, belonging to the store ID in the context.

Search is case insensitive and can be performed using multiple fields with wild-card characters included.
The following fields can be used to specify search criteria.
  • Attribute Identifier
  • Attribute Name
 Request
Response

getAttributeDictionaryAttributeByIdentifierOrName
Access profiles 'IBM_Admin_AttributeDictionaryAttributeAllowedValues' listed in the 'Access Profile' section can be applied to this expression. /AttributeDictionaryAttribute[AttributeIdentifier[UniqueID=]]/AllowedValue[(@identifier=)] Get Attribute Dictionary Attributes and the allowed values for the given Attribute Dictionary Attribute unique ID and attribute value unique ID
Only the attribute values for the given attribute Dictionary Attribute unique ID and attribute value unique ID will be returned. 		Request
Response

Access Profile

Some sample XML request and response web service messages are provided for each noun. These sample messages might not include all properties or attributes. To view a sample message that includes other properties or attributes, enable logging and tracing for the appropriate component and then call the web service to set or change the properties or attributes. Review the corresponding log file to see the request or response information.

Access Profile Data Returned
IBM_Admin_Summary
  • /AttributeDictionaryAttribute( @displaySequence @displayable @searchable @comparable @merchandisable)
  • /AttributeDictionaryAttribute/AttributeIdentifier/UniqueID
  • /AttributeDictionaryAttribute/AttributeIdentifier/ExternalIdentifier/AttributeDictionaryIdentifier/UniqueID
  • /AttributeDictionaryAttribute/AttributeIdentifier/ExternalIdentifier/Identifier
  • /AttributeDictionaryAttribute/AttributeIdentifier/StoreIdentifier/UniqueID
  • /AttributeDictionaryAttribute/AttributeType
  • /AttributeDictionaryAttribute/AttributeDataType
  • /AttributeDictionaryAttribute/AttributeDescription(@language)
  • /AttributeDictionaryAttribute/AttributeDescription/Name
  • /AttributeDictionaryAttribute/AttributeDescription/Description
 This access profile is designed for the Catalogs tool. It returns the basic information of the attribute dictionary attribute. Get Orphan Attr Summary Request
Get Orphan Attr Summary Response
IBM_Admin_Details IBM_Admin_Summary
+
  • /AttributeDictionaryAttribute/ParentAttributeGroup/UniqueID
  • /AttributeDictionaryAttribute/ParentAttributeGroup/ExternalIdentifier/Identifier
  • /AttributeDictionaryAttribute/ParentAttributeGroup/ExternalIdentifier/StoreIdentifier/UniqueID
  • /AttributeDictionaryAttribute/ExtendedData
  • /AttributeDictionaryAttribute/ AttributeDescription/ExtendedData
 This access profile is designed for the Catalogs tool. It returns the basic information and detailed descripton of the attribute dictionary attribute. Get Orphan Attr Details Request
Get Orphan Attr Details Response
IBM_Admin_AttributeDictionaryAttributeAllowedValues_Paging
  • /AttributeDictionaryAttribute/AttributeIdentifier/UniqueID
  • /AttributeDictionaryAttribute/AttributeIdentifier/ExternalIdentifier/AttributeDictionaryIdentifier/UniqueID
  • /AttributeDictionaryAttribute/AttributeIdentifier/ExternalIdentifier/Identifier
  • /AttributeDictionaryAttribute/AttributeIdentifier/StoreIdentifier/UniqueID
  • /AttributeDictionaryAttribute/AttributeType
  • /AttributeDictionaryAttribute/AttributeDataType
  • /AttributeDictionaryAttribute/AllowedValue(@identifier @displaySequence @storeID @default @language)
  • /AttributeDictionaryAttribute/AllowedValue/Value
  • /AttributeDictionaryAttribute/AllowedValue/StringValue/Value
  • /AttributeDictionaryAttribute/AllowedValue/IntegerValue/Value
  • /AttributeDictionaryAttribute/AllowedValue/FloatValue/Value
  • /AttributeDictionaryAttribute/AllowedValue/ExtendedValue
  • /AttributeDictionaryAttribute/ExtendedData
 This access profile is designed for the Catalogs tool. It returns the detailed information of the attribute allowed values of current page. Get Attribute Allowed Values Request
Get Attribute Allowed Values Response
IBM_Admin_AttributeDictionaryAttributeAllowedValues
  • /AttributeDictionaryAttribute(@displaySequence @displayable @searchable @facetable @comparable @merchandisable)
  • /AttributeDictionaryAttribute/AttributeIdentifier/UniqueID
  • /AttributeDictionaryAttribute/AttributeIdentifier/ExternalIdentifier/AttributeDictionaryIdentifier/UniqueID
  • /AttributeDictionaryAttribute/AttributeIdentifier/ExternalIdentifier/Identifier
  • /AttributeDictionaryAttribute/AttributeIdentifier/StoreIdentifier/UniqueID
  • /AttributeDictionaryAttribute/AttributeType
  • /AttributeDictionaryAttribute/AttributeDataType
  • /AttributeDictionaryAttribute/AttributeDescription(@language)
  • /AttributeDictionaryAttribute/AttributeDescription/Name
  • /AttributeDictionaryAttribute/AllowedValue(@identifier @displaySequence @storeID @default @language)
  • /AttributeDictionaryAttribute/AllowedValue/Value
  • /AttributeDictionaryAttribute/AllowedValue/StringValue/Value
  • /AttributeDictionaryAttribute/AllowedValue/IntegerValue/Value
  • /AttributeDictionaryAttribute/AllowedValue/FloatValue/Value
  • /AttributeDictionaryAttribute/AllowedValue/ExtendedValue
  • /AttributeDictionaryAttribute/ExtendedData
 This access profile is designed for the Catalogs tool. It returns the detailed information of the attribute and attribute allowed values for the given attribute unique ID and attribute value unique ID. Get Attribute and Values Request
Get Attribute and Values Response

XSD files