17 Attributes Service, Version 3.1

This chapter provides the information necessary to send messages contained in Version 3.1 of the Attributes Service API. Information can be obtained using the Web Service Description Language (WSDL) in conjunction with a Simple Object Access Protocol (SOAP), XML Schema, and various methods contained in the classes of the API to provide the web service described above.

The URL for the WSDL is:

https://<servername>:<portNumber>/ws/v3_1/AttributesService?wsdl

where <servername> is the name or address of the server. For a cloud installation, the default port number is 443.

The information presented below describes the methods and classes.

The format of the method and any arguments is shown along with an explanation of what the method does and any other information that is necessary to use the method properly. If an argument is shown in dark blue, it is a class and the class name is a link to a description of the class and its attributes.

The class section shows the attributes of the classes along with an explanation of each attribute and when necessary, when they are used

Note:

Authentication is required. See Introduction for information on creating and implementing an authentication key.

Methods

This section presents the methods used in Version 3.1 of the Attribute Services API.

retrieveAttributeValueList

string[] retrieveAttributeValueList(
                long attributeId)
     throws RelateProcessingException

Variable	Required	Description
attributeID	Required	The ID of the attribute.

The retrieveAttributeValueList method retrieves the values available for an attribute of type List.

This method returns an array of string values.

retrieveAttributes

attributesType retrieveAttributes(
             AttributesIntendedUseType intendedUseType)
     throws RelateProcessingException

Variable	Required	Description
intendedUseType	Optional	The attribute data being posted.

The retrieveAttributes method retrieves all the attributes assigned to an intended use.

This method returns an array of attributesType elements.

Classes

This section presents the classes used in Version 3.1 of the Attribute Services API.

attributesType

The attributesType class contains the following elements:

Type	Element	Description
String	attributeId	ID of the attribute.
String	attributeName	Name of the attribute.
String	attributeDescription	Description of the attribute.
AttributesIntendedUseType	intendedUse	Intended use of the attribute.
String	dataType	Data type of the attribute.
Boolean	uniqueFlag	Indicates whether the attribute can only be set once for each element to which it is assigned.
Boolean	requiredFlag	Indicates whether the attribute is required for each element in its intended use.
Boolean	editableFlag	Indicates whether the attribute value can be edited.
Boolean	openAccessFlag	Indicates whether the attribute has open access.
AttributesIntendedIndustryType	intendedIndustry	Intended industry for the attribute.
String	attributeGroup	A code used to group attributes.

Exception

See Introduction.

RelateProcessingException

For a description of this class, see Introduction.