7.2
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Overview of the vRealize Automation REST API
- REST API Authentication
- REST API Use Cases
- Create a Tenant
- Syntax for Displaying Your Current Tenants
- Syntax for Requesting a New Tenant
- Syntax for Listing All Tenant Identity Stores
- Syntax for Linking an Identity Store to the Tenant
- Syntax for Searching LDAP or Active Directory for a User
- Syntax for Assigning a User to a Role
- Syntax for Displaying all Roles Assigned to a User
- Request a Machine
- Approve a Machine Request
- List Provisioned Resources
- Manage Provisioned Deployments
- Working with Reservations
- Create a Reservation
- Display a List of Supported Reservation Types
- Displaying a Schema Definition for a Reservation
- Get the Business Group ID for a Reservation
- Get a Compute Resource for the Reservation
- Getting a Resources Schema by Reservation Type
- Creating a Reservation By Type
- Verify a Reservation and Get Reservation Details
- Display a List of Reservations
- Update a Reservation
- Delete a Reservation
- Create a Reservation
- Working with Reservation Policies
- Working with Key Pairs
- Working with Network Profiles
- Get a List of Available IP Ranges for an IPAM Provider
- Import and Export Content
- Syntax for Listing Supported Content Types
- Syntax for Listing Available Content
- Syntax for Filtering Content by Content Type
- Syntax for Creating a Package for Export
- Syntax for Listing Packages in the Content Service
- Syntax for Exporting a Package
- Syntax for Validating a Content Bundle Before Importing
- Syntax for Importing a Package
- Understanding Blueprint Schema
- Manage XaaS Content with Import and Export
- Create a Tenant
- Related Tools and Documentation
- Filtering and Formatting REST API Information
- Index
Property Description
version Displays the object version number.
assignees Displays the list of work item assignees.
subTenantId Optionally associates the work item with a specic business group granting users with
management responsibilities over that business group permission to see the approval.
tenantId Species the tenant ID for the work item.
callbackEntityId Species the callback entity ID for the work item.
work itemType Species the work item type for the work item.
completedDate Species the date when the work item was completed.
assignedDate Species the date when the work item was assigned.
createdDate Species the created date of this instance.
assignedOrCompletedDate Species the date to be displayed on UI.
formUrl Species the URL from which the layout for this work item can be retrieved.
serviceId Species the service ID that generated this work item instance.
work itemRequest Species the corresponding work item request object.
status Species the status of the work item.
completedBy Species the principal ID of user who completed the work item.
availableActions Contains a list of relevant work item actions.
Metadata Species the paging-related data:
n
Size: Species the maximum number of rows per page.
n
totalElement: Species the number of rows returned.
n
totalPages: Species the total number of pages of data available.
n
Number: Species the current page number.
n
Oset: Species the number of rows skipped.
Example: Example: curl Command
Approve a submied machine request by specifying its work item ID and using a JSON le named
approve.json to pass arguments to the command line.
curl --insecure -H "Content-Type: application/json"
-H "Authorization: Bearer $token"
https://$host/workitem-service/api/workitems/5e3e9519-78ea-4409-
a52c-e4aa3bc56511/actions/com.mycompany.csp.core.approval.action.approve
--d @approve.json
Error Conditions
If the same request is submied a second time, the following error response is received:
Command failed [Rest Error]: {Status code: 400}, {Error code: 12005} ,
{Error Source: null}, {Error Msg: Work item 5e3e9519-78ea-4409-a52c-e4aa3bc56511
is in COMPLETED state. Requested operation cannot be performed.}, {System Msg:
Work item 5e3e9519-78ea-4409-a52c-e4aa3bc56511 is in COMPLETED state. Requested
operation cannot be performed.}
Programming Guide
66 VMware, Inc.