CustomProperty

Developed in the context of the Uplink Connection on the NSG, this API could be used for other types of objects. It is used as a collection of name-value (or key-value) pairs for custom attributes that could be used to enrich existing class instances.

Overview

attributeName string filterable   orderable  
attributeValue string filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  

API Resource

/customproperties/id
delete get put

Parents

/uplinkconnections/id/customproperties
get post put

Children

/customproperties/id/metadatas
get post
/customproperties/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

attributeName string filterable   orderable  
Discussion

The name of the custom attribute (key) used to enrich the object the customProperty instance is attached to.

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: attributeName

attributeValue string filterable   orderable  
Discussion

The value assigned to the custom attribute (key) of that customProperty instance.

Charateristics

Format: free
Min length: 1
Max length: 4091
SDK attribute: attributeValue

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy