Argomento precedente: CustomAttributeData Classes

Argomento successivo: DomainCategoryData Classes

CustomAttributeData

Description

This class is used to represent data for custom attributes.

Members

Name

Type

Description

CustomAttributeDefinitionID

long

The ID of the custom attribute.

Name

string

The name of the custom attribute.

Type

CustomAttribute
ValueType

Enumeration of the type of the custom attribute. One of the following:

  • Text
  • Number
  • List
  • Hyperlink

IsMandatory

bool

Specifies whether or not the custom attribute must be set with an appropriate value. If the custom attribute does not have to be set, it can be omitted.

Value

string

The value of the custom attribute, according to its type.

HyperLinkDisplayText

string

The hyperlink display text of the custom attribute.

Relevant only when the custom attribute is of type hyperlink, in which case the Value field contains the link's URL and this field contains the link’s display text.

ListValues

List<string>

The list values of the custom attribute.

Relevant only when the custom attribute is of type list. Instead of containing a single string to represent the custom attribute's value, this field contains a list of strings representing the list’s values.

Remarks

None.

CustomAttributeDefinitionData Classes
CustomAttributeAttachment

Description

This class is used to represent data for contract party.

Members

Name

Type

Description

ID

long

The custom attribute ID.

EntityType

CustomAttributeAttachmentEntityType

Enumeration of the value type of the custom attribute (must be one of the following):

  • AllEntities
  • ResourceType
  • MetricType
  • ResourceGroupType

AllEntityType

EntityReferenceData

Reference by ID to the AllEntities type.

ResourceType

EntityReferenceData

Reference by ID to the ResourceType type.

MetricType

EntityReferenceData

Reference by ID to the MetricType type.

IsMandatory

bool

The attachment is mandatory or not mandatory.

DefaultValue

string

The default value for attachment of the attribute.

Remarks

The DefaultValue is in text even for non-text attributes’ attachment.

CustomAttributeDefinitionData

Description

This class is used to represent data for contract party.

Members

Name

Type

Description

ID

long

The custom attribute ID.

Name

string

The custom attribute name.

Description

string

The custom attribute description.

Type

long

The attribute type.

ValueType

CustomAttributeValue Type

Enumeration of the value type of the custom attribute (must be one of the following):

  • Text
  • Number
  • List
  • Hyperlink

DefaultValue

string

The default value of the attribute.

IsExternalDataSourceEnabled

bool

Enable the external data source or not.

ListValues

CustomAttributeListValueCollection

The list of string for attribute.

 

AttachmentsData

CustomAttributeListValueCollection.

CustomAttributeAttachment list of the attribute attachments.

Remarks

The DefaultValue is in text even for non-text attributes’ attachment.