Attributes
Attribute | Type | Required | Modifiable | Since | Deprecated | Description |
---|---|---|---|---|---|---|
href | anyURI | No | always | 29.0 | The URI of the entity. | |
type | string | No | always | 29.0 | The MIME type of the entity. | |
id | string | No | none | 29.0 | The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused. | |
operationKey | string | No | create | 5.1 | Optional unique identifier to support idempotent semantics for create and delete operations. | |
name | string | Yes | always | 29.0 | The name of the entity. |
Elements
Element | Type | Required | Modifiable | Since | Deprecated | Description |
---|---|---|---|---|---|---|
AuthContext | string | No | 30.0 | The auth context for this org | ||
Description | string | No | always | 29.0 | Optional description. | |
Link | LinkType | No | none | 29.0 | A reference to an entity or operation associated with this object. | |
LocationId | string | No | 30.0 | The id of the location. format: orgId@siteId | ||
LocationName | string | No | create | 29.0 | JWT_LOGIN_SUPPORT | The name of the location. |
OrgName | string | No | create | 30.0 | The name of the organization. | |
RestApiEndpoint | anyURI | Yes | always | 29.0 | The vCloud API endpoint (RestApiBaseUri) for the location. | |
SiteName | string | No | create | 30.0 | The name of the site. | |
Tasks | TasksInProgressType | No | none | 29.0 | A list of queued, running, or recently completed tasks associated with this entity. | |
UIEndpoint | anyURI | No | always | 29.0 | The vCloud Director Web Console (SystemExternalHttpAddress) endpoint for the location. | |
UseMultisiteToken | boolean | No | always | 29.0 | JWT_LOGIN_SUPPORT | True if the location accepts multisite x-vcloud-authorization token for this user. |
VCloudExtension | VCloudExtensionType | No | always | 29.0 | An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services. |