VMware Cloud Director API - Right

RightType

Element:

Right

Type:

RightType

Namespace:

http://www.vmware.com/vcloud/v1.5

Description:

Represents a right.

Since:

0.9

Deprecated:

33.0

Schema:

user.xsd

Media type(s):

application/vnd.vmware.admin.right+xml
application/vnd.vmware.admin.right+json

Extends:

EntityType

XML Representation:

<Right xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
        name="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <Description> xs:string </Description>
    <Tasks>
        <Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                cancelRequested="xs:boolean">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string" model="xs:string"/>
            <Description> xs:string </Description>
            <Tasks> TasksInProgressType </Tasks>
            <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                    vendorSpecificErrorCode="xs:string">
                <TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
            </Error>
            <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
            <Details> xs:string </Details>
            <VcTaskList>
                <VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
                        errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
                        virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
            </VcTaskList>
            <Result>
                <ResultContent> ... </ResultContent>
                <ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            </Result>
        </Task>
    </Tasks>
    <RightType> xs:string </RightType>
    <Category> xs:string </Category>
    <BundleKey> xs:string </BundleKey>
    <ServiceNamespace> xs:string </ServiceNamespace>
</Right>

Attributes

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

Elements

Element	Type	Required	Modifiable	Since	Description
BundleKey	string	No	always	5.1	Key used for name localization.
Category	string	Yes	none	0.9	Assigns a category to the right.
Description	string	No	always	0.9	Optional description.
Link	LinkType	No	none	0.9	A reference to an entity or operation associated with this object.
RightType	string	Yes	none	31.0	Assigns a RightType to the right
ServiceNamespace	string	No	none	5.1	Namespace of the external service that created the right.
Tasks	TasksInProgressType	No	none	0.9	A list of queued, running, or recently completed tasks associated with this entity.
VCloudExtension	VCloudExtensionType	No	always	0.9	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}/rights	Registers right to the rights managed by this extension service.	5.1
read	GET /admin/org/{orgId}/right/{id}	Retrieves right in the context of an organization
read	GET /admin/right/{id}	Retrieves a right.	0.9	33.0
update	PUT /admin/right/{id}	Updates a right.	5.1	33.0
delete	DELETE /admin/org/{orgId}/right/{id}	Unlink a right from an organization
delete	DELETE /admin/right/{id}	Deletes a right.	5.1	33.0