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. |
Elements
Element | Type | Required | Modifiable | Since | Deprecated | Description |
---|---|---|---|---|---|---|
Link | LinkType | No | none | 29.0 | A reference to an entity or operation associated with this object. | |
OrgId | string | Yes | create | 29.0 | The URN of the organization with which to associate. | |
OrgName | string | Yes | create | 29.0 | The name of the organization with which to associate. | |
OrgPublicKey | string | Yes | create | 29.0 | PEM-encoded public key for this organization. | |
SiteId | string | Yes | create | 29.0 | The URN of the site that this organization occupies. | |
SiteName | string | No | none | 29.0 | The name of the site that the organization occupies. | |
Status | string | No | none | 29.0 |
Current status of this association. One of: ACTIVE (The association has been established by both members, and communication with the remote party succeeded.) ASYMMETRIC (The association has been established at the local site, but the remote party has not yet reciprocated.) UNREACHABLE (The association has been established by both members, but the remote member is currently unreachable.) |
|
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. |
Operations
CRUD | Operation | Description | Since | Deprecated |
---|---|---|---|---|
read | GET /admin/org/{id}/associations/localAssociationData | Gets the associaiton data for a given local org. | ||
read | GET /admin/org/{id}/associations/{remoteSiteId}/{remoteOrgId} | Retrieves a specific member from the organization's associations as identified by identifier included in the request | 29.0 | |
update | PUT /admin/org/{id}/associations/{remoteSiteId}/{remoteOrgId} | Update an organization association | 29.0 | |
delete | DELETE /admin/org/{id}/associations/{remoteSiteId}/{remoteOrgId} | Removes the specified member from this organization's associations. | 29.0 | |
as input | POST /admin/org/{id}/associations | Adds a new member to this organization's associations | 29.0 |