VMware Cloud Director API - ServiceLink

VMware Cloud Director API - ServiceLink

AdminServiceLinkType

Element:
ServiceLink
Type:
AdminServiceLinkType
Namespace:
http://www.vmware.com/vcloud/extension/v1.5
Description:
Represents a service link defined by an extension service.
Since:
5.1
Schema:
services.xsd
Media type(s):
application/vnd.vmware.admin.serviceLink+json
application/vnd.vmware.admin.serviceLink+xml
Extends:
IdentifiableResourceType
XML Representation:
<ServiceLink xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string">
    <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <LinkHref> xs:string </LinkHref>
    <MimeType> xs:string </MimeType>
    <Rel> xs:string </Rel>
    <ResourceType> xs:string </ResourceType>
    <ResourceId> xs:string </ResourceId>
    <ExternalResourceId> xs:string </ExternalResourceId>
</ServiceLink>

Attributes

Attribute Type Required Modifiable Since Deprecated Description
href anyURI No always 5.1 The URI of the entity.
type string No always 5.1 The MIME type of the entity.
id string No none 5.1 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.

Elements

Element Type Required Modifiable Since Deprecated Description
ExternalResourceId string No always 6.0 The id of an external resource managed by an extension. The value of this element will appear as the id attribute of the Link element. Must be <=255 characters.
Link LinkType No none 5.1 A reference to an entity or operation associated with this object.
LinkHref string Yes always 5.1 The value of href attribute of this service Link. Can be any URI, and can include the variables {baseUri} and {resourceId}. When constructing the href value of the Link, vCloud Director replaces {baseUri} with the vCloud Director REST API base URL, and replaces {resourceId} with the UUID portion of the id attribute value of the resource in which the Link is inserted. Must be <=255 characters.
MimeType string Yes always 5.1 The value, specified as a MIME content type, of the type attribute of the Link. Must be <=255 characters.
Rel string Yes always 5.1 The value of the rel attribute of the Link. Must be <=255 characters.
ResourceId string No always 5.1 The id of the resource in which this Link appears. The resource must be of the type specified in ResourceType. If this element is missing or empty, the Link appears in all resources of the specified type. Must be <=255 characters.
ResourceType string Yes always 5.1 The object type, specified as a MIME content type, of the object in which the Link appears. Must be <=255 characters.
VCloudExtension VCloudExtensionType No always 5.1 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
create POST /admin/extension/service/{id}/links Create service link.
read GET /admin/extension/service/link/{id} Retrieves service link.
delete DELETE /admin/extension/service/link/{id} Deletes service link.