Attributes Service, Version 3.3

19 Attributes Service, Version 3.3

This chapter provides the information necessary to send messages contained in Version 3.3 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_3/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.3 of the Attribute Services API.

addOrUpdateAttribute

                   Long addOrUpdateAttribute(
         AttributeRequest attributeData)
     throws RelateProcessingException

Variable	Required	Description
attributeData	Required	The attribute data being posted.
securityUserId	Required	ID of the Customer Engagement user performing the transaction.

The addOrUpdateAttribute method posts an update to an existing attribute or creates a new attribute.

This method returns the attributeId as a Long value.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully.

retrieveAttributeValueList

string[] retrieveAttributeValueList(
                long attributeId)
                string securityUserId)
     throws RelateProcessingException

Variable	Required	Description
attributeId	Required	ID of the attribute.
securityUserId	Required	ID of the Customer Engagement user performing the transaction.

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

This method returns an array of string values.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully.

retrieveAttributes

attributesType retrieveAttributes(
             AttributesIntendedUseType intendedUseType)
             string securityUserId)
     throws RelateProcessingException

Variable	Required	Description
intendedUseType	Optional	Intended use.
securityUserId	Required	ID of the Customer Engagement user performing the transaction.

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

This method returns an array of attributesType elements.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully.

Classes

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

AttributeIntendedIndustry

Identical to the AttributeIntendedIndustry.

AttributeRequest

The AttributeRequest element contains the following elements:

Type	Element	Description
String	attributeId	ID of the attribute.
String	attributeName	Name of the attribute.
String	description	Description of the attribute.
AttributeIntendedIndustry	intendedIndustry	Intended industry for the attribute.
AttributesIntendedUseType	intendedUse	Intended use of the attribute.
String	attributeGroup	A code used to group attributes.
Boolean	uniqueFlag	Indicates whether the attribute can only be set once for each element to which it is assigned.
Boolean	publishToBatch ExporterFlag	Indicates whether the attribute should be published to the Batch Exporter.
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 is open access.
AttributeDataType	dataType	Data type of the attribute.
String	attributeEnumValues	List of enumerated values for the attribute.

attributesType

The attributesType element 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.
Boolean	publishToBatch ExporterFlag	Indicates whether the attribute should be published to the Batch Exporter.
String	attributeGroup	A code used to group attributes.

Exception

See Introduction.

RelateProcessingException

For a description of this class, see Introduction.