v2 API Resource

The public REST API for version 2.0

GET /webservices/services/rest/v2/accounts

Retrieve all accounts.

Response Body
media type data type description
application/xml AccountCollection (XML) the accounts

Example

Request
GET /webservices/services/rest/v2/accounts
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<AccountCollection>
  <Accounts>
    <userid>...</userid>
    <password>...</password>
    <enabled>...</enabled>
    <role>
      <type>...</type>
      <id>...</id>
      <name>...</name>
      <permissions>...</permissions>
    </role>
    <firstName>...</firstName>
    <lastName>...</lastName>
    <primaryPhoneNo>...</primaryPhoneNo>
    <secondaryPhoneNo>...</secondaryPhoneNo>
    <emailAddress>...</emailAddress>
    <contextRoles>
      <context/>
      <role/>
    </contextRoles>
    <securitySourceType>...</securitySourceType>
    <roleName>...</roleName>
  </Accounts>
</AccountCollection>

                
              

POST /webservices/services/rest/v2/accounts

Create a user account.

Request Body
media type data type description
application/xml Account (XML) the acount
Response Body
media type data type description
application/xml Account (XML) the WS account

Example

Request
POST /webservices/services/rest/v2/accounts
Content-Type: application/xml
Accept: application/xml

                
<Account>
  <userid>...</userid>
  <password>...</password>
  <enabled>...</enabled>
  <role xsitype="...">
    <type>...</type>
    <id>...</id>
    <name>...</name>
    <permissions>...</permissions>
  </role>
  <firstName>...</firstName>
  <lastName>...</lastName>
  <primaryPhoneNo>...</primaryPhoneNo>
  <secondaryPhoneNo>...</secondaryPhoneNo>
  <emailAddress>...</emailAddress>
  <contextRoles>
    <context>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </context>
    <role>
      <type>...</type>
      <id>...</id>
      <name>...</name>
      <permissions>...</permissions>
    </role>
  </contextRoles>
  <securitySourceType>...</securitySourceType>
  <roleName>...</roleName>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Account>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<Account>
  <userid>...</userid>
  <password>...</password>
  <enabled>...</enabled>
  <role xsitype="...">
    <type>...</type>
    <id>...</id>
    <name>...</name>
    <permissions>...</permissions>
  </role>
  <firstName>...</firstName>
  <lastName>...</lastName>
  <primaryPhoneNo>...</primaryPhoneNo>
  <secondaryPhoneNo>...</secondaryPhoneNo>
  <emailAddress>...</emailAddress>
  <contextRoles>
    <context>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </context>
    <role>
      <type>...</type>
      <id>...</id>
      <name>...</name>
      <permissions>...</permissions>
    </role>
  </contextRoles>
  <securitySourceType>...</securitySourceType>
  <roleName>...</roleName>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Account>

                
              

DELETE /webservices/services/rest/v2/accounts/{login_id}

Delete an account.

Request Parameters
name type description
login_id path the login id
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
DELETE /webservices/services/rest/v2/accounts/{login_id}
Content-Type: text/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/accounts/{login_id}

Retrieve an account by id.

Request Parameters
name type description
login_id path the login id
Response Body
media type data type description
application/xml Account (XML) the account by login id

Example

Request
GET /webservices/services/rest/v2/accounts/{login_id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<Account>
  <userid>...</userid>
  <password>...</password>
  <enabled>...</enabled>
  <role xsitype="...">
    <type>...</type>
    <id>...</id>
    <name>...</name>
    <permissions>...</permissions>
  </role>
  <firstName>...</firstName>
  <lastName>...</lastName>
  <primaryPhoneNo>...</primaryPhoneNo>
  <secondaryPhoneNo>...</secondaryPhoneNo>
  <emailAddress>...</emailAddress>
  <contextRoles>
    <context>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </context>
    <role>
      <type>...</type>
      <id>...</id>
      <name>...</name>
      <permissions>...</permissions>
    </role>
  </contextRoles>
  <securitySourceType>...</securitySourceType>
  <roleName>...</roleName>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Account>

                
              

PUT /webservices/services/rest/v2/accounts/{login_id}

Update an account

Request Parameters
name type description
login_id path of the account to update
Request Body
media type data type description
application/xml Account (XML) object
Response Body
media type data type description
application/xml Account (XML) the updated WSAccount object

Example

Request
PUT /webservices/services/rest/v2/accounts/{login_id}
Content-Type: application/xml
Accept: application/xml

                
<Account>
  <userid>...</userid>
  <password>...</password>
  <enabled>...</enabled>
  <role xsitype="...">
    <type>...</type>
    <id>...</id>
    <name>...</name>
    <permissions>...</permissions>
  </role>
  <firstName>...</firstName>
  <lastName>...</lastName>
  <primaryPhoneNo>...</primaryPhoneNo>
  <secondaryPhoneNo>...</secondaryPhoneNo>
  <emailAddress>...</emailAddress>
  <contextRoles>
    <context>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </context>
    <role>
      <type>...</type>
      <id>...</id>
      <name>...</name>
      <permissions>...</permissions>
    </role>
  </contextRoles>
  <securitySourceType>...</securitySourceType>
  <roleName>...</roleName>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Account>

                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
<Account>
  <userid>...</userid>
  <password>...</password>
  <enabled>...</enabled>
  <role xsitype="...">
    <type>...</type>
    <id>...</id>
    <name>...</name>
    <permissions>...</permissions>
  </role>
  <firstName>...</firstName>
  <lastName>...</lastName>
  <primaryPhoneNo>...</primaryPhoneNo>
  <secondaryPhoneNo>...</secondaryPhoneNo>
  <emailAddress>...</emailAddress>
  <contextRoles>
    <context>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </context>
    <role>
      <type>...</type>
      <id>...</id>
      <name>...</name>
      <permissions>...</permissions>
    </role>
  </contextRoles>
  <securitySourceType>...</securitySourceType>
  <roleName>...</roleName>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Account>

                
              

POST /webservices/services/rest/v2/accounts/{login_id}/roleassignments

Set an account role assignments.

Request Parameters
name type description
login_id path the login id
Request Body
media type data type description
application/xml RoleAssignments (XML) the role assignments
Response Body
media type data type description
application/xml RoleAssignments (XML) the WS role assignments

Example

Request
POST /webservices/services/rest/v2/accounts/{login_id}/roleassignments
Content-Type: application/xml
Accept: application/xml

                
<RoleAssignments xsitype="...">
  <roleName>...</roleName>
</RoleAssignments>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<RoleAssignments xsitype="...">
  <roleName>...</roleName>
</RoleAssignments>

                
              

PUT /webservices/services/rest/v2/accounts/{login_id}/roleassignments

Update an account role assignments.

Request Parameters
name type description
login_id path the login id
Request Body
media type data type description
application/xml RoleAssignments (XML) the role assignments
Response Body
media type data type description
application/xml RoleAssignments (XML) the WS role assignments

Example

Request
PUT /webservices/services/rest/v2/accounts/{login_id}/roleassignments
Content-Type: application/xml
Accept: application/xml

                
<RoleAssignments xsitype="...">
  <roleName>...</roleName>
</RoleAssignments>

                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
<RoleAssignments xsitype="...">
  <roleName>...</roleName>
</RoleAssignments>

                
              

DELETE /webservices/services/rest/v2/accounts/{login_id}/roleassignments/contextroles

Remove an account context role assignments.

Request Parameters
name type description
login_id path the account userId
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
DELETE /webservices/services/rest/v2/accounts/{login_id}/roleassignments/contextroles
Content-Type: text/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: text/xml

                
...
                
              

POST /webservices/services/rest/v2/accounts/{userId}/action/sync

Synchronize the account indicated by the userId

Request Parameters
name type description
userId path The userId of the account to sync
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/accounts/{userId}/action/sync
Content-Type: text/plain
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

POST /webservices/services/rest/v2/accounts/cache/action/clear

Clears the account cache

Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/accounts/cache/action/clear
Content-Type: text/plain
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

POST /webservices/services/rest/v2/async/configurations/organizations

Create an organization.

Request Body
media type data type description
application/xml Organization (XML) the org
Response Body
media type data type description
application/xml TaskInfo (XML) the WS task info

Example

Request
POST /webservices/services/rest/v2/async/configurations/organizations
Content-Type: application/xml
Accept: application/xml

                
<Organization>
  <costQuota xsitype="...">
    <dailyCost>...</dailyCost>
  </costQuota>
  <resourceQuota xsitype="...">
    <stoppedVmsCalculateOnlyStorage>...</stoppedVmsCalculateOnlyStorage>
    <stoppedVmsAllowPowerOn>...</stoppedVmsAllowPowerOn>
    <useDiskTotalSize>...</useDiskTotalSize>
    <perStorageTierQuotas>...</perStorageTierQuotas>
    <storageInGB>...</storageInGB>
    <memoryInGB>...</memoryInGB>
    <CPUCount>...</CPUCount>
    <storageTierQuotas>
      <name>...</name>
      <quota>...</quota>
      <excluded>...</excluded>
    </storageTierQuotas>
  </resourceQuota>
  <Members xsitype="...">
    <costQuota>
      <dailyCost>...</dailyCost>
    </costQuota>
    <resourceQuota>
      <stoppedVmsCalculateOnlyStorage>...</stoppedVmsCalculateOnlyStorage>
      <stoppedVmsAllowPowerOn>...</stoppedVmsAllowPowerOn>
      <useDiskTotalSize>...</useDiskTotalSize>
      <perStorageTierQuotas>...</perStorageTierQuotas>
      <storageInGB>...</storageInGB>
      <memoryInGB>...</memoryInGB>
      <CPUCount>...</CPUCount>
      <storageTierQuotas/>
    </resourceQuota>
    <userId>...</userId>
    <manager>...</manager>
    <portalRole>...</portalRole>
    <organization>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organization>
  </Members>
  <name>...</name>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Organization>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

PUT /webservices/services/rest/v2/async/configurations/organizations/{id}

Edit an organization.

Request Parameters
name type description constraints
id path the org id long
Request Body
media type data type description
application/xml Organization (XML) the org
Response Body
media type data type description
application/xml TaskInfo (XML) the WS task info

Example

Request
PUT /webservices/services/rest/v2/async/configurations/organizations/{id}
Content-Type: application/xml
Accept: application/xml

                
<Organization>
  <costQuota xsitype="...">
    <dailyCost>...</dailyCost>
  </costQuota>
  <resourceQuota xsitype="...">
    <stoppedVmsCalculateOnlyStorage>...</stoppedVmsCalculateOnlyStorage>
    <stoppedVmsAllowPowerOn>...</stoppedVmsAllowPowerOn>
    <useDiskTotalSize>...</useDiskTotalSize>
    <perStorageTierQuotas>...</perStorageTierQuotas>
    <storageInGB>...</storageInGB>
    <memoryInGB>...</memoryInGB>
    <CPUCount>...</CPUCount>
    <storageTierQuotas>
      <name>...</name>
      <quota>...</quota>
      <excluded>...</excluded>
    </storageTierQuotas>
  </resourceQuota>
  <Members xsitype="...">
    <costQuota>
      <dailyCost>...</dailyCost>
    </costQuota>
    <resourceQuota>
      <stoppedVmsCalculateOnlyStorage>...</stoppedVmsCalculateOnlyStorage>
      <stoppedVmsAllowPowerOn>...</stoppedVmsAllowPowerOn>
      <useDiskTotalSize>...</useDiskTotalSize>
      <perStorageTierQuotas>...</perStorageTierQuotas>
      <storageInGB>...</storageInGB>
      <memoryInGB>...</memoryInGB>
      <CPUCount>...</CPUCount>
      <storageTierQuotas/>
    </resourceQuota>
    <userId>...</userId>
    <manager>...</manager>
    <portalRole>...</portalRole>
    <organization>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organization>
  </Members>
  <name>...</name>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Organization>

                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

GET /webservices/services/rest/v2/attributes

Retrieve a list of custom attributes

Response Body
media type data type description
application/xml CustomAttributeCollection (XML) the attributes

Example

Request
GET /webservices/services/rest/v2/attributes
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<CustomAttributeCollection>
  <CustomAttributes>
    <portalEditable>...</portalEditable>
    <enumerated>...</enumerated>
    <description>...</description>
    <targetManagedObjectTypes>...</targetManagedObjectTypes>
    <name>...</name>
    <value>...</value>
    <costItems>
      <name>...</name>
      <cost>...</cost>
      <costFormula>...</costFormula>
    </costItems>
    <regularExpression>...</regularExpression>
    <validationMessage>...</validationMessage>
  </CustomAttributes>
</CustomAttributeCollection>

                
              

POST /webservices/services/rest/v2/attributes

Create a custom attribute.

Request Body
media type data type description
application/xml CustomAttributeBase (XML) the att
Response Body
media type data type description
application/xml CustomAttributeBase (XML) the WS custom attribute

Example

Request
POST /webservices/services/rest/v2/attributes
Content-Type: application/xml
Accept: application/xml

                
<CustomAttributeBase>
  <portalEditable>...</portalEditable>
  <enumerated>...</enumerated>
  <description>...</description>
  <targetManagedObjectTypes>...</targetManagedObjectTypes>
  <name>...</name>
  <value>...</value>
  <costItems xsitype="...">
    <name>...</name>
    <cost>...</cost>
    <costFormula>...</costFormula>
  </costItems>
  <regularExpression>...</regularExpression>
  <validationMessage>...</validationMessage>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</CustomAttributeBase>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<CustomAttributeBase>
  <portalEditable>...</portalEditable>
  <enumerated>...</enumerated>
  <description>...</description>
  <targetManagedObjectTypes>...</targetManagedObjectTypes>
  <name>...</name>
  <value>...</value>
  <costItems xsitype="...">
    <name>...</name>
    <cost>...</cost>
    <costFormula>...</costFormula>
  </costItems>
  <regularExpression>...</regularExpression>
  <validationMessage>...</validationMessage>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</CustomAttributeBase>

                
              

DELETE /webservices/services/rest/v2/attributes/{id}

Delete a custom attribute.

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
DELETE /webservices/services/rest/v2/attributes/{id}
Content-Type: text/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/attributes/{id}

Retrieve a custom attribute by ID.

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
application/xml CustomAttributeBase (XML) the attribute by id

Example

Request
GET /webservices/services/rest/v2/attributes/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<CustomAttributeBase>
  <portalEditable>...</portalEditable>
  <enumerated>...</enumerated>
  <description>...</description>
  <targetManagedObjectTypes>...</targetManagedObjectTypes>
  <name>...</name>
  <value>...</value>
  <costItems xsitype="...">
    <name>...</name>
    <cost>...</cost>
    <costFormula>...</costFormula>
  </costItems>
  <regularExpression>...</regularExpression>
  <validationMessage>...</validationMessage>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</CustomAttributeBase>

                
              

PUT /webservices/services/rest/v2/attributes/{id}

Modify a custom attribute.

Request Parameters
name type description constraints
id path the id long
Request Body
media type data type description
application/xml CustomAttributeBase (XML) the updated attribute
Response Body
media type data type description
application/xml CustomAttributeBase (XML) the WS custom attribute

Example

Request
PUT /webservices/services/rest/v2/attributes/{id}
Content-Type: application/xml
Accept: application/xml

                
<CustomAttributeBase>
  <portalEditable>...</portalEditable>
  <enumerated>...</enumerated>
  <description>...</description>
  <targetManagedObjectTypes>...</targetManagedObjectTypes>
  <name>...</name>
  <value>...</value>
  <costItems xsitype="...">
    <name>...</name>
    <cost>...</cost>
    <costFormula>...</costFormula>
  </costItems>
  <regularExpression>...</regularExpression>
  <validationMessage>...</validationMessage>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</CustomAttributeBase>

                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
<CustomAttributeBase>
  <portalEditable>...</portalEditable>
  <enumerated>...</enumerated>
  <description>...</description>
  <targetManagedObjectTypes>...</targetManagedObjectTypes>
  <name>...</name>
  <value>...</value>
  <costItems xsitype="...">
    <name>...</name>
    <cost>...</cost>
    <costFormula>...</costFormula>
  </costItems>
  <regularExpression>...</regularExpression>
  <validationMessage>...</validationMessage>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</CustomAttributeBase>

                
              

GET /webservices/services/rest/v2/attributes/name/{name}

Retrieve a custom attribute by name.

Request Parameters
name type description
name path the url encoded name
Response Body
media type data type description
application/xml CustomAttributeBase (XML) the attribute by name

Example

Request
GET /webservices/services/rest/v2/attributes/name/{name}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<CustomAttributeBase>
  <portalEditable>...</portalEditable>
  <enumerated>...</enumerated>
  <description>...</description>
  <targetManagedObjectTypes>...</targetManagedObjectTypes>
  <name>...</name>
  <value>...</value>
  <costItems xsitype="...">
    <name>...</name>
    <cost>...</cost>
    <costFormula>...</costFormula>
  </costItems>
  <regularExpression>...</regularExpression>
  <validationMessage>...</validationMessage>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</CustomAttributeBase>

                
              

POST /webservices/services/rest/v2/attributes/syncremotesystem/{id}

Synchronize the Custom Attribute in Managed System. E.g. AWS Tags.

Request Parameters
name type description constraints
id path management server id long
Response Body
media type data type description
application/xml TaskInfo (XML) the WS task info

Example

Request
POST /webservices/services/rest/v2/attributes/syncremotesystem/{id}
Content-Type: text/plain
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

GET /webservices/services/rest/v2/billingrecords

Retrieve a collection of billing records

Request Parameters
name type description default constraints
attribute_name query this parameter goes with 'attribute_value' to specify the name of the custom attribute  
attribute_value query billing records with custom attribute matching this value  
enddate query the last date. Format is yyyyMMdd  
max query max number of billing records to retrieve (default is 100) 100 int
org_name query billing records tied to this organization  
owner_login_id query billing records tied to this owner  
startdate query the starting date. Format is yyyyMMdd  
Response Body
media type data type description
application/xml BillingRecordCollection (XML) collection of billing records

Example

Request
GET /webservices/services/rest/v2/billingrecords
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<BillingRecordCollection>
  <BillingRecords>
    <CPUCount>...</CPUCount>
    <cpuReservation>...</cpuReservation>
    <memoryInMB>...</memoryInMB>
    <memReservationInMB>...</memReservationInMB>
    <guestOS>...</guestOS>
    <cpuCost>...</cpuCost>
    <memoryCost>...</memoryCost>
    <osCost>...</osCost>
    <osSupportCost>...</osSupportCost>
    <timestamp>...</timestamp>
    <vmObjectHandleId>...</vmObjectHandleId>
    <vmName>...</vmName>
    <StorageBillingRecords>
      <storageTier>...</storageTier>
      <actualStorageSizeInBytes>...</actualStorageSizeInBytes>
      <provisionedStorageSizeInBytes>...</provisionedStorageSizeInBytes>
      <costPerDay>...</costPerDay>
    </StorageBillingRecords>
    <AttributeBillingRecords>
      <attributeId>...</attributeId>
      <attributeName>...</attributeName>
      <costPerDay>...</costPerDay>
      <calcUptime>...</calcUptime>
    </AttributeBillingRecords>
    <CostAllocationBillingRecords>
      <billingName>...</billingName>
      <organizationId>...</organizationId>
      <organizationName>...</organizationName>
      <percent>...</percent>
    </CostAllocationBillingRecords>
    <uptime>...</uptime>
    <calcUptimeCpu>...</calcUptimeCpu>
    <calcUptimeMemory>...</calcUptimeMemory>
    <calcUptimeInstance>...</calcUptimeInstance>
    <calcUptimeStorage>...</calcUptimeStorage>
    <calcUptimeOS>...</calcUptimeOS>
    <calcUptimeSupport>...</calcUptimeSupport>
  </BillingRecords>
</BillingRecordCollection>

                
              

POST /webservices/services/rest/v2/cloudtemplate/parameters

Retrieves all the cloud template parameters from the specified cloud template. This can be used to make a call to create a published service component for an ARM template or AWS CloudFormation template.

Request Body
media type data type description
application/xml CloudTemplateDescriptor (XML) Descriptor that points to template URL or contain body
Response Body
media type data type description
application/xml CloudTemplateParameterCollection (XML) Collection of parameters

Example

Request
POST /webservices/services/rest/v2/cloudtemplate/parameters
Content-Type: application/xml
Accept: application/xml

                
<CloudTemplateDescriptor xsitype="...">
  <cloudTemplateUrl>...</cloudTemplateUrl>
  <cloudTemplateBody>...</cloudTemplateBody>
  <cloudTemplateType>...</cloudTemplateType>
</CloudTemplateDescriptor>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<CloudTemplateParametersCollection>
  <CloudTemplateParameters>
    <name>...</name>
    <description>...</description>
    <defaultValue>...</defaultValue>
    <noEcho>...</noEcho>
    <value>...</value>
    <id>...</id>
    <type>...</type>
    <allowedValues>...</allowedValues>
  </CloudTemplateParameters>
</CloudTemplateParametersCollection>

                
              

POST /webservices/services/rest/v2/cloudtemplate/templates/servicecomponent

Creates the template for a new Cloud Template Service Component. (i.e. a component of a blueprint backed by ARM template or cloudformation template)

Request Body
media type data type description
application/xml CloudTemplateDescriptor (XML) Descriptor that points to template URL or contains the body, and also describes what type of managed system this is for (AWS or Azure).
Response Body
media type data type description
application/xml PublishedServiceComponent (XML) A populated published service component - will contain parameters extracted from the template, as well as name, description, and other high runner items

Example

Request
POST /webservices/services/rest/v2/cloudtemplate/templates/servicecomponent
Content-Type: application/xml
Accept: application/xml

                
<CloudTemplateDescriptor xsitype="...">
  <cloudTemplateUrl>...</cloudTemplateUrl>
  <cloudTemplateBody>...</cloudTemplateBody>
  <cloudTemplateType>...</cloudTemplateType>
</CloudTemplateDescriptor>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<PublishedServiceComponent xsitype="...">
  <id>...</id>
  <cost>...</cost>
  <namingFormat>...</namingFormat>
  <useDefaultNamingFormat>...</useDefaultNamingFormat>
  <service xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </service>
  <linkedClone>...</linkedClone>
  <template>...</template>
  <group>...</group>
  <name>...</name>
  <description>...</description>
  <componentType xsitype="...">
    <id>...</id>
    <name>...</name>
    <description>...</description>
    <cost>...</cost>
  </componentType>
  <ref xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ref>
  <serviceProperties>...</serviceProperties>
  <customizationSpecName>...</customizationSpecName>
  <instanceTypes>...</instanceTypes>
  <snapshot xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </snapshot>
  <availabilitySet>...</availabilitySet>
  <iamRole>...</iamRole>
  <pushMemoryMetrics>...</pushMemoryMetrics>
  <portMappings xsitype="...">
    <name>...</name>
    <publicProtocol>...</publicProtocol>
    <privateProtocol>...</privateProtocol>
    <publicPort>...</publicPort>
    <privatePort>...</privatePort>
  </portMappings>
  <componentNics xsitype="...">
    <id>...</id>
    <accessMode>...</accessMode>
    <addressMode>...</addressMode>
    <staticIp>...</staticIp>
    <mac>...</mac>
    <hostName>...</hostName>
    <portForwardPairs>
      <publicPort>...</publicPort>
      <privatePort>...</privatePort>
    </portForwardPairs>
  </componentNics>
  <serviceComponentSettings xsitype="...">
    <id>...</id>
    <requestAttributes>
      <attributeName>...</attributeName>
      <value>...</value>
    </requestAttributes>
    <groups>
      <groupType>...</groupType>
      <permanent>...</permanent>
    </groups>
    <formElements>
      <label>...</label>
      <mandatory>...</mandatory>
      <formType>...</formType>
      <value>...</value>
    </formElements>
    <resources>
      <resourceType>...</resourceType>
      <managementServerType>...</managementServerType>
    </resources>
  </serviceComponentSettings>
  <completionWorkflow xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </completionWorkflow>
  <cloudTemplateUrl>...</cloudTemplateUrl>
  <cloudTemplateBody>...</cloudTemplateBody>
  <cloudTemplateParameters>
    <name>...</name>
    <description>...</description>
    <defaultValue>...</defaultValue>
    <noEcho>...</noEcho>
    <value>...</value>
    <id>...</id>
    <type>...</type>
    <allowedValues>...</allowedValues>
  </cloudTemplateParameters>
  <targetType>...</targetType>
  <capabilities>...</capabilities>
  <capabilitiesReason>...</capabilitiesReason>
</PublishedServiceComponent>

                
              

GET /webservices/services/rest/v2/configurations/costmodels

Retrieve all cost models

Response Body
media type data type description
application/xml CostModelCollection (XML) the cost models

Example

Request
GET /webservices/services/rest/v2/configurations/costmodels
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<CostModelCollection>
  <costModels xsitype="...">
    <id>...</id>
    <name>...</name>
    <currency>...</currency>
    <view>...</view>
    <pricingPlan>...</pricingPlan>
    <reservedMemoryCost>...</reservedMemoryCost>
    <allocatedMemoryCost>...</allocatedMemoryCost>
    <reservedCpuCost>...</reservedCpuCost>
    <allocatedCpuCost>...</allocatedCpuCost>
    <storageTierCosts>
      <name>...</name>
      <cost>...</cost>
    </storageTierCosts>
    <storageCostCalculation>...</storageCostCalculation>
    <operatingSystemCosts>
      <os>...</os>
      <cost>...</cost>
    </operatingSystemCosts>
    <supportCosts>
      <os>...</os>
      <cost>...</cost>
    </supportCosts>
    <serviceMarkupDiscount>
      <serviceName>...</serviceName>
      <markupDiscount>...</markupDiscount>
    </serviceMarkupDiscount>
    <uptimeCalcs>
      <name>...</name>
      <calcUptime>...</calcUptime>
    </uptimeCalcs>
    <defaultStorageTier>...</defaultStorageTier>
    <targets>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </targets>
    <costAttributes>
      <allowedValues>...</allowedValues>
    </costAttributes>
  </costModels>
</CostModelCollection>

                
              

POST /webservices/services/rest/v2/configurations/costmodels

Create a cost model

Request Body
media type data type description
application/xml CostModel (XML) Cost Model
Response Body
media type data type description
application/xml TaskInfo (XML) the WS task info

Example

Request
POST /webservices/services/rest/v2/configurations/costmodels
Content-Type: application/xml
Accept: application/xml

                
<CostModel xsitype="...">
  <id>...</id>
  <name>...</name>
  <currency>...</currency>
  <view>...</view>
  <pricingPlan>...</pricingPlan>
  <reservedMemoryCost>...</reservedMemoryCost>
  <allocatedMemoryCost>...</allocatedMemoryCost>
  <reservedCpuCost>...</reservedCpuCost>
  <allocatedCpuCost>...</allocatedCpuCost>
  <storageTierCosts xsitype="...">
    <name>...</name>
    <cost>...</cost>
  </storageTierCosts>
  <storageCostCalculation>...</storageCostCalculation>
  <operatingSystemCosts xsitype="...">
    <os>...</os>
    <cost>...</cost>
  </operatingSystemCosts>
  <supportCosts xsitype="...">
    <os>...</os>
    <cost>...</cost>
  </supportCosts>
  <serviceMarkupDiscount>
    <serviceName>...</serviceName>
    <markupDiscount>...</markupDiscount>
  </serviceMarkupDiscount>
  <uptimeCalcs xsitype="...">
    <name>...</name>
    <calcUptime>...</calcUptime>
  </uptimeCalcs>
  <defaultStorageTier>...</defaultStorageTier>
  <targets xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </targets>
  <costAttributes>
    <allowedValues>...</allowedValues>
    <portalEditable>...</portalEditable>
    <enumerated>...</enumerated>
    <description>...</description>
    <targetManagedObjectTypes>...</targetManagedObjectTypes>
    <name>...</name>
    <value>...</value>
    <costItems/>
    <regularExpression>...</regularExpression>
    <validationMessage>...</validationMessage>
  </costAttributes>
</CostModel>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

PUT /webservices/services/rest/v2/configurations/costmodels

Update the cost model wsCostModel

Specified markup/discount elements are applied as if this were a PATCH. Any services not specified are left unchanged. For specified services, expired configuration is left unchanged, but any current or future service markup/discount is deleted, to be replaced by specified markup/discount. The new configuration starts on this day and never expires.

Request Body
media type data type description
application/xml CostModel (XML) to update
Response Body
media type data type description
application/xml TaskInfo (XML) the WS task info

Example

Request
PUT /webservices/services/rest/v2/configurations/costmodels
Content-Type: application/xml
Accept: application/xml

                
<CostModel xsitype="...">
  <id>...</id>
  <name>...</name>
  <currency>...</currency>
  <view>...</view>
  <pricingPlan>...</pricingPlan>
  <reservedMemoryCost>...</reservedMemoryCost>
  <allocatedMemoryCost>...</allocatedMemoryCost>
  <reservedCpuCost>...</reservedCpuCost>
  <allocatedCpuCost>...</allocatedCpuCost>
  <storageTierCosts xsitype="...">
    <name>...</name>
    <cost>...</cost>
  </storageTierCosts>
  <storageCostCalculation>...</storageCostCalculation>
  <operatingSystemCosts xsitype="...">
    <os>...</os>
    <cost>...</cost>
  </operatingSystemCosts>
  <supportCosts xsitype="...">
    <os>...</os>
    <cost>...</cost>
  </supportCosts>
  <serviceMarkupDiscount>
    <serviceName>...</serviceName>
    <markupDiscount>...</markupDiscount>
  </serviceMarkupDiscount>
  <uptimeCalcs xsitype="...">
    <name>...</name>
    <calcUptime>...</calcUptime>
  </uptimeCalcs>
  <defaultStorageTier>...</defaultStorageTier>
  <targets xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </targets>
  <costAttributes>
    <allowedValues>...</allowedValues>
    <portalEditable>...</portalEditable>
    <enumerated>...</enumerated>
    <description>...</description>
    <targetManagedObjectTypes>...</targetManagedObjectTypes>
    <name>...</name>
    <value>...</value>
    <costItems/>
    <regularExpression>...</regularExpression>
    <validationMessage>...</validationMessage>
  </costAttributes>
</CostModel>

                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

DELETE /webservices/services/rest/v2/configurations/costmodels/{id}

Delete a Cost Model.

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
text/xml TaskInfo (XML) the WS task info

Example

Request
DELETE /webservices/services/rest/v2/configurations/costmodels/{id}
Content-Type: text/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: text/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

GET /webservices/services/rest/v2/configurations/costmodels/{id}

Retrieve a cost model by id

Request Parameters
name type description constraints
id path Cost Model identifier long
Response Body
media type data type description
application/xml CostModel (XML) the cost model by id

Example

Request
GET /webservices/services/rest/v2/configurations/costmodels/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<CostModel xsitype="...">
  <id>...</id>
  <name>...</name>
  <currency>...</currency>
  <view>...</view>
  <pricingPlan>...</pricingPlan>
  <reservedMemoryCost>...</reservedMemoryCost>
  <allocatedMemoryCost>...</allocatedMemoryCost>
  <reservedCpuCost>...</reservedCpuCost>
  <allocatedCpuCost>...</allocatedCpuCost>
  <storageTierCosts xsitype="...">
    <name>...</name>
    <cost>...</cost>
  </storageTierCosts>
  <storageCostCalculation>...</storageCostCalculation>
  <operatingSystemCosts xsitype="...">
    <os>...</os>
    <cost>...</cost>
  </operatingSystemCosts>
  <supportCosts xsitype="...">
    <os>...</os>
    <cost>...</cost>
  </supportCosts>
  <serviceMarkupDiscount>
    <serviceName>...</serviceName>
    <markupDiscount>...</markupDiscount>
  </serviceMarkupDiscount>
  <uptimeCalcs xsitype="...">
    <name>...</name>
    <calcUptime>...</calcUptime>
  </uptimeCalcs>
  <defaultStorageTier>...</defaultStorageTier>
  <targets xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </targets>
  <costAttributes>
    <allowedValues>...</allowedValues>
    <portalEditable>...</portalEditable>
    <enumerated>...</enumerated>
    <description>...</description>
    <targetManagedObjectTypes>...</targetManagedObjectTypes>
    <name>...</name>
    <value>...</value>
    <costItems/>
    <regularExpression>...</regularExpression>
    <validationMessage>...</validationMessage>
  </costAttributes>
</CostModel>

                
              

POST /webservices/services/rest/v2/configurations/costmodels/action/reload

Reload all cost files for all cost models.

Response Body
media type data type description
application/xml TaskInfo (XML) the WS task info

Example

Request
POST /webservices/services/rest/v2/configurations/costmodels/action/reload
Content-Type: */*
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

GET /webservices/services/rest/v2/configurations/costmodels/name/{name}

Retrieve a cost model by name

Request Parameters
name type description
name path the url encoded name
Response Body
media type data type description
application/xml CostModel (XML) the cost model by name

Example

Request
GET /webservices/services/rest/v2/configurations/costmodels/name/{name}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<CostModel xsitype="...">
  <id>...</id>
  <name>...</name>
  <currency>...</currency>
  <view>...</view>
  <pricingPlan>...</pricingPlan>
  <reservedMemoryCost>...</reservedMemoryCost>
  <allocatedMemoryCost>...</allocatedMemoryCost>
  <reservedCpuCost>...</reservedCpuCost>
  <allocatedCpuCost>...</allocatedCpuCost>
  <storageTierCosts xsitype="...">
    <name>...</name>
    <cost>...</cost>
  </storageTierCosts>
  <storageCostCalculation>...</storageCostCalculation>
  <operatingSystemCosts xsitype="...">
    <os>...</os>
    <cost>...</cost>
  </operatingSystemCosts>
  <supportCosts xsitype="...">
    <os>...</os>
    <cost>...</cost>
  </supportCosts>
  <serviceMarkupDiscount>
    <serviceName>...</serviceName>
    <markupDiscount>...</markupDiscount>
  </serviceMarkupDiscount>
  <uptimeCalcs xsitype="...">
    <name>...</name>
    <calcUptime>...</calcUptime>
  </uptimeCalcs>
  <defaultStorageTier>...</defaultStorageTier>
  <targets xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </targets>
  <costAttributes>
    <allowedValues>...</allowedValues>
    <portalEditable>...</portalEditable>
    <enumerated>...</enumerated>
    <description>...</description>
    <targetManagedObjectTypes>...</targetManagedObjectTypes>
    <name>...</name>
    <value>...</value>
    <costItems/>
    <regularExpression>...</regularExpression>
    <validationMessage>...</validationMessage>
  </costAttributes>
</CostModel>

                
              

GET /webservices/services/rest/v2/configurations/ippools

Retrieve all ip pools

Response Body
media type data type description
application/xml IpPoolCollection (XML) the ip pools

Example

Request
GET /webservices/services/rest/v2/configurations/ippools
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<IpPoolCollection>
  <IpPools>
    <name>...</name>
    <networkConfig>
      <subnetMask>...</subnetMask>
      <defaultGateway>...</defaultGateway>
      <primaryDns>...</primaryDns>
      <secondaryDns>...</secondaryDns>
      <dnsSuffix>...</dnsSuffix>
    </networkConfig>
    <datacenter>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </datacenter>
    <networks>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </networks>
    <range>
      <from>...</from>
      <to>...</to>
    </range>
    <totalIps>...</totalIps>
    <freeIps>...</freeIps>
    <assignedIps>...</assignedIps>
    <reservedIps>...</reservedIps>
    <preemptedIps>...</preemptedIps>
    <conflictedIps>...</conflictedIps>
    <freeIpWarningThreshold>...</freeIpWarningThreshold>
  </IpPools>
</IpPoolCollection>

                
              

POST /webservices/services/rest/v2/configurations/ippools

Create an Ip pool.

Request Body
media type data type description
application/xml IpPool (XML) the ip pool
Response Body
media type data type description
application/xml TaskInfo (XML) the WS task info

Example

Request
POST /webservices/services/rest/v2/configurations/ippools
Content-Type: application/xml
Accept: application/xml

                
<IpPool>
  <name>...</name>
  <networkConfig>
    <subnetMask>...</subnetMask>
    <defaultGateway>...</defaultGateway>
    <primaryDns>...</primaryDns>
    <secondaryDns>...</secondaryDns>
    <dnsSuffix>...</dnsSuffix>
  </networkConfig>
  <datacenter xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </datacenter>
  <networks xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </networks>
  <range xsitype="...">
    <from>...</from>
    <to>...</to>
  </range>
  <totalIps>...</totalIps>
  <freeIps>...</freeIps>
  <assignedIps>...</assignedIps>
  <reservedIps>...</reservedIps>
  <preemptedIps>...</preemptedIps>
  <conflictedIps>...</conflictedIps>
  <freeIpWarningThreshold>...</freeIpWarningThreshold>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</IpPool>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

DELETE /webservices/services/rest/v2/configurations/ippools/{id}

Delete an Ip pool.

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
text/xml TaskInfo (XML) the WS task info

Example

Request
DELETE /webservices/services/rest/v2/configurations/ippools/{id}
Content-Type: text/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: text/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

GET /webservices/services/rest/v2/configurations/ippools/{id}

Retrieve an Ip pool by ID.

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
application/xml IpPool (XML) the ip pool by id

Example

Request
GET /webservices/services/rest/v2/configurations/ippools/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<IpPool>
  <name>...</name>
  <networkConfig>
    <subnetMask>...</subnetMask>
    <defaultGateway>...</defaultGateway>
    <primaryDns>...</primaryDns>
    <secondaryDns>...</secondaryDns>
    <dnsSuffix>...</dnsSuffix>
  </networkConfig>
  <datacenter xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </datacenter>
  <networks xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </networks>
  <range xsitype="...">
    <from>...</from>
    <to>...</to>
  </range>
  <totalIps>...</totalIps>
  <freeIps>...</freeIps>
  <assignedIps>...</assignedIps>
  <reservedIps>...</reservedIps>
  <preemptedIps>...</preemptedIps>
  <conflictedIps>...</conflictedIps>
  <freeIpWarningThreshold>...</freeIpWarningThreshold>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</IpPool>

                
              

PUT /webservices/services/rest/v2/configurations/ippools/{id}

Modify an Ip pool.

Request Parameters
name type description constraints
id path the id long
Request Body
media type data type description
application/xml IpPool (XML) the ip pool
Response Body
media type data type description
application/xml TaskInfo (XML) the WS task info

Example

Request
PUT /webservices/services/rest/v2/configurations/ippools/{id}
Content-Type: application/xml
Accept: application/xml

                
<IpPool>
  <name>...</name>
  <networkConfig>
    <subnetMask>...</subnetMask>
    <defaultGateway>...</defaultGateway>
    <primaryDns>...</primaryDns>
    <secondaryDns>...</secondaryDns>
    <dnsSuffix>...</dnsSuffix>
  </networkConfig>
  <datacenter xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </datacenter>
  <networks xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </networks>
  <range xsitype="...">
    <from>...</from>
    <to>...</to>
  </range>
  <totalIps>...</totalIps>
  <freeIps>...</freeIps>
  <assignedIps>...</assignedIps>
  <reservedIps>...</reservedIps>
  <preemptedIps>...</preemptedIps>
  <conflictedIps>...</conflictedIps>
  <freeIpWarningThreshold>...</freeIpWarningThreshold>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</IpPool>

                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

GET /webservices/services/rest/v2/configurations/ippools/name/{pool_name}

Retrieve an Ip pool by name.

Request Parameters
name type description
pool_name path the url encoded name
Response Body
media type data type description
application/xml IpPool (XML) the ip pool by name

Example

Request
GET /webservices/services/rest/v2/configurations/ippools/name/{pool_name}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<IpPool>
  <name>...</name>
  <networkConfig>
    <subnetMask>...</subnetMask>
    <defaultGateway>...</defaultGateway>
    <primaryDns>...</primaryDns>
    <secondaryDns>...</secondaryDns>
    <dnsSuffix>...</dnsSuffix>
  </networkConfig>
  <datacenter xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </datacenter>
  <networks xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </networks>
  <range xsitype="...">
    <from>...</from>
    <to>...</to>
  </range>
  <totalIps>...</totalIps>
  <freeIps>...</freeIps>
  <assignedIps>...</assignedIps>
  <reservedIps>...</reservedIps>
  <preemptedIps>...</preemptedIps>
  <conflictedIps>...</conflictedIps>
  <freeIpWarningThreshold>...</freeIpWarningThreshold>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</IpPool>

                
              

GET /webservices/services/rest/v2/configurations/networkzones

Gets the network zones.

Response Body
media type data type description
application/xml NetworkZoneCollection (XML) a collection of network zone

Example

Request
GET /webservices/services/rest/v2/configurations/networkzones
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<NetworkZoneCollection>
  <networkzones xsitype="...">
    <id>...</id>
    <name>...</name>
  </networkzones>
</NetworkZoneCollection>

                
              

POST /webservices/services/rest/v2/configurations/networkzones

Creates a new network zone.

Request Body
media type data type description
application/xml NetworkZone (XML) the network zone
Response Body
media type data type description
application/xml anyType (XML) http response code

Example

Request
POST /webservices/services/rest/v2/configurations/networkzones
Content-Type: application/xml
Accept: application/xml

                
<NetworkZone xsitype="...">
  <id>...</id>
  <name>...</name>
</NetworkZone>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
...
                
              

DELETE /webservices/services/rest/v2/configurations/networkzones/{id}

Delete network zone.

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
application/xml anyType (XML) the http response

Example

Request
DELETE /webservices/services/rest/v2/configurations/networkzones/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
...
                
              

GET /webservices/services/rest/v2/configurations/networkzones/{id}

Gets the network zone by id.

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
application/xml NetworkZone (XML) network zone

Example

Request
GET /webservices/services/rest/v2/configurations/networkzones/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<NetworkZone xsitype="...">
  <id>...</id>
  <name>...</name>
</NetworkZone>

                
              

PUT /webservices/services/rest/v2/configurations/networkzones/{id}

Update the network zone

Request Parameters
name type description constraints
id path the id long
Request Body
media type data type description
application/xml NetworkZone (XML) the updated network zone
Response Body
media type data type description
application/xml NetworkZone (XML) returns the updated network zone

Example

Request
PUT /webservices/services/rest/v2/configurations/networkzones/{id}
Content-Type: application/xml
Accept: application/xml

                
<NetworkZone xsitype="...">
  <id>...</id>
  <name>...</name>
</NetworkZone>

                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
<NetworkZone xsitype="...">
  <id>...</id>
  <name>...</name>
</NetworkZone>

                
              

GET /webservices/services/rest/v2/configurations/networkzones/name/{name}

Gets the network zone by name.

Request Parameters
name type description
name path the url encoded network zone name
Response Body
media type data type description
application/xml NetworkZone (XML) returns the network zone. An exception is thrown otherwise

Example

Request
GET /webservices/services/rest/v2/configurations/networkzones/name/{name}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<NetworkZone xsitype="...">
  <id>...</id>
  <name>...</name>
</NetworkZone>

                
              

GET /webservices/services/rest/v2/configurations/organizations

Retrieve organizations, optionally specifying a max/offset.

Request Parameters
name type description default constraints
max query Maximum number of organizations to return. Defaults to 100. Use -1 to have no maximum. 100 int
offset query The index of the first item to return from the result set. Use in combination with maxCount to retrieve in batches. Defaults to 0. 0 int
Response Body
media type data type description
application/xml OrganizationCollection (XML) the organizations

Example

Request
GET /webservices/services/rest/v2/configurations/organizations
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<OrganizationCollection>
  <Organizations>
    <costQuota>
      <dailyCost>...</dailyCost>
    </costQuota>
    <resourceQuota>
      <stoppedVmsCalculateOnlyStorage>...</stoppedVmsCalculateOnlyStorage>
      <stoppedVmsAllowPowerOn>...</stoppedVmsAllowPowerOn>
      <useDiskTotalSize>...</useDiskTotalSize>
      <perStorageTierQuotas>...</perStorageTierQuotas>
      <storageInGB>...</storageInGB>
      <memoryInGB>...</memoryInGB>
      <CPUCount>...</CPUCount>
      <storageTierQuotas/>
    </resourceQuota>
    <Members>
      <costQuota/>
      <resourceQuota/>
      <userId>...</userId>
      <manager>...</manager>
      <portalRole>...</portalRole>
      <organization/>
    </Members>
    <name>...</name>
  </Organizations>
</OrganizationCollection>

                
              

POST /webservices/services/rest/v2/configurations/organizations

This method has been deprecated.

Create an organization.

Request Body
media type data type description
application/xml Organization (XML) the org
Response Body
media type data type description
application/xml Organization (XML) the WS organization

Example

Request
POST /webservices/services/rest/v2/configurations/organizations
Content-Type: application/xml
Accept: application/xml

                
<Organization>
  <costQuota xsitype="...">
    <dailyCost>...</dailyCost>
  </costQuota>
  <resourceQuota xsitype="...">
    <stoppedVmsCalculateOnlyStorage>...</stoppedVmsCalculateOnlyStorage>
    <stoppedVmsAllowPowerOn>...</stoppedVmsAllowPowerOn>
    <useDiskTotalSize>...</useDiskTotalSize>
    <perStorageTierQuotas>...</perStorageTierQuotas>
    <storageInGB>...</storageInGB>
    <memoryInGB>...</memoryInGB>
    <CPUCount>...</CPUCount>
    <storageTierQuotas>
      <name>...</name>
      <quota>...</quota>
      <excluded>...</excluded>
    </storageTierQuotas>
  </resourceQuota>
  <Members xsitype="...">
    <costQuota>
      <dailyCost>...</dailyCost>
    </costQuota>
    <resourceQuota>
      <stoppedVmsCalculateOnlyStorage>...</stoppedVmsCalculateOnlyStorage>
      <stoppedVmsAllowPowerOn>...</stoppedVmsAllowPowerOn>
      <useDiskTotalSize>...</useDiskTotalSize>
      <perStorageTierQuotas>...</perStorageTierQuotas>
      <storageInGB>...</storageInGB>
      <memoryInGB>...</memoryInGB>
      <CPUCount>...</CPUCount>
      <storageTierQuotas/>
    </resourceQuota>
    <userId>...</userId>
    <manager>...</manager>
    <portalRole>...</portalRole>
    <organization>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organization>
  </Members>
  <name>...</name>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Organization>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<Organization>
  <costQuota xsitype="...">
    <dailyCost>...</dailyCost>
  </costQuota>
  <resourceQuota xsitype="...">
    <stoppedVmsCalculateOnlyStorage>...</stoppedVmsCalculateOnlyStorage>
    <stoppedVmsAllowPowerOn>...</stoppedVmsAllowPowerOn>
    <useDiskTotalSize>...</useDiskTotalSize>
    <perStorageTierQuotas>...</perStorageTierQuotas>
    <storageInGB>...</storageInGB>
    <memoryInGB>...</memoryInGB>
    <CPUCount>...</CPUCount>
    <storageTierQuotas>
      <name>...</name>
      <quota>...</quota>
      <excluded>...</excluded>
    </storageTierQuotas>
  </resourceQuota>
  <Members xsitype="...">
    <costQuota>
      <dailyCost>...</dailyCost>
    </costQuota>
    <resourceQuota>
      <stoppedVmsCalculateOnlyStorage>...</stoppedVmsCalculateOnlyStorage>
      <stoppedVmsAllowPowerOn>...</stoppedVmsAllowPowerOn>
      <useDiskTotalSize>...</useDiskTotalSize>
      <perStorageTierQuotas>...</perStorageTierQuotas>
      <storageInGB>...</storageInGB>
      <memoryInGB>...</memoryInGB>
      <CPUCount>...</CPUCount>
      <storageTierQuotas/>
    </resourceQuota>
    <userId>...</userId>
    <manager>...</manager>
    <portalRole>...</portalRole>
    <organization>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organization>
  </Members>
  <name>...</name>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Organization>

                
              

GET /webservices/services/rest/v2/configurations/organizations/{id}

Retrieve an organization by id. If no matching organization is found an exception will be thrown.

Request Parameters
name type description constraints
id path The ID of the organization to retrieve long
Response Body
media type data type description
application/xml Organization (XML) The organization

Example

Request
GET /webservices/services/rest/v2/configurations/organizations/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<Organization>
  <costQuota xsitype="...">
    <dailyCost>...</dailyCost>
  </costQuota>
  <resourceQuota xsitype="...">
    <stoppedVmsCalculateOnlyStorage>...</stoppedVmsCalculateOnlyStorage>
    <stoppedVmsAllowPowerOn>...</stoppedVmsAllowPowerOn>
    <useDiskTotalSize>...</useDiskTotalSize>
    <perStorageTierQuotas>...</perStorageTierQuotas>
    <storageInGB>...</storageInGB>
    <memoryInGB>...</memoryInGB>
    <CPUCount>...</CPUCount>
    <storageTierQuotas>
      <name>...</name>
      <quota>...</quota>
      <excluded>...</excluded>
    </storageTierQuotas>
  </resourceQuota>
  <Members xsitype="...">
    <costQuota>
      <dailyCost>...</dailyCost>
    </costQuota>
    <resourceQuota>
      <stoppedVmsCalculateOnlyStorage>...</stoppedVmsCalculateOnlyStorage>
      <stoppedVmsAllowPowerOn>...</stoppedVmsAllowPowerOn>
      <useDiskTotalSize>...</useDiskTotalSize>
      <perStorageTierQuotas>...</perStorageTierQuotas>
      <storageInGB>...</storageInGB>
      <memoryInGB>...</memoryInGB>
      <CPUCount>...</CPUCount>
      <storageTierQuotas/>
    </resourceQuota>
    <userId>...</userId>
    <manager>...</manager>
    <portalRole>...</portalRole>
    <organization>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organization>
  </Members>
  <name>...</name>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Organization>

                
              

PUT /webservices/services/rest/v2/configurations/organizations/{id}

This method has been deprecated.

Edit an organization.

Request Parameters
name type description constraints
id path the org id long
Request Body
media type data type description
application/xml Organization (XML) the org
Response Body
media type data type description
application/xml Organization (XML) the WS organization

Example

Request
PUT /webservices/services/rest/v2/configurations/organizations/{id}
Content-Type: application/xml
Accept: application/xml

                
<Organization>
  <costQuota xsitype="...">
    <dailyCost>...</dailyCost>
  </costQuota>
  <resourceQuota xsitype="...">
    <stoppedVmsCalculateOnlyStorage>...</stoppedVmsCalculateOnlyStorage>
    <stoppedVmsAllowPowerOn>...</stoppedVmsAllowPowerOn>
    <useDiskTotalSize>...</useDiskTotalSize>
    <perStorageTierQuotas>...</perStorageTierQuotas>
    <storageInGB>...</storageInGB>
    <memoryInGB>...</memoryInGB>
    <CPUCount>...</CPUCount>
    <storageTierQuotas>
      <name>...</name>
      <quota>...</quota>
      <excluded>...</excluded>
    </storageTierQuotas>
  </resourceQuota>
  <Members xsitype="...">
    <costQuota>
      <dailyCost>...</dailyCost>
    </costQuota>
    <resourceQuota>
      <stoppedVmsCalculateOnlyStorage>...</stoppedVmsCalculateOnlyStorage>
      <stoppedVmsAllowPowerOn>...</stoppedVmsAllowPowerOn>
      <useDiskTotalSize>...</useDiskTotalSize>
      <perStorageTierQuotas>...</perStorageTierQuotas>
      <storageInGB>...</storageInGB>
      <memoryInGB>...</memoryInGB>
      <CPUCount>...</CPUCount>
      <storageTierQuotas/>
    </resourceQuota>
    <userId>...</userId>
    <manager>...</manager>
    <portalRole>...</portalRole>
    <organization>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organization>
  </Members>
  <name>...</name>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Organization>

                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
<Organization>
  <costQuota xsitype="...">
    <dailyCost>...</dailyCost>
  </costQuota>
  <resourceQuota xsitype="...">
    <stoppedVmsCalculateOnlyStorage>...</stoppedVmsCalculateOnlyStorage>
    <stoppedVmsAllowPowerOn>...</stoppedVmsAllowPowerOn>
    <useDiskTotalSize>...</useDiskTotalSize>
    <perStorageTierQuotas>...</perStorageTierQuotas>
    <storageInGB>...</storageInGB>
    <memoryInGB>...</memoryInGB>
    <CPUCount>...</CPUCount>
    <storageTierQuotas>
      <name>...</name>
      <quota>...</quota>
      <excluded>...</excluded>
    </storageTierQuotas>
  </resourceQuota>
  <Members xsitype="...">
    <costQuota>
      <dailyCost>...</dailyCost>
    </costQuota>
    <resourceQuota>
      <stoppedVmsCalculateOnlyStorage>...</stoppedVmsCalculateOnlyStorage>
      <stoppedVmsAllowPowerOn>...</stoppedVmsAllowPowerOn>
      <useDiskTotalSize>...</useDiskTotalSize>
      <perStorageTierQuotas>...</perStorageTierQuotas>
      <storageInGB>...</storageInGB>
      <memoryInGB>...</memoryInGB>
      <CPUCount>...</CPUCount>
      <storageTierQuotas/>
    </resourceQuota>
    <userId>...</userId>
    <manager>...</manager>
    <portalRole>...</portalRole>
    <organization>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organization>
  </Members>
  <name>...</name>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Organization>

                
              

GET /webservices/services/rest/v2/configurations/organizations/{id}/quotastats

Request Parameters
name type description default constraints
id path organization identifier   long
member query organization member if any  
Response Body
media type data type description
application/xml QuotaStatistics (XML) the organization quota (limits and available)

Example

Request
GET /webservices/services/rest/v2/configurations/organizations/{id}/quotastats
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<QuotaStatistics>
  <costQuota xsitype="...">
    <dailyCost>...</dailyCost>
  </costQuota>
  <resourceQuota xsitype="...">
    <stoppedVmsCalculateOnlyStorage>...</stoppedVmsCalculateOnlyStorage>
    <stoppedVmsAllowPowerOn>...</stoppedVmsAllowPowerOn>
    <useDiskTotalSize>...</useDiskTotalSize>
    <perStorageTierQuotas>...</perStorageTierQuotas>
    <storageInGB>...</storageInGB>
    <memoryInGB>...</memoryInGB>
    <CPUCount>...</CPUCount>
    <storageTierQuotas>
      <name>...</name>
      <quota>...</quota>
      <excluded>...</excluded>
    </storageTierQuotas>
  </resourceQuota>
  <name>...</name>
</QuotaStatistics>

                
              

DELETE /webservices/services/rest/v2/configurations/organizations/name/{org_name}

Deletes the organization with the specified name. If it does not exist, an exception will be thrown.

Request Parameters
name type description
org_name path the url encoded org name
Response Body
media type data type description
application/xml anyType (XML) the response

Example

Request
DELETE /webservices/services/rest/v2/configurations/organizations/name/{org_name}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
...
                
              

GET /webservices/services/rest/v2/configurations/organizations/name/{org_name}

Retrieve an organization by name. If it does not exist, an exception will be thrown.

Request Parameters
name type description
org_name path the url encoded org name
Response Body
media type data type description
application/xml Organization (XML) the organization by name

Example

Request
GET /webservices/services/rest/v2/configurations/organizations/name/{org_name}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<Organization>
  <costQuota xsitype="...">
    <dailyCost>...</dailyCost>
  </costQuota>
  <resourceQuota xsitype="...">
    <stoppedVmsCalculateOnlyStorage>...</stoppedVmsCalculateOnlyStorage>
    <stoppedVmsAllowPowerOn>...</stoppedVmsAllowPowerOn>
    <useDiskTotalSize>...</useDiskTotalSize>
    <perStorageTierQuotas>...</perStorageTierQuotas>
    <storageInGB>...</storageInGB>
    <memoryInGB>...</memoryInGB>
    <CPUCount>...</CPUCount>
    <storageTierQuotas>
      <name>...</name>
      <quota>...</quota>
      <excluded>...</excluded>
    </storageTierQuotas>
  </resourceQuota>
  <Members xsitype="...">
    <costQuota>
      <dailyCost>...</dailyCost>
    </costQuota>
    <resourceQuota>
      <stoppedVmsCalculateOnlyStorage>...</stoppedVmsCalculateOnlyStorage>
      <stoppedVmsAllowPowerOn>...</stoppedVmsAllowPowerOn>
      <useDiskTotalSize>...</useDiskTotalSize>
      <perStorageTierQuotas>...</perStorageTierQuotas>
      <storageInGB>...</storageInGB>
      <memoryInGB>...</memoryInGB>
      <CPUCount>...</CPUCount>
      <storageTierQuotas/>
    </resourceQuota>
    <userId>...</userId>
    <manager>...</manager>
    <portalRole>...</portalRole>
    <organization>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organization>
  </Members>
  <name>...</name>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Organization>

                
              

GET /webservices/services/rest/v2/configurations/organizations/quota/reservations

Return all the current open quota reservations.

Response Body
media type data type description
application/xml ReservedQuotaCollection (XML) Collection of open quota reservations

Example

Request
GET /webservices/services/rest/v2/configurations/organizations/quota/reservations
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ReservedQuotaCollection>
  <items>
    <cpu>...</cpu>
    <cost>...</cost>
    <ownerLoginId>...</ownerLoginId>
    <requestId>...</requestId>
    <id>...</id>
    <memoryMB>...</memoryMB>
    <storageBytes>...</storageBytes>
    <perTierStorage>
      <tierId>...</tierId>
      <tierName>...</tierName>
      <storageBytes>...</storageBytes>
    </perTierStorage>
    <organization>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organization>
  </items>
</ReservedQuotaCollection>

                
              

DELETE /webservices/services/rest/v2/configurations/organizations/quota/reservations/{reservation_id}

Clear a specific quota reservation. This can be used if you know this is erroneous.

Request Parameters
name type description constraints
reservation_id path ID of the reservation long
Response Body
media type data type description
text/xml anyType (XML) Simple response

Example

Request
DELETE /webservices/services/rest/v2/configurations/organizations/quota/reservations/{reservation_id}
Content-Type: application/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/configurations/workflows

Retrieve the list of workflow definitions.

Response Body
media type data type description
application/xml WorkflowDefinitionCollection (XML) the workflow definitions

Example

Request
GET /webservices/services/rest/v2/configurations/workflows
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<WorkflowDefinitionCollection>
  <WorkflowDefinitions>
    <name>...</name>
    <workflowType>...</workflowType>
    <StepRepresentations>
      <name>...</name>
      <originalObjectId>...</originalObjectId>
    </StepRepresentations>
    <Steps>
      <guestOSCredential/>
      <domainCredential/>
      <workflowDefinitionId>...</workflowDefinitionId>
      <id>...</id>
      <name>...</name>
      <type>...</type>
      <stepNumber>...</stepNumber>
      <condition>...</condition>
    </Steps>
    <global>...</global>
    <targetType>...</targetType>
    <changeDescription>...</changeDescription>
  </WorkflowDefinitions>
</WorkflowDefinitionCollection>

                
              

POST /webservices/services/rest/v2/configurations/workflows

Create a workflow definition.

Request Body
media type data type description
application/xml WorkflowDefinition (XML) the workflow definition dto
Response Body
media type data type description
application/xml WorkflowDefinition (XML) the WS workflow definition

Example

Request
POST /webservices/services/rest/v2/configurations/workflows
Content-Type: application/xml
Accept: application/xml

                
<WorkflowDefinition>
  <name>...</name>
  <workflowType>...</workflowType>
  <StepRepresentations xsitype="...">
    <name>...</name>
    <originalObjectId>...</originalObjectId>
  </StepRepresentations>
  <Steps xsitype="...">
    <guestOSCredential>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </guestOSCredential>
    <domainCredential>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </domainCredential>
    <workflowDefinitionId>...</workflowDefinitionId>
    <id>...</id>
    <name>...</name>
    <type>...</type>
    <stepNumber>...</stepNumber>
    <condition>...</condition>
  </Steps>
  <global>...</global>
  <targetType>...</targetType>
  <changeDescription>...</changeDescription>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</WorkflowDefinition>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<WorkflowDefinition>
  <name>...</name>
  <workflowType>...</workflowType>
  <StepRepresentations xsitype="...">
    <name>...</name>
    <originalObjectId>...</originalObjectId>
  </StepRepresentations>
  <Steps xsitype="...">
    <guestOSCredential>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </guestOSCredential>
    <domainCredential>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </domainCredential>
    <workflowDefinitionId>...</workflowDefinitionId>
    <id>...</id>
    <name>...</name>
    <type>...</type>
    <stepNumber>...</stepNumber>
    <condition>...</condition>
  </Steps>
  <global>...</global>
  <targetType>...</targetType>
  <changeDescription>...</changeDescription>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</WorkflowDefinition>

                
              

DELETE /webservices/services/rest/v2/configurations/workflows/{id}

Delete a workflow definition.

Request Parameters
name type description constraints
id path the workflow id long
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
DELETE /webservices/services/rest/v2/configurations/workflows/{id}
Content-Type: text/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/configurations/workflows/{id}

Retrieve a workflow definition by ID.

Request Parameters
name type description constraints
id path the workflow id long
Response Body
media type data type description
application/xml WorkflowDefinition (XML) the workflow definition by id

Example

Request
GET /webservices/services/rest/v2/configurations/workflows/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<WorkflowDefinition>
  <name>...</name>
  <workflowType>...</workflowType>
  <StepRepresentations xsitype="...">
    <name>...</name>
    <originalObjectId>...</originalObjectId>
  </StepRepresentations>
  <Steps xsitype="...">
    <guestOSCredential>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </guestOSCredential>
    <domainCredential>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </domainCredential>
    <workflowDefinitionId>...</workflowDefinitionId>
    <id>...</id>
    <name>...</name>
    <type>...</type>
    <stepNumber>...</stepNumber>
    <condition>...</condition>
  </Steps>
  <global>...</global>
  <targetType>...</targetType>
  <changeDescription>...</changeDescription>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</WorkflowDefinition>

                
              

PUT /webservices/services/rest/v2/configurations/workflows/{id}

Modify a workflow definition.

Request Parameters
name type description constraints
id path the workflow definition long
Request Body
media type data type description
application/xml WorkflowDefinition (XML) the updated definition
Response Body
media type data type description
application/xml WorkflowDefinition (XML) the WS workflow definition

Example

Request
PUT /webservices/services/rest/v2/configurations/workflows/{id}
Content-Type: application/xml
Accept: application/xml

                
<WorkflowDefinition>
  <name>...</name>
  <workflowType>...</workflowType>
  <StepRepresentations xsitype="...">
    <name>...</name>
    <originalObjectId>...</originalObjectId>
  </StepRepresentations>
  <Steps xsitype="...">
    <guestOSCredential>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </guestOSCredential>
    <domainCredential>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </domainCredential>
    <workflowDefinitionId>...</workflowDefinitionId>
    <id>...</id>
    <name>...</name>
    <type>...</type>
    <stepNumber>...</stepNumber>
    <condition>...</condition>
  </Steps>
  <global>...</global>
  <targetType>...</targetType>
  <changeDescription>...</changeDescription>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</WorkflowDefinition>

                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
<WorkflowDefinition>
  <name>...</name>
  <workflowType>...</workflowType>
  <StepRepresentations xsitype="...">
    <name>...</name>
    <originalObjectId>...</originalObjectId>
  </StepRepresentations>
  <Steps xsitype="...">
    <guestOSCredential>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </guestOSCredential>
    <domainCredential>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </domainCredential>
    <workflowDefinitionId>...</workflowDefinitionId>
    <id>...</id>
    <name>...</name>
    <type>...</type>
    <stepNumber>...</stepNumber>
    <condition>...</condition>
  </Steps>
  <global>...</global>
  <targetType>...</targetType>
  <changeDescription>...</changeDescription>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</WorkflowDefinition>

                
              

GET /webservices/services/rest/v2/configurations/workflows/{id}/steps

Retrieve all step definitions for the specified workflow definition.

Request Parameters
name type description constraints
id path the workflow definition id long
Response Body
media type data type description
application/xml WorkflowStepDefinitionCollection (XML) the workflow definition steps

Example

Request
GET /webservices/services/rest/v2/configurations/workflows/{id}/steps
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<WorkflowStepDefinitionCollection>
  <WorkflowStepDefinition xsitype="...">
    <guestOSCredential>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </guestOSCredential>
    <domainCredential>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </domainCredential>
    <workflowDefinitionId>...</workflowDefinitionId>
    <id>...</id>
    <name>...</name>
    <type>...</type>
    <stepNumber>...</stepNumber>
    <condition>...</condition>
  </WorkflowStepDefinition>
</WorkflowStepDefinitionCollection>

                
              

GET /webservices/services/rest/v2/configurations/workflows/{id}/steps/{step_id}

Retrieve a workflow definition step by ID.

Request Parameters
name type description constraints
id path the workflow definition id long
step_id path the step id long
Response Body
media type data type description
application/xml WorkflowStepDefinition (XML) the workflow definition step by id

Example

Request
GET /webservices/services/rest/v2/configurations/workflows/{id}/steps/{step_id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<WorkflowStepDefinition xsitype="...">
  <guestOSCredential xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </guestOSCredential>
  <domainCredential xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </domainCredential>
  <workflowDefinitionId>...</workflowDefinitionId>
  <id>...</id>
  <name>...</name>
  <type>...</type>
  <stepNumber>...</stepNumber>
  <condition>...</condition>
</WorkflowStepDefinition>

                
              

POST /webservices/services/rest/v2/configurations/workflows/action/export

Export all workflow definitions

Response Body
media type data type description
text/xml string (XML) the workflow export xml

Example

Request
POST /webservices/services/rest/v2/configurations/workflows/action/export
Content-Type: application/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

POST /webservices/services/rest/v2/configurations/workflows/action/import

Import a collection of workflow definitions.

Request Body
media type data type description
text/xml string (XML) the xml
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/configurations/workflows/action/import
Content-Type: text/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

POST /webservices/services/rest/v2/configurations/workflows/id/{workflowId}/action/link/{componentId}

Links a workflow definition to a service component

Request Parameters
name type description constraints
componentId path ID of the component to link long
workflowId path ID of the completion workflow long
Response Body
media type data type description
application/xml WorkflowDefinition (XML) The updated workflow definition

Example

Request
POST /webservices/services/rest/v2/configurations/workflows/id/{workflowId}/action/link/{componentId}
Content-Type: application/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<WorkflowDefinition>
  <name>...</name>
  <workflowType>...</workflowType>
  <StepRepresentations xsitype="...">
    <name>...</name>
    <originalObjectId>...</originalObjectId>
  </StepRepresentations>
  <Steps xsitype="...">
    <guestOSCredential>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </guestOSCredential>
    <domainCredential>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </domainCredential>
    <workflowDefinitionId>...</workflowDefinitionId>
    <id>...</id>
    <name>...</name>
    <type>...</type>
    <stepNumber>...</stepNumber>
    <condition>...</condition>
  </Steps>
  <global>...</global>
  <targetType>...</targetType>
  <changeDescription>...</changeDescription>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</WorkflowDefinition>

                
              

GET /webservices/services/rest/v2/configurations/workflows/type/{workflow_type}

Retrieve the list of workflow definitions by type.

Request Parameters
name type description
workflow_type path the workflow type
Response Body
media type data type description
application/xml WorkflowDefinitionCollection (XML) the workflow definitions by type

Example

Request
GET /webservices/services/rest/v2/configurations/workflows/type/{workflow_type}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<WorkflowDefinitionCollection>
  <WorkflowDefinitions>
    <name>...</name>
    <workflowType>...</workflowType>
    <StepRepresentations>
      <name>...</name>
      <originalObjectId>...</originalObjectId>
    </StepRepresentations>
    <Steps>
      <guestOSCredential/>
      <domainCredential/>
      <workflowDefinitionId>...</workflowDefinitionId>
      <id>...</id>
      <name>...</name>
      <type>...</type>
      <stepNumber>...</stepNumber>
      <condition>...</condition>
    </Steps>
    <global>...</global>
    <targetType>...</targetType>
    <changeDescription>...</changeDescription>
  </WorkflowDefinitions>
</WorkflowDefinitionCollection>

                
              

GET /webservices/services/rest/v2/configurations/workflows/type/{workflow_type}/{name}

Retrieve a workflow definition by name and type.

Request Parameters
name type description
name path The name of the workflow
workflow_type path The type of workflow
Response Body
media type data type description
application/xml WorkflowDefinition (XML) the workflow definition

Example

Request
GET /webservices/services/rest/v2/configurations/workflows/type/{workflow_type}/{name}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<WorkflowDefinition>
  <name>...</name>
  <workflowType>...</workflowType>
  <StepRepresentations xsitype="...">
    <name>...</name>
    <originalObjectId>...</originalObjectId>
  </StepRepresentations>
  <Steps xsitype="...">
    <guestOSCredential>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </guestOSCredential>
    <domainCredential>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </domainCredential>
    <workflowDefinitionId>...</workflowDefinitionId>
    <id>...</id>
    <name>...</name>
    <type>...</type>
    <stepNumber>...</stepNumber>
    <condition>...</condition>
  </Steps>
  <global>...</global>
  <targetType>...</targetType>
  <changeDescription>...</changeDescription>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</WorkflowDefinition>

                
              

POST /webservices/services/rest/v2/configurations/workflows/type/{workflow_type}/name/{name}/action/export

Export a specific workflow definition.

Request Parameters
name type description
name path the workflow name
workflow_type path the workflow type
Response Body
media type data type description
text/xml string (XML) the workflow export xml

Example

Request
POST /webservices/services/rest/v2/configurations/workflows/type/{workflow_type}/name/{name}/action/export
Content-Type: application/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/credentials

Retrieve a collection of shared credentials (without passwords).

Request Parameters
name type description default constraints
max query the max count 100 int
Response Body
media type data type description
application/xml CredentialCollection (XML) the credentials

Example

Request
GET /webservices/services/rest/v2/credentials
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<CredentialCollection>
  <Credentials>
    <username>...</username>
    <password>...</password>
    <category>...</category>
    <description>...</description>
    <name>...</name>
    <keyPairName>...</keyPairName>
    <rsa>...</rsa>
    <credentialFormat>...</credentialFormat>
  </Credentials>
</CredentialCollection>

                
              

GET /webservices/services/rest/v2/credentials/{name}

Retrieve a credential by its name

Request Parameters
name type description
name path the name of the credentials
Response Body
media type data type description
application/xml Credential (XML) the credential

Example

Request
GET /webservices/services/rest/v2/credentials/{name}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<Credential>
  <username>...</username>
  <password>...</password>
  <category>...</category>
  <description>...</description>
  <name>...</name>
  <keyPairName>...</keyPairName>
  <rsa>...</rsa>
  <credentialFormat>...</credentialFormat>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Credential>

                
              

GET /webservices/services/rest/v2/credentials/type/{type}

Retrieve a collection of shared credentials (without passwords) of the specified type.

Request Parameters
name type description default constraints
type path the credential type    
max query the max count 100 int
Response Body
media type data type description
application/xml CredentialCollection (XML) the credentials of type

Example

Request
GET /webservices/services/rest/v2/credentials/type/{type}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<CredentialCollection>
  <Credentials>
    <username>...</username>
    <password>...</password>
    <category>...</category>
    <description>...</description>
    <name>...</name>
    <keyPairName>...</keyPairName>
    <rsa>...</rsa>
    <credentialFormat>...</credentialFormat>
  </Credentials>
</CredentialCollection>

                
              

GET /webservices/services/rest/v2/custom/templates/servicecomponent

Retrieve a Published Service Component DTO from an inventory item with settings initialized to default values

Request Parameters
name type description constraints
refid query reference identifier long
reftype query reference type  
Response Body
media type data type description
application/xml PublishedServiceComponent (XML) the WSPublishedServiceComponent DTO with the default values set

Example

Request
GET /webservices/services/rest/v2/custom/templates/servicecomponent
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<PublishedServiceComponent xsitype="...">
  <id>...</id>
  <cost>...</cost>
  <namingFormat>...</namingFormat>
  <useDefaultNamingFormat>...</useDefaultNamingFormat>
  <service xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </service>
  <linkedClone>...</linkedClone>
  <template>...</template>
  <group>...</group>
  <name>...</name>
  <description>...</description>
  <componentType xsitype="...">
    <id>...</id>
    <name>...</name>
    <description>...</description>
    <cost>...</cost>
  </componentType>
  <ref xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ref>
  <serviceProperties>...</serviceProperties>
  <customizationSpecName>...</customizationSpecName>
  <instanceTypes>...</instanceTypes>
  <snapshot xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </snapshot>
  <availabilitySet>...</availabilitySet>
  <iamRole>...</iamRole>
  <pushMemoryMetrics>...</pushMemoryMetrics>
  <portMappings xsitype="...">
    <name>...</name>
    <publicProtocol>...</publicProtocol>
    <privateProtocol>...</privateProtocol>
    <publicPort>...</publicPort>
    <privatePort>...</privatePort>
  </portMappings>
  <componentNics xsitype="...">
    <id>...</id>
    <accessMode>...</accessMode>
    <addressMode>...</addressMode>
    <staticIp>...</staticIp>
    <mac>...</mac>
    <hostName>...</hostName>
    <portForwardPairs>
      <publicPort>...</publicPort>
      <privatePort>...</privatePort>
    </portForwardPairs>
  </componentNics>
  <serviceComponentSettings xsitype="...">
    <id>...</id>
    <requestAttributes>
      <attributeName>...</attributeName>
      <value>...</value>
    </requestAttributes>
    <groups>
      <groupType>...</groupType>
      <permanent>...</permanent>
    </groups>
    <formElements>
      <label>...</label>
      <mandatory>...</mandatory>
      <formType>...</formType>
      <value>...</value>
    </formElements>
    <resources>
      <resourceType>...</resourceType>
      <managementServerType>...</managementServerType>
    </resources>
  </serviceComponentSettings>
  <completionWorkflow xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </completionWorkflow>
  <cloudTemplateUrl>...</cloudTemplateUrl>
  <cloudTemplateBody>...</cloudTemplateBody>
  <cloudTemplateParameters>
    <name>...</name>
    <description>...</description>
    <defaultValue>...</defaultValue>
    <noEcho>...</noEcho>
    <value>...</value>
    <id>...</id>
    <type>...</type>
    <allowedValues>...</allowedValues>
  </cloudTemplateParameters>
  <targetType>...</targetType>
  <capabilities>...</capabilities>
  <capabilitiesReason>...</capabilitiesReason>
</PublishedServiceComponent>

                
              

GET /webservices/services/rest/v2/customcomponenttypes

Retrieve a list of custom component types

Response Body
media type data type description
application/xml CustomComponentTypeCollection (XML) the custom component types

Example

Request
GET /webservices/services/rest/v2/customcomponenttypes
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<CustomComponentTypeCollection>
  <CustomComponentTypes xsitype="...">
    <id>...</id>
    <name>...</name>
    <description>...</description>
    <cost>...</cost>
  </CustomComponentTypes>
</CustomComponentTypeCollection>

                
              

POST /webservices/services/rest/v2/customcomponenttypes

Create a custom component type.

Request Body
media type data type description
application/xml CustomComponentType (XML) the type
Response Body
media type data type description
application/xml CustomComponentType (XML) the WS custom component type

Example

Request
POST /webservices/services/rest/v2/customcomponenttypes
Content-Type: application/xml
Accept: application/xml

                
<CustomComponentType xsitype="...">
  <id>...</id>
  <name>...</name>
  <description>...</description>
  <cost>...</cost>
</CustomComponentType>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<CustomComponentType xsitype="...">
  <id>...</id>
  <name>...</name>
  <description>...</description>
  <cost>...</cost>
</CustomComponentType>

                
              

DELETE /webservices/services/rest/v2/customcomponenttypes/{id}

Delete custom component type by name.

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
DELETE /webservices/services/rest/v2/customcomponenttypes/{id}
Content-Type: text/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/customcomponenttypes/{id}

Retrieve a custom component type by ID.

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
application/xml CustomComponentType (XML) the custom component type

Example

Request
GET /webservices/services/rest/v2/customcomponenttypes/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<CustomComponentType xsitype="...">
  <id>...</id>
  <name>...</name>
  <description>...</description>
  <cost>...</cost>
</CustomComponentType>

                
              

GET /webservices/services/rest/v2/datacenters

Retrieve a list of datacenters.

Request Parameters
name type description default constraints
max query the max count 100 int
msid query the ms id -1 long
Response Body
media type data type description
application/xml DatacenterCollection (XML) the datacenters

Example

Request
GET /webservices/services/rest/v2/datacenters
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<DatacenterCollection>
  <Datacenters>
    <parent>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </parent>
    <hostFolder>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </hostFolder>
    <vmFolder>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </vmFolder>
    <datastores>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </datastores>
    <reference/>
    <managementServer/>
    <connected>...</connected>
    <remoteId>...</remoteId>
    <name>...</name>
    <operationalParent/>
    <deployedParent/>
    <repositoryParent/>
    <datastoreParent/>
    <attributes/>
    <expiryGroup/>
    <groups/>
    <managementServerType>...</managementServerType>
  </Datacenters>
</DatacenterCollection>

                
              

GET /webservices/services/rest/v2/deploymentdestinations

Retrieve deployment destinations.

Request Parameters
name type description default constraints
max query the max count 10 int
msid query the msid -1 long
Response Body
media type data type description
application/xml DeploymentDestinationCollection (XML) the deployment destinations

Example

Request
GET /webservices/services/rest/v2/deploymentdestinations
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<DeploymentDestinationCollection>
  <DeploymentDestinations xsitype="...">
    <id>...</id>
    <name>...</name>
    <managementServer>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </managementServer>
    <target>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </target>
    <users>
      <id>...</id>
      <loginId>...</loginId>
      <displayName>...</displayName>
      <email>...</email>
      <itContact>...</itContact>
      <primary>...</primary>
    </users>
    <organizations>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organizations>
    <appliedPlacementAttributes>
      <placementAttribute/>
      <allowedValues>...</allowedValues>
    </appliedPlacementAttributes>
  </DeploymentDestinations>
</DeploymentDestinationCollection>

                
              

POST /webservices/services/rest/v2/deploymentdestinations

Create a provisioning destination.

Request Body
media type data type description
application/xml DeploymentDestination (XML) the deployment destination
Response Body
media type data type description
application/xml DeploymentDestination (XML) the WS deployment destination

Example

Request
POST /webservices/services/rest/v2/deploymentdestinations
Content-Type: application/xml
Accept: application/xml

                
<DeploymentDestination xsitype="...">
  <id>...</id>
  <name>...</name>
  <managementServer xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </managementServer>
  <target xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </target>
  <users xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </users>
  <organizations xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organizations>
  <appliedPlacementAttributes xsitype="...">
    <placementAttribute>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </placementAttribute>
    <allowedValues>...</allowedValues>
  </appliedPlacementAttributes>
</DeploymentDestination>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<DeploymentDestination xsitype="...">
  <id>...</id>
  <name>...</name>
  <managementServer xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </managementServer>
  <target xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </target>
  <users xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </users>
  <organizations xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organizations>
  <appliedPlacementAttributes xsitype="...">
    <placementAttribute>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </placementAttribute>
    <allowedValues>...</allowedValues>
  </appliedPlacementAttributes>
</DeploymentDestination>

                
              

DELETE /webservices/services/rest/v2/deploymentdestinations/{id}

Delete a provisioning destination.

Request Parameters
name type description default constraints
id path the deployment destination id -1 long
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
DELETE /webservices/services/rest/v2/deploymentdestinations/{id}
Content-Type: text/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/deploymentdestinations/{id}

Retrieve deployment destination by Id.

Request Parameters
name type description default constraints
id path the id -1 long
Response Body
media type data type description
application/xml DeploymentDestination (XML) the deployment default

Example

Request
GET /webservices/services/rest/v2/deploymentdestinations/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<DeploymentDestination xsitype="...">
  <id>...</id>
  <name>...</name>
  <managementServer xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </managementServer>
  <target xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </target>
  <users xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </users>
  <organizations xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organizations>
  <appliedPlacementAttributes xsitype="...">
    <placementAttribute>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </placementAttribute>
    <allowedValues>...</allowedValues>
  </appliedPlacementAttributes>
</DeploymentDestination>

                
              

PUT /webservices/services/rest/v2/deploymentdestinations/{id}

Modify a provisioning destination.

Request Parameters
name type description default constraints
id path the deployment destination id -1 long
Request Body
media type data type description
application/xml DeploymentDestination (XML) the deployment destination
Response Body
media type data type description
application/xml DeploymentDestination (XML) the WS deployment destination

Example

Request
PUT /webservices/services/rest/v2/deploymentdestinations/{id}
Content-Type: application/xml
Accept: application/xml

                
<DeploymentDestination xsitype="...">
  <id>...</id>
  <name>...</name>
  <managementServer xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </managementServer>
  <target xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </target>
  <users xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </users>
  <organizations xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organizations>
  <appliedPlacementAttributes xsitype="...">
    <placementAttribute>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </placementAttribute>
    <allowedValues>...</allowedValues>
  </appliedPlacementAttributes>
</DeploymentDestination>

                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
<DeploymentDestination xsitype="...">
  <id>...</id>
  <name>...</name>
  <managementServer xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </managementServer>
  <target xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </target>
  <users xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </users>
  <organizations xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organizations>
  <appliedPlacementAttributes xsitype="...">
    <placementAttribute>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </placementAttribute>
    <allowedValues>...</allowedValues>
  </appliedPlacementAttributes>
</DeploymentDestination>

                
              

POST /webservices/services/rest/v2/deploymentdestinations/action/revalidate

Revalidate all provisioning destinations.

Response Body
media type data type description
application/xml anyType (XML) an HTTP response

Example

Request
POST /webservices/services/rest/v2/deploymentdestinations/action/revalidate
Content-Type: text/plain
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
...
                
              

GET /webservices/services/rest/v2/deploymentdestinations/assignments/orgs/{orgid}

Retrieve deployment destinations assigned to the specified organization.

Request Parameters
name type description default constraints
orgid path the org id -1 long
max query the max count 10 int
Response Body
media type data type description
application/xml DeploymentDestinationCollection (XML) the deployment destinations assigned to org

Example

Request
GET /webservices/services/rest/v2/deploymentdestinations/assignments/orgs/{orgid}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<DeploymentDestinationCollection>
  <DeploymentDestinations xsitype="...">
    <id>...</id>
    <name>...</name>
    <managementServer>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </managementServer>
    <target>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </target>
    <users>
      <id>...</id>
      <loginId>...</loginId>
      <displayName>...</displayName>
      <email>...</email>
      <itContact>...</itContact>
      <primary>...</primary>
    </users>
    <organizations>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organizations>
    <appliedPlacementAttributes>
      <placementAttribute/>
      <allowedValues>...</allowedValues>
    </appliedPlacementAttributes>
  </DeploymentDestinations>
</DeploymentDestinationCollection>

                
              

POST /webservices/services/rest/v2/deploymentdestinations/cache/action/clear

Clear provisioning destination cache.

Response Body
media type data type description
application/xml anyType (XML) an HTTP response

Example

Request
POST /webservices/services/rest/v2/deploymentdestinations/cache/action/clear
Content-Type: text/plain
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
...
                
              

DELETE /webservices/services/rest/v2/deploymentdestinations/metadata/datastores

Remove a datastore from all provisioning destinations Datastore name case insensitive.

Request Body
media type data type description
text/plain (custom) the datastore name
Response Body
media type data type description
application/xml anyType (XML) the response

Example

Request
DELETE /webservices/services/rest/v2/deploymentdestinations/metadata/datastores
Content-Type: text/plain
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
...
                
              

PUT /webservices/services/rest/v2/deploymentdestinations/metadata/datastores

Add a datastore to all provisioning destinations Datastore name case insensitive

Request Parameters
name type description default constraints
matchexistingtier query the match existing tier false boolean
Request Body
media type data type description
text/plain (custom) the datastore name
Response Body
media type data type description
application/xml anyType (XML) the response

Example

Request
PUT /webservices/services/rest/v2/deploymentdestinations/metadata/datastores
Content-Type: text/plain
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
...
                
              

GET /webservices/services/rest/v2/deploymentdestinations/name/{name}

Retrieve deployment destination by name.

Request Parameters
name type description default
name path the url encoded name
Response Body
media type data type description
application/xml DeploymentDestination (XML) the deployment default by name

Example

Request
GET /webservices/services/rest/v2/deploymentdestinations/name/{name}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<DeploymentDestination xsitype="...">
  <id>...</id>
  <name>...</name>
  <managementServer xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </managementServer>
  <target xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </target>
  <users xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </users>
  <organizations xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organizations>
  <appliedPlacementAttributes xsitype="...">
    <placementAttribute>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </placementAttribute>
    <allowedValues>...</allowedValues>
  </appliedPlacementAttributes>
</DeploymentDestination>

                
              

GET /webservices/services/rest/v2/distributedswitches

Retrieve distributed switches available to a resource pool, a host, or a cluster.

Request Parameters
name type description default constraints
clusterid query the cluster id -1 long
hostid query the host id -1 long
rpid query the rp id -1 long
switchname query the url encoded switchname  
Response Body
media type data type description
application/xml ManagedObjectReferenceCollection (XML) the distributed switches

Example

Request
GET /webservices/services/rest/v2/distributedswitches
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ManagedObjectReferenceCollection>
  <ManagedObjectReferences xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ManagedObjectReferences>
</ManagedObjectReferenceCollection>

                
              

GET /webservices/services/rest/v2/folders

Retrieve the list of folders

Request Parameters
name type description default constraints
max query the max count 100 int
Response Body
media type data type description
application/xml FolderCollection (XML) the folders

Example

Request
GET /webservices/services/rest/v2/folders
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<FolderCollection>
  <Folders>
    <parent>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </parent>
    <childType>...</childType>
    <reference/>
    <managementServer/>
    <connected>...</connected>
    <remoteId>...</remoteId>
    <name>...</name>
    <operationalParent/>
    <deployedParent/>
    <repositoryParent/>
    <datastoreParent/>
    <attributes/>
    <expiryGroup/>
    <groups/>
    <managementServerType>...</managementServerType>
  </Folders>
</FolderCollection>

                
              

GET /webservices/services/rest/v2/folders/name/{name}

Retrieve the list of folders.

Request Parameters
name type description default constraints
name path the encoded name    
max query the max count 100 int
Response Body
media type data type description
application/xml FolderCollection (XML) the folders by name

Example

Request
GET /webservices/services/rest/v2/folders/name/{name}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<FolderCollection>
  <Folders>
    <parent>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </parent>
    <childType>...</childType>
    <reference/>
    <managementServer/>
    <connected>...</connected>
    <remoteId>...</remoteId>
    <name>...</name>
    <operationalParent/>
    <deployedParent/>
    <repositoryParent/>
    <datastoreParent/>
    <attributes/>
    <expiryGroup/>
    <groups/>
    <managementServerType>...</managementServerType>
  </Folders>
</FolderCollection>

                
              

GET /webservices/services/rest/v2/forms

Retrieve all request forms available to the current user.

Response Body
media type data type description
application/xml RequestFormCollection (XML) the accessible request forms

Example

Request
GET /webservices/services/rest/v2/forms
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RequestFormCollection>
  <RequestForms xsitype="...">
    <formId>...</formId>
    <version>...</version>
    <menuText>...</menuText>
    <displayName>...</displayName>
    <requestType>...</requestType>
    <formComponentType>...</formComponentType>
    <RequestFormElements>
      <label>...</label>
      <mandatory>...</mandatory>
      <formType>...</formType>
      <value>...</value>
    </RequestFormElements>
    <Users>
      <id>...</id>
      <loginId>...</loginId>
      <displayName>...</displayName>
      <email>...</email>
      <itContact>...</itContact>
      <primary>...</primary>
    </Users>
    <Organizations>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </Organizations>
    <customComponentType>
      <id>...</id>
      <name>...</name>
      <description>...</description>
      <cost>...</cost>
    </customComponentType>
  </RequestForms>
</RequestFormCollection>

                
              

POST /webservices/services/rest/v2/forms

Create a service request form.

Request Body
media type data type description
application/xml RequestForm (XML) the request form
Response Body
media type data type description
application/xml RequestForm (XML) the WS request form

Example

Request
POST /webservices/services/rest/v2/forms
Content-Type: application/xml
Accept: application/xml

                
<RequestForm xsitype="...">
  <formId>...</formId>
  <version>...</version>
  <menuText>...</menuText>
  <displayName>...</displayName>
  <requestType>...</requestType>
  <formComponentType>...</formComponentType>
  <RequestFormElements xsitype="...">
    <label>...</label>
    <mandatory>...</mandatory>
    <formType>...</formType>
    <value>...</value>
  </RequestFormElements>
  <Users xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </Users>
  <Organizations xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </Organizations>
  <customComponentType xsitype="...">
    <id>...</id>
    <name>...</name>
    <description>...</description>
    <cost>...</cost>
  </customComponentType>
</RequestForm>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<RequestForm xsitype="...">
  <formId>...</formId>
  <version>...</version>
  <menuText>...</menuText>
  <displayName>...</displayName>
  <requestType>...</requestType>
  <formComponentType>...</formComponentType>
  <RequestFormElements xsitype="...">
    <label>...</label>
    <mandatory>...</mandatory>
    <formType>...</formType>
    <value>...</value>
  </RequestFormElements>
  <Users xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </Users>
  <Organizations xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </Organizations>
  <customComponentType xsitype="...">
    <id>...</id>
    <name>...</name>
    <description>...</description>
    <cost>...</cost>
  </customComponentType>
</RequestForm>

                
              

DELETE /webservices/services/rest/v2/forms/{formId}

Delete request form.

Request Parameters
name type description constraints
formId path the form id long
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
DELETE /webservices/services/rest/v2/forms/{formId}
Content-Type: text/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: text/xml

                
...
                
              

PUT /webservices/services/rest/v2/forms/{formId}

Update a request form.

Request Parameters
name type description constraints
formId path the form id long
Request Body
media type data type description
application/xml RequestForm (XML) the request form
Response Body
media type data type description
application/xml RequestForm (XML) the WS request form

Example

Request
PUT /webservices/services/rest/v2/forms/{formId}
Content-Type: application/xml
Accept: application/xml

                
<RequestForm xsitype="...">
  <formId>...</formId>
  <version>...</version>
  <menuText>...</menuText>
  <displayName>...</displayName>
  <requestType>...</requestType>
  <formComponentType>...</formComponentType>
  <RequestFormElements xsitype="...">
    <label>...</label>
    <mandatory>...</mandatory>
    <formType>...</formType>
    <value>...</value>
  </RequestFormElements>
  <Users xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </Users>
  <Organizations xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </Organizations>
  <customComponentType xsitype="...">
    <id>...</id>
    <name>...</name>
    <description>...</description>
    <cost>...</cost>
  </customComponentType>
</RequestForm>

                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
<RequestForm xsitype="...">
  <formId>...</formId>
  <version>...</version>
  <menuText>...</menuText>
  <displayName>...</displayName>
  <requestType>...</requestType>
  <formComponentType>...</formComponentType>
  <RequestFormElements xsitype="...">
    <label>...</label>
    <mandatory>...</mandatory>
    <formType>...</formType>
    <value>...</value>
  </RequestFormElements>
  <Users xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </Users>
  <Organizations xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </Organizations>
  <customComponentType xsitype="...">
    <id>...</id>
    <name>...</name>
    <description>...</description>
    <cost>...</cost>
  </customComponentType>
</RequestForm>

                
              

GET /webservices/services/rest/v2/forms/{id}

Retrieve a request form by id.

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
application/xml RequestForm (XML) the request form by id

Example

Request
GET /webservices/services/rest/v2/forms/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RequestForm xsitype="...">
  <formId>...</formId>
  <version>...</version>
  <menuText>...</menuText>
  <displayName>...</displayName>
  <requestType>...</requestType>
  <formComponentType>...</formComponentType>
  <RequestFormElements xsitype="...">
    <label>...</label>
    <mandatory>...</mandatory>
    <formType>...</formType>
    <value>...</value>
  </RequestFormElements>
  <Users xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </Users>
  <Organizations xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </Organizations>
  <customComponentType xsitype="...">
    <id>...</id>
    <name>...</name>
    <description>...</description>
    <cost>...</cost>
  </customComponentType>
</RequestForm>

                
              

GET /webservices/services/rest/v2/forms/{id}/formelements

Retrieve elements for the specified form.

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
application/xml RequestFormElementCollection (XML) the request form elements

Example

Request
GET /webservices/services/rest/v2/forms/{id}/formelements
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RequestFormElementCollection>
  <RequestFormElements xsitype="...">
    <label>...</label>
    <mandatory>...</mandatory>
    <formType>...</formType>
    <value>...</value>
  </RequestFormElements>
</RequestFormElementCollection>

                
              

POST /webservices/services/rest/v2/forms/action/export

Export all request forms

Response Body
media type data type description
text/xml string (XML) The exported xml

Example

Request
POST /webservices/services/rest/v2/forms/action/export
Content-Type: application/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

POST /webservices/services/rest/v2/forms/action/import

Import all request forms.

Request Body
media type data type description
text/xml string (XML) the xml
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/forms/action/import
Content-Type: text/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

POST /webservices/services/rest/v2/forms/name/{name}/action/export

Export the specified request form by name.

Request Parameters
name type description
name path the url encoded request form name
Response Body
media type data type description
text/xml string (XML) The exported xml

Example

Request
POST /webservices/services/rest/v2/forms/name/{name}/action/export
Content-Type: application/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/forms/type/{type}

Get all request forms of a specific type available to the user.

Request Parameters
name type description
type path the type
Response Body
media type data type description
application/xml RequestFormCollection (XML) the request forms of type

Example

Request
GET /webservices/services/rest/v2/forms/type/{type}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RequestFormCollection>
  <RequestForms xsitype="...">
    <formId>...</formId>
    <version>...</version>
    <menuText>...</menuText>
    <displayName>...</displayName>
    <requestType>...</requestType>
    <formComponentType>...</formComponentType>
    <RequestFormElements>
      <label>...</label>
      <mandatory>...</mandatory>
      <formType>...</formType>
      <value>...</value>
    </RequestFormElements>
    <Users>
      <id>...</id>
      <loginId>...</loginId>
      <displayName>...</displayName>
      <email>...</email>
      <itContact>...</itContact>
      <primary>...</primary>
    </Users>
    <Organizations>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </Organizations>
    <customComponentType>
      <id>...</id>
      <name>...</name>
      <description>...</description>
      <cost>...</cost>
    </customComponentType>
  </RequestForms>
</RequestFormCollection>

                
              

GET /webservices/services/rest/v2/groups

Retrieve all groups that has been defined in vCommander

Response Body
media type data type description
application/xml GroupCollection (XML) a collection of groups

Example

Request
GET /webservices/services/rest/v2/groups
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<GroupCollection>
  <Groups>
    <groupType>...</groupType>
    <permanent>...</permanent>
    <name>...</name>
    <description>...</description>
    <targetManagedObjectTypes>...</targetManagedObjectTypes>
    <allowedValues/>
    <portalEditable>...</portalEditable>
    <enumerated>...</enumerated>
    <costItems/>
    <regularExpression>...</regularExpression>
    <validationMessage>...</validationMessage>
    <subList>...</subList>
    <parentId>...</parentId>
    <parentName>...</parentName>
  </Groups>
</GroupCollection>

                
              

GET /webservices/services/rest/v2/groups/type/{type}

Retrieve a group by type.

Request Parameters
name type description
type path group type
Response Body
media type data type description
application/xml GroupCollection (XML) the group by type

Example

Request
GET /webservices/services/rest/v2/groups/type/{type}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<GroupCollection>
  <Groups>
    <groupType>...</groupType>
    <permanent>...</permanent>
    <name>...</name>
    <description>...</description>
    <targetManagedObjectTypes>...</targetManagedObjectTypes>
    <allowedValues/>
    <portalEditable>...</portalEditable>
    <enumerated>...</enumerated>
    <costItems/>
    <regularExpression>...</regularExpression>
    <validationMessage>...</validationMessage>
    <subList>...</subList>
    <parentId>...</parentId>
    <parentName>...</parentName>
  </Groups>
</GroupCollection>

                
              

GET /webservices/services/rest/v2/groups/type/{type}/name/{name}

Retrieve a group by name.

Request Parameters
name type description
name path the url encoded group name
type path the group type
Response Body
media type data type description
application/xml Group (XML) the group by name

Example

Request
GET /webservices/services/rest/v2/groups/type/{type}/name/{name}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<Group>
  <groupType>...</groupType>
  <permanent>...</permanent>
  <name>...</name>
  <description>...</description>
  <targetManagedObjectTypes>...</targetManagedObjectTypes>
  <allowedValues>
    <id>...</id>
    <name>...</name>
    <parentAttributeEnumId>...</parentAttributeEnumId>
    <parentAttributeEnumValue>...</parentAttributeEnumValue>
  </allowedValues>
  <portalEditable>...</portalEditable>
  <enumerated>...</enumerated>
  <costItems>
    <name>...</name>
    <cost>...</cost>
    <costFormula>...</costFormula>
  </costItems>
  <regularExpression>...</regularExpression>
  <validationMessage>...</validationMessage>
  <subList>...</subList>
  <parentId>...</parentId>
  <parentName>...</parentName>
</Group>

                
              

GET /webservices/services/rest/v2/hosts/{id}/standardswitches

Retrieve standard switches available to a host.

Request Parameters
name type description default constraints
id path the host id -1 long
Response Body
media type data type description
application/xml ManagedObjectReferenceCollection (XML) the host standard switches

Example

Request
GET /webservices/services/rest/v2/hosts/{id}/standardswitches
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ManagedObjectReferenceCollection>
  <ManagedObjectReferences xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ManagedObjectReferences>
</ManagedObjectReferenceCollection>

                
              

GET /webservices/services/rest/v2/managedobjects

Retrieve a managed object. Two properties are required to retrieve a managed object; type and either name or ID. If both name and ID are specified, name is ignored.

Request Parameters
name type description default constraints
id query The ID of the managed object (optional) -1 long
name query The url encoded name of the managed object (optional)  
type query The type of the managed object (required). See WSManagedObjectType  
Response Body
media type data type description
application/xml ManagedObjectCollection (XML) the managed objects

Example

Request
GET /webservices/services/rest/v2/managedobjects
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ManagedObjectCollection>
  <managedObjects>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </managedObjects>
</ManagedObjectCollection>

                
              

GET /webservices/services/rest/v2/managementservers

Retrieve the list of management servers.

Response Body
media type data type description
application/xml ManagementServerCollection (XML) the management servers

Example

Request
GET /webservices/services/rest/v2/managementservers
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ManagementServerCollection>
  <ManagementServers>
    <address>...</address>
    <port>...</port>
    <username>...</username>
    <serverType>...</serverType>
    <mgmtServiceVersion>...</mgmtServiceVersion>
    <unmanaged>...</unmanaged>
    <managedBy>...</managedBy>
    <rootFolder>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </rootFolder>
    <createdDate>...</createdDate>
    <earliestRetrievedHistoricEvent>...</earliestRetrievedHistoricEvent>
    <reference/>
    <managementServer/>
    <connected>...</connected>
    <remoteId>...</remoteId>
    <name>...</name>
    <operationalParent/>
    <deployedParent/>
    <repositoryParent/>
    <datastoreParent/>
    <attributes/>
    <expiryGroup/>
    <groups/>
    <managementServerType>...</managementServerType>
  </ManagementServers>
</ManagementServerCollection>

                
              

POST /webservices/services/rest/v2/managementservers

Add a management server.

Request Body
media type data type description
application/xml ManagementServerInfo (XML) the info
Response Body
media type data type description
application/xml TaskInfo (XML) the WS task info

Example

Request
POST /webservices/services/rest/v2/managementservers
Content-Type: application/xml
Accept: application/xml

                
<ManagementServerInfo xsitype="...">
  <name>...</name>
  <autoApproveVms>...</autoApproveVms>
</ManagementServerInfo>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

GET /webservices/services/rest/v2/managementservers/{id}

Retrieve a management server by Id.

Request Parameters
name type description constraints
id path the management server id long
Response Body
media type data type description
application/xml ManagementServer (XML) the management server

Example

Request
GET /webservices/services/rest/v2/managementservers/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ManagementServer>
  <address>...</address>
  <port>...</port>
  <username>...</username>
  <serverType>...</serverType>
  <mgmtServiceVersion>...</mgmtServiceVersion>
  <unmanaged>...</unmanaged>
  <managedBy>...</managedBy>
  <rootFolder xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </rootFolder>
  <createdDate>...</createdDate>
  <earliestRetrievedHistoricEvent>...</earliestRetrievedHistoricEvent>
  <reference>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </reference>
  <managementServer>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </managementServer>
  <connected>...</connected>
  <remoteId>...</remoteId>
  <name>...</name>
  <operationalParent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </operationalParent>
  <deployedParent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </deployedParent>
  <repositoryParent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </repositoryParent>
  <datastoreParent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </datastoreParent>
  <attributes>
    <id>...</id>
    <attribute/>
    <value>...</value>
  </attributes>
  <expiryGroup>
    <name>...</name>
    <description>...</description>
    <targetManagedObjectTypes>...</targetManagedObjectTypes>
    <allowedValues/>
    <portalEditable>...</portalEditable>
    <enumerated>...</enumerated>
    <costItems/>
    <regularExpression>...</regularExpression>
    <validationMessage>...</validationMessage>
    <subList>...</subList>
    <parentId>...</parentId>
    <parentName>...</parentName>
  </expiryGroup>
  <groups>
    <groupType>...</groupType>
    <permanent>...</permanent>
  </groups>
  <managementServerType>...</managementServerType>
</ManagementServer>

                
              

POST /webservices/services/rest/v2/managementservers/{id}/action/submitchange

Make a change request for the specified management server.

Request Parameters
name type description constraints
id path the management server Id long
Request Body
media type data type description
application/xml ChangeRequestParam (XML) the change request parameter
Response Body
media type data type description
application/xml Request (XML) the submitted request DTO

Example

Request
POST /webservices/services/rest/v2/managementservers/{id}/action/submitchange
Content-Type: application/xml
Accept: application/xml

                
<ChangeRequestParam>
  <formElements>
    <RequestFormElements>
      <label>...</label>
      <mandatory>...</mandatory>
      <formType>...</formType>
      <value>...</value>
    </RequestFormElements>
  </formElements>
  <formId>...</formId>
</ChangeRequestParam>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<Request>
  <id>...</id>
  <organization xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organization>
  <state>...</state>
  <type>...</type>
  <requestDate>...</requestDate>
  <fulfillDate>...</fulfillDate>
  <formVersion>...</formVersion>
  <requester>...</requester>
  <assignedAdmin>...</assignedAdmin>
  <waitingOn>...</waitingOn>
  <requiredBy>...</requiredBy>
  <targetService xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </targetService>
  <duration>...</duration>
  <requestFailed>...</requestFailed>
</Request>

                
              

POST /webservices/services/rest/v2/managementservers/{id}/action/synchronizeinventory

Synchronize inventory of a management server

Request Parameters
name type description constraints
id path the management server id long
Response Body
media type data type description
application/xml TaskInfo (XML) the task info of the synchronization task

Example

Request
POST /webservices/services/rest/v2/managementservers/{id}/action/synchronizeinventory
Content-Type: text/plain
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

GET /webservices/services/rest/v2/managementservers/{id}/clusters

Retrieve all clusters for the specified management servers.

Request Parameters
name type description constraints
id path the management server id long
Response Body
media type data type description
application/xml ManagedObjectReferenceCollection (XML) the clusters

Example

Request
GET /webservices/services/rest/v2/managementservers/{id}/clusters
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ManagedObjectReferenceCollection>
  <ManagedObjectReferences xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ManagedObjectReferences>
</ManagedObjectReferenceCollection>

                
              

GET /webservices/services/rest/v2/managementservers/{id}/clusters/name/{name}

Retrieve a cluster by name.

Request Parameters
name type description constraints
id path the management server id long
name path the url encoded cluster name  
Response Body
media type data type description
application/xml Cluster (XML) the cluster by name

Example

Request
GET /webservices/services/rest/v2/managementservers/{id}/clusters/name/{name}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<Cluster>
  <cluster>...</cluster>
  <drsEnabled>...</drsEnabled>
  <haEnabled>...</haEnabled>
  <totalCpu>...</totalCpu>
  <totalMemory>...</totalMemory>
  <totalProcessors>...</totalProcessors>
  <parent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </parent>
  <resourcePool>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </resourcePool>
  <runtimeServers>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </runtimeServers>
  <datastores>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </datastores>
  <haPolicy>
    <policyType>...</policyType>
    <enabled>...</enabled>
    <memoryPercentage>...</memoryPercentage>
    <cpuPercentage>...</cpuPercentage>
    <failoverLevel>...</failoverLevel>
    <failoverHosts/>
    <details>...</details>
  </haPolicy>
  <resourceReserves>
    <haReserveMemory>...</haReserveMemory>
    <haReserveCpu>...</haReserveCpu>
  </resourceReserves>
  <reference/>
  <managementServer/>
  <connected>...</connected>
  <remoteId>...</remoteId>
  <name>...</name>
  <operationalParent/>
  <deployedParent/>
  <repositoryParent/>
  <datastoreParent/>
  <attributes/>
  <expiryGroup/>
  <groups/>
  <managementServerType>...</managementServerType>
</Cluster>

                
              

GET /webservices/services/rest/v2/managementservers/{id}/metadata/changerequestparams/{formid}

Retrieve parameters needed for a management server change request using the specified form.

Request Parameters
name type description constraints
formid path the change request form id long
id path the managed system id long
Response Body
media type data type description
application/xml ChangeRequestParam (XML) the management server change request requirement

Example

Request
GET /webservices/services/rest/v2/managementservers/{id}/metadata/changerequestparams/{formid}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ChangeRequestParam>
  <formElements>
    <RequestFormElements>
      <label>...</label>
      <mandatory>...</mandatory>
      <formType>...</formType>
      <value>...</value>
    </RequestFormElements>
  </formElements>
  <formId>...</formId>
</ChangeRequestParam>

                
              

GET /webservices/services/rest/v2/mediafolders

Retrieve a list of Media Folders. Note: all the parameters are optional

Request Parameters
name type description default constraints
max query the maximum number of records returned - default is 100 100 int
name query filter on media folder name    
orgid query filter on organization id of the media folder   long
Response Body
media type data type description
application/xml MediaFolderCollection (XML) media folders

Example

Request
GET /webservices/services/rest/v2/mediafolders
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<MediaFolderCollection>
  <MediaFolder xsitype="...">
    <id>...</id>
    <name>...</name>
    <description>...</description>
    <path>...</path>
    <datastore>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </datastore>
    <global>...</global>
    <organizations>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organizations>
    <size>...</size>
    <lastSizeRefreshDate>...</lastSizeRefreshDate>
    <totalCost>...</totalCost>
    <issues>...</issues>
  </MediaFolder>
</MediaFolderCollection>

                
              

POST /webservices/services/rest/v2/mediafolders

Create a media folder.

Request Body
media type data type description
application/xml MediaFolder (XML) the new media folder
Response Body
media type data type description
application/xml TaskInfo (XML) the task info of the createMediaFolder task

Example

Request
POST /webservices/services/rest/v2/mediafolders
Content-Type: application/xml
Accept: application/xml

                
<MediaFolder xsitype="...">
  <id>...</id>
  <name>...</name>
  <description>...</description>
  <path>...</path>
  <datastore xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </datastore>
  <global>...</global>
  <organizations xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organizations>
  <size>...</size>
  <lastSizeRefreshDate>...</lastSizeRefreshDate>
  <totalCost>...</totalCost>
  <issues>...</issues>
</MediaFolder>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

DELETE /webservices/services/rest/v2/mediafolders/{id}

Deletes the specified media folder. If it does not exist, an exception will be thrown.

Request Parameters
name type description constraints
id path the media folder id long
Response Body
media type data type description
application/xml TaskInfo (XML) the task info of the deleteMediaFolder task

Example

Request
DELETE /webservices/services/rest/v2/mediafolders/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

GET /webservices/services/rest/v2/mediafolders/{id}

Retrieve a media folder by id.

Request Parameters
name type description default constraints
id path the id -1 long
Response Body
media type data type description
application/xml MediaFolder (XML) the media folder

Example

Request
GET /webservices/services/rest/v2/mediafolders/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<MediaFolder xsitype="...">
  <id>...</id>
  <name>...</name>
  <description>...</description>
  <path>...</path>
  <datastore xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </datastore>
  <global>...</global>
  <organizations xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organizations>
  <size>...</size>
  <lastSizeRefreshDate>...</lastSizeRefreshDate>
  <totalCost>...</totalCost>
  <issues>...</issues>
</MediaFolder>

                
              

PUT /webservices/services/rest/v2/mediafolders/{id}

Edit a media folder.

Request Parameters
name type description constraints
id path the media folder id long
Request Body
media type data type description
application/xml MediaFolder (XML) the modified media folder
Response Body
media type data type description
application/xml TaskInfo (XML) the task info of the updateMediaFolder task

Example

Request
PUT /webservices/services/rest/v2/mediafolders/{id}
Content-Type: application/xml
Accept: application/xml

                
<MediaFolder xsitype="...">
  <id>...</id>
  <name>...</name>
  <description>...</description>
  <path>...</path>
  <datastore xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </datastore>
  <global>...</global>
  <organizations xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organizations>
  <size>...</size>
  <lastSizeRefreshDate>...</lastSizeRefreshDate>
  <totalCost>...</totalCost>
  <issues>...</issues>
</MediaFolder>

                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

GET /webservices/services/rest/v2/monitoring/event/queue

Returns the may be used to monitor the health of the observation system.

Response Body
media type data type description
application/xml EventQueueStats (XML) Current Event queue size

Example

Request
GET /webservices/services/rest/v2/monitoring/event/queue
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<EventQueueStats>
  <length>...</length>
  <age>...</age>
</EventQueueStats>

                
              

GET /webservices/services/rest/v2/monitoring/observation/queue

Returns useful statistics about the current observation queue that may be used to monitor the health of the observation system.

Response Body
media type data type description
application/xml ObservationQueueStats (XML) Current state of the observation queue

Example

Request
GET /webservices/services/rest/v2/monitoring/observation/queue
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ObservationQueueStats>
  <length>...</length>
  <age>...</age>
</ObservationQueueStats>

                
              

GET /webservices/services/rest/v2/networks

Retrieve networks available to a datacenter, a host, or a cluster

Request Parameters
name type description default constraints
clusterid query the cluster id -1 long
dcid query the dc id -1 long
hostid query the host id -1 long
networkname query the url encoded network name  
Response Body
media type data type description
application/xml ManagedObjectReferenceCollection (XML) the available networks

Example

Request
GET /webservices/services/rest/v2/networks
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ManagedObjectReferenceCollection>
  <ManagedObjectReferences xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ManagedObjectReferences>
</ManagedObjectReferenceCollection>

                
              

POST /webservices/services/rest/v2/networks/{id}/action/applynetworkzone

Apply network zone tag to network.

Request Parameters
name type description constraints
id path the network id long
Request Body
media type data type description
application/xml NetworkZone (XML) the network zone tag
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/networks/{id}/action/applynetworkzone
Content-Type: application/xml
Accept: text/xml

                
<NetworkZone xsitype="...">
  <id>...</id>
  <name>...</name>
</NetworkZone>

                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/placementattributes

Retrieve all placement attributes

Response Body
media type data type description
application/xml PlacementAttributeCollection (XML) a collection of all placement attributes

Example

Request
GET /webservices/services/rest/v2/placementattributes
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<PlacementAttributeCollection>
  <PlacementAttributes xsitype="...">
    <name>...</name>
    <description>...</description>
    <id>...</id>
    <isEditableInPortal>...</isEditableInPortal>
  </PlacementAttributes>
</PlacementAttributeCollection>

                
              

POST /webservices/services/rest/v2/placementattributes

Create a placement attribute.

Request Body
media type data type description
application/xml PlacementAttributeBase (XML) the placement attribute to create
Response Body
media type data type description
application/xml PlacementAttributeBase (XML) the created placement attribute

Example

Request
POST /webservices/services/rest/v2/placementattributes
Content-Type: application/xml
Accept: application/xml

                
<PlacementAttributeBase xsitype="...">
  <name>...</name>
  <description>...</description>
  <id>...</id>
  <isEditableInPortal>...</isEditableInPortal>
</PlacementAttributeBase>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<PlacementAttributeBase xsitype="...">
  <name>...</name>
  <description>...</description>
  <id>...</id>
  <isEditableInPortal>...</isEditableInPortal>
</PlacementAttributeBase>

                
              

DELETE /webservices/services/rest/v2/placementattributes/{id}

Delete a placement attribute.

Request Parameters
name type description constraints
id path the ID of the placement attribute to delete long
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
DELETE /webservices/services/rest/v2/placementattributes/{id}
Content-Type: text/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/placementattributes/{id}

Retrieve a specific placement attribute

Request Parameters
name type description constraints
id path the ID of the placement attribute to retrieve long
Response Body
media type data type description
application/xml PlacementAttributeBase (XML) the placement attribute

Example

Request
GET /webservices/services/rest/v2/placementattributes/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<PlacementAttributeBase xsitype="...">
  <name>...</name>
  <description>...</description>
  <id>...</id>
  <isEditableInPortal>...</isEditableInPortal>
</PlacementAttributeBase>

                
              

PUT /webservices/services/rest/v2/placementattributes/{id}

Modify a placement attribute.

Request Parameters
name type description constraints
id path the id long
Request Body
media type data type description
application/xml PlacementAttributeBase (XML) the updated attribute
Response Body
media type data type description
application/xml PlacementAttributeBase (XML) the updated placement attribute

Example

Request
PUT /webservices/services/rest/v2/placementattributes/{id}
Content-Type: application/xml
Accept: application/xml

                
<PlacementAttributeBase xsitype="...">
  <name>...</name>
  <description>...</description>
  <id>...</id>
  <isEditableInPortal>...</isEditableInPortal>
</PlacementAttributeBase>

                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
<PlacementAttributeBase xsitype="...">
  <name>...</name>
  <description>...</description>
  <id>...</id>
  <isEditableInPortal>...</isEditableInPortal>
</PlacementAttributeBase>

                
              

GET /webservices/services/rest/v2/placementattributes/name/{name}

Retrieve a specific placement attribute

Request Parameters
name type description
name path the URL encoded name of the placement attribute to retrieve
Response Body
media type data type description
application/xml PlacementAttributeBase (XML) the placement attribute

Example

Request
GET /webservices/services/rest/v2/placementattributes/name/{name}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<PlacementAttributeBase xsitype="...">
  <name>...</name>
  <description>...</description>
  <id>...</id>
  <isEditableInPortal>...</isEditableInPortal>
</PlacementAttributeBase>

                
              

GET /webservices/services/rest/v2/policies

Retrieve a collection of policies.

Request Parameters
name type description default constraints
max query the max count 100 int
Response Body
media type data type description
application/xml ManagedObjectReferenceCollection (XML) the policies

Example

Request
GET /webservices/services/rest/v2/policies
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ManagedObjectReferenceCollection>
  <ManagedObjectReferences xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ManagedObjectReferences>
</ManagedObjectReferenceCollection>

                
              

POST /webservices/services/rest/v2/policies

Create a policy.

Request Body
media type data type description
application/xml Policy (XML) the policy
Response Body
media type data type description
application/xml Policy (XML) the WS policy

Example

Request
POST /webservices/services/rest/v2/policies
Content-Type: application/xml
Accept: application/xml

                
<Policy>
  <enabled>...</enabled>
  <name>...</name>
  <description>...</description>
  <policyType>...</policyType>
  <targets xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </targets>
  <global>...</global>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Policy>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<Policy>
  <enabled>...</enabled>
  <name>...</name>
  <description>...</description>
  <policyType>...</policyType>
  <targets xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </targets>
  <global>...</global>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Policy>

                
              

DELETE /webservices/services/rest/v2/policies/{id}

Delete a policy.

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
DELETE /webservices/services/rest/v2/policies/{id}
Content-Type: text/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/policies/{id}

Retrieve a policy by Id.

Request Parameters
name type description constraints
id path the policy id long
Response Body
media type data type description
application/xml Policy (XML) the policy by id

Example

Request
GET /webservices/services/rest/v2/policies/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<Policy>
  <enabled>...</enabled>
  <name>...</name>
  <description>...</description>
  <policyType>...</policyType>
  <targets xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </targets>
  <global>...</global>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Policy>

                
              

PUT /webservices/services/rest/v2/policies/{id}

Modify a policy.

Request Parameters
name type description constraints
id path the id long
Request Body
media type data type description
application/xml Policy (XML) the policy
Response Body
media type data type description
application/xml Policy (XML) the WS policy

Example

Request
PUT /webservices/services/rest/v2/policies/{id}
Content-Type: application/xml
Accept: application/xml

                
<Policy>
  <enabled>...</enabled>
  <name>...</name>
  <description>...</description>
  <policyType>...</policyType>
  <targets xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </targets>
  <global>...</global>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Policy>

                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
<Policy>
  <enabled>...</enabled>
  <name>...</name>
  <description>...</description>
  <policyType>...</policyType>
  <targets xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </targets>
  <global>...</global>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Policy>

                
              

GET /webservices/services/rest/v2/policies/name/{name}

Retrieve a policy by name.

Request Parameters
name type description
name path the encoded name
Response Body
media type data type description
application/xml Policy (XML) the policy by name

Example

Request
GET /webservices/services/rest/v2/policies/name/{name}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<Policy>
  <enabled>...</enabled>
  <name>...</name>
  <description>...</description>
  <policyType>...</policyType>
  <targets xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </targets>
  <global>...</global>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Policy>

                
              

GET /webservices/services/rest/v2/policies/type/{type}

Retrieve policies of specified type.

Request Parameters
name type description default constraints
type path the policy type    
max query the max count 100 int
Response Body
media type data type description
application/xml ManagedObjectReferenceCollection (XML) the policies by type

Example

Request
GET /webservices/services/rest/v2/policies/type/{type}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ManagedObjectReferenceCollection>
  <ManagedObjectReferences xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ManagedObjectReferences>
</ManagedObjectReferenceCollection>

                
              

GET /webservices/services/rest/v2/projects

Retrieve projects

Request Parameters
name type description default constraints
max query the max 10 int
Response Body
media type data type description
application/xml ManagedObjectReferenceCollection (XML) the projects

Example

Request
GET /webservices/services/rest/v2/projects
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ManagedObjectReferenceCollection>
  <ManagedObjectReferences xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ManagedObjectReferences>
</ManagedObjectReferenceCollection>

                
              

GET /webservices/services/rest/v2/publishedservices

Retrieve a collection of published services

Response Body
media type data type description
application/xml PublishedServiceCollection (XML) the published services

Example

Request
GET /webservices/services/rest/v2/publishedservices
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<PublishedServiceCollection>
  <PublishedServices>
    <serviceType>...</serviceType>
    <useStaticComponentForms>...</useStaticComponentForms>
    <resourceSummary>
      <totalCost>...</totalCost>
      <totalOsCost>...</totalOsCost>
      <totalCpuCost>...</totalCpuCost>
      <totalMemoryCost>...</totalMemoryCost>
      <totalDiskCost>...</totalDiskCost>
      <totalSupportCost>...</totalSupportCost>
      <totalExtraCost>...</totalExtraCost>
      <totalCpu>...</totalCpu>
      <totalMemory>...</totalMemory>
      <totalDisk>...</totalDisk>
      <totalCategorizedCosts>...</totalCategorizedCosts>
    </resourceSummary>
    <deployType>...</deployType>
    <name>...</name>
    <namingFormat>...</namingFormat>
    <iconId>...</iconId>
    <useDefaultNamingFormat>...</useDefaultNamingFormat>
    <highlyAvailable>...</highlyAvailable>
    <fenced>...</fenced>
    <startDeployedComponents>...</startDeployedComponents>
    <description>...</description>
    <serviceDeployable>...</serviceDeployable>
    <completionWorkflowId>...</completionWorkflowId>
    <retired>...</retired>
    <publishState>...</publishState>
    <serviceUsers>
      <id>...</id>
      <loginId>...</loginId>
      <displayName>...</displayName>
      <email>...</email>
      <itContact>...</itContact>
      <primary>...</primary>
    </serviceUsers>
    <organizations>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organizations>
    <serviceComponents>
      <id>...</id>
      <cost>...</cost>
      <namingFormat>...</namingFormat>
      <useDefaultNamingFormat>...</useDefaultNamingFormat>
      <service/>
      <linkedClone>...</linkedClone>
      <template>...</template>
      <group>...</group>
      <name>...</name>
      <description>...</description>
      <componentType/>
      <ref/>
      <serviceProperties>...</serviceProperties>
      <customizationSpecName>...</customizationSpecName>
      <instanceTypes>...</instanceTypes>
      <snapshot/>
      <availabilitySet>...</availabilitySet>
      <iamRole>...</iamRole>
      <pushMemoryMetrics>...</pushMemoryMetrics>
      <portMappings/>
      <componentNics/>
      <serviceComponentSettings/>
      <completionWorkflow/>
      <cloudTemplateUrl>...</cloudTemplateUrl>
      <cloudTemplateBody>...</cloudTemplateBody>
      <cloudTemplateParameters/>
      <targetType>...</targetType>
      <capabilities>...</capabilities>
      <capabilitiesReason>...</capabilitiesReason>
    </serviceComponents>
    <categories>
      <id>...</id>
      <name>...</name>
      <serviceCount>...</serviceCount>
    </categories>
    <externalRouterStaticallyAssigned>...</externalRouterStaticallyAssigned>
    <internalRouterIp>...</internalRouterIp>
    <internalRouterSubnet>...</internalRouterSubnet>
    <appliedPlacementAttributes>
      <placementAttribute/>
      <allowedValues>...</allowedValues>
    </appliedPlacementAttributes>
    <cloudTemplateDeployType>...</cloudTemplateDeployType>
    <serviceFormIncluded>...</serviceFormIncluded>
  </PublishedServices>
</PublishedServiceCollection>

                
              

POST /webservices/services/rest/v2/publishedservices

Create a published service.

Request Body
media type data type description
application/xml PublishedService (XML) the new service
Response Body
media type data type description
application/xml PublishedService (XML) the WS published service

Example

Request
POST /webservices/services/rest/v2/publishedservices
Content-Type: application/xml
Accept: application/xml

                
<PublishedService>
  <serviceType>...</serviceType>
  <useStaticComponentForms>...</useStaticComponentForms>
  <resourceSummary>
    <totalCost>...</totalCost>
    <totalOsCost>...</totalOsCost>
    <totalCpuCost>...</totalCpuCost>
    <totalMemoryCost>...</totalMemoryCost>
    <totalDiskCost>...</totalDiskCost>
    <totalSupportCost>...</totalSupportCost>
    <totalExtraCost>...</totalExtraCost>
    <totalCpu>...</totalCpu>
    <totalMemory>...</totalMemory>
    <totalDisk>...</totalDisk>
    <totalCategorizedCosts>...</totalCategorizedCosts>
  </resourceSummary>
  <deployType>...</deployType>
  <name>...</name>
  <namingFormat>...</namingFormat>
  <iconId>...</iconId>
  <useDefaultNamingFormat>...</useDefaultNamingFormat>
  <highlyAvailable>...</highlyAvailable>
  <fenced>...</fenced>
  <startDeployedComponents>...</startDeployedComponents>
  <description>...</description>
  <serviceDeployable>...</serviceDeployable>
  <completionWorkflowId>...</completionWorkflowId>
  <retired>...</retired>
  <publishState>...</publishState>
  <serviceUsers xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </serviceUsers>
  <organizations xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organizations>
  <serviceComponents xsitype="...">
    <id>...</id>
    <cost>...</cost>
    <namingFormat>...</namingFormat>
    <useDefaultNamingFormat>...</useDefaultNamingFormat>
    <service>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </service>
    <linkedClone>...</linkedClone>
    <template>...</template>
    <group>...</group>
    <name>...</name>
    <description>...</description>
    <componentType>
      <id>...</id>
      <name>...</name>
      <description>...</description>
      <cost>...</cost>
    </componentType>
    <ref>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </ref>
    <serviceProperties>...</serviceProperties>
    <customizationSpecName>...</customizationSpecName>
    <instanceTypes>...</instanceTypes>
    <snapshot>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </snapshot>
    <availabilitySet>...</availabilitySet>
    <iamRole>...</iamRole>
    <pushMemoryMetrics>...</pushMemoryMetrics>
    <portMappings>
      <name>...</name>
      <publicProtocol>...</publicProtocol>
      <privateProtocol>...</privateProtocol>
      <publicPort>...</publicPort>
      <privatePort>...</privatePort>
    </portMappings>
    <componentNics>
      <id>...</id>
      <accessMode>...</accessMode>
      <addressMode>...</addressMode>
      <staticIp>...</staticIp>
      <mac>...</mac>
      <hostName>...</hostName>
      <portForwardPairs/>
    </componentNics>
    <serviceComponentSettings>
      <id>...</id>
      <requestAttributes/>
      <groups/>
      <formElements/>
      <resources/>
    </serviceComponentSettings>
    <completionWorkflow>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </completionWorkflow>
    <cloudTemplateUrl>...</cloudTemplateUrl>
    <cloudTemplateBody>...</cloudTemplateBody>
    <cloudTemplateParameters>
      <name>...</name>
      <description>...</description>
      <defaultValue>...</defaultValue>
      <noEcho>...</noEcho>
      <value>...</value>
      <id>...</id>
      <type>...</type>
      <allowedValues>...</allowedValues>
    </cloudTemplateParameters>
    <targetType>...</targetType>
    <capabilities>...</capabilities>
    <capabilitiesReason>...</capabilitiesReason>
  </serviceComponents>
  <categories xsitype="...">
    <id>...</id>
    <name>...</name>
    <serviceCount>...</serviceCount>
  </categories>
  <externalRouterStaticallyAssigned>...</externalRouterStaticallyAssigned>
  <internalRouterIp>...</internalRouterIp>
  <internalRouterSubnet>...</internalRouterSubnet>
  <appliedPlacementAttributes xsitype="...">
    <placementAttribute>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </placementAttribute>
    <allowedValues>...</allowedValues>
  </appliedPlacementAttributes>
  <cloudTemplateDeployType>...</cloudTemplateDeployType>
  <serviceFormIncluded>...</serviceFormIncluded>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</PublishedService>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<PublishedService>
  <serviceType>...</serviceType>
  <useStaticComponentForms>...</useStaticComponentForms>
  <resourceSummary>
    <totalCost>...</totalCost>
    <totalOsCost>...</totalOsCost>
    <totalCpuCost>...</totalCpuCost>
    <totalMemoryCost>...</totalMemoryCost>
    <totalDiskCost>...</totalDiskCost>
    <totalSupportCost>...</totalSupportCost>
    <totalExtraCost>...</totalExtraCost>
    <totalCpu>...</totalCpu>
    <totalMemory>...</totalMemory>
    <totalDisk>...</totalDisk>
    <totalCategorizedCosts>...</totalCategorizedCosts>
  </resourceSummary>
  <deployType>...</deployType>
  <name>...</name>
  <namingFormat>...</namingFormat>
  <iconId>...</iconId>
  <useDefaultNamingFormat>...</useDefaultNamingFormat>
  <highlyAvailable>...</highlyAvailable>
  <fenced>...</fenced>
  <startDeployedComponents>...</startDeployedComponents>
  <description>...</description>
  <serviceDeployable>...</serviceDeployable>
  <completionWorkflowId>...</completionWorkflowId>
  <retired>...</retired>
  <publishState>...</publishState>
  <serviceUsers xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </serviceUsers>
  <organizations xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organizations>
  <serviceComponents xsitype="...">
    <id>...</id>
    <cost>...</cost>
    <namingFormat>...</namingFormat>
    <useDefaultNamingFormat>...</useDefaultNamingFormat>
    <service>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </service>
    <linkedClone>...</linkedClone>
    <template>...</template>
    <group>...</group>
    <name>...</name>
    <description>...</description>
    <componentType>
      <id>...</id>
      <name>...</name>
      <description>...</description>
      <cost>...</cost>
    </componentType>
    <ref>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </ref>
    <serviceProperties>...</serviceProperties>
    <customizationSpecName>...</customizationSpecName>
    <instanceTypes>...</instanceTypes>
    <snapshot>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </snapshot>
    <availabilitySet>...</availabilitySet>
    <iamRole>...</iamRole>
    <pushMemoryMetrics>...</pushMemoryMetrics>
    <portMappings>
      <name>...</name>
      <publicProtocol>...</publicProtocol>
      <privateProtocol>...</privateProtocol>
      <publicPort>...</publicPort>
      <privatePort>...</privatePort>
    </portMappings>
    <componentNics>
      <id>...</id>
      <accessMode>...</accessMode>
      <addressMode>...</addressMode>
      <staticIp>...</staticIp>
      <mac>...</mac>
      <hostName>...</hostName>
      <portForwardPairs/>
    </componentNics>
    <serviceComponentSettings>
      <id>...</id>
      <requestAttributes/>
      <groups/>
      <formElements/>
      <resources/>
    </serviceComponentSettings>
    <completionWorkflow>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </completionWorkflow>
    <cloudTemplateUrl>...</cloudTemplateUrl>
    <cloudTemplateBody>...</cloudTemplateBody>
    <cloudTemplateParameters>
      <name>...</name>
      <description>...</description>
      <defaultValue>...</defaultValue>
      <noEcho>...</noEcho>
      <value>...</value>
      <id>...</id>
      <type>...</type>
      <allowedValues>...</allowedValues>
    </cloudTemplateParameters>
    <targetType>...</targetType>
    <capabilities>...</capabilities>
    <capabilitiesReason>...</capabilitiesReason>
  </serviceComponents>
  <categories xsitype="...">
    <id>...</id>
    <name>...</name>
    <serviceCount>...</serviceCount>
  </categories>
  <externalRouterStaticallyAssigned>...</externalRouterStaticallyAssigned>
  <internalRouterIp>...</internalRouterIp>
  <internalRouterSubnet>...</internalRouterSubnet>
  <appliedPlacementAttributes xsitype="...">
    <placementAttribute>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </placementAttribute>
    <allowedValues>...</allowedValues>
  </appliedPlacementAttributes>
  <cloudTemplateDeployType>...</cloudTemplateDeployType>
  <serviceFormIncluded>...</serviceFormIncluded>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</PublishedService>

                
              

DELETE /webservices/services/rest/v2/publishedservices/{id}

Delete a published service.

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
DELETE /webservices/services/rest/v2/publishedservices/{id}
Content-Type: text/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/publishedservices/{id}

Retrieve a published service by ID.

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
application/xml PublishedService (XML) the WS published service

Example

Request
GET /webservices/services/rest/v2/publishedservices/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<PublishedService>
  <serviceType>...</serviceType>
  <useStaticComponentForms>...</useStaticComponentForms>
  <resourceSummary>
    <totalCost>...</totalCost>
    <totalOsCost>...</totalOsCost>
    <totalCpuCost>...</totalCpuCost>
    <totalMemoryCost>...</totalMemoryCost>
    <totalDiskCost>...</totalDiskCost>
    <totalSupportCost>...</totalSupportCost>
    <totalExtraCost>...</totalExtraCost>
    <totalCpu>...</totalCpu>
    <totalMemory>...</totalMemory>
    <totalDisk>...</totalDisk>
    <totalCategorizedCosts>...</totalCategorizedCosts>
  </resourceSummary>
  <deployType>...</deployType>
  <name>...</name>
  <namingFormat>...</namingFormat>
  <iconId>...</iconId>
  <useDefaultNamingFormat>...</useDefaultNamingFormat>
  <highlyAvailable>...</highlyAvailable>
  <fenced>...</fenced>
  <startDeployedComponents>...</startDeployedComponents>
  <description>...</description>
  <serviceDeployable>...</serviceDeployable>
  <completionWorkflowId>...</completionWorkflowId>
  <retired>...</retired>
  <publishState>...</publishState>
  <serviceUsers xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </serviceUsers>
  <organizations xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organizations>
  <serviceComponents xsitype="...">
    <id>...</id>
    <cost>...</cost>
    <namingFormat>...</namingFormat>
    <useDefaultNamingFormat>...</useDefaultNamingFormat>
    <service>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </service>
    <linkedClone>...</linkedClone>
    <template>...</template>
    <group>...</group>
    <name>...</name>
    <description>...</description>
    <componentType>
      <id>...</id>
      <name>...</name>
      <description>...</description>
      <cost>...</cost>
    </componentType>
    <ref>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </ref>
    <serviceProperties>...</serviceProperties>
    <customizationSpecName>...</customizationSpecName>
    <instanceTypes>...</instanceTypes>
    <snapshot>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </snapshot>
    <availabilitySet>...</availabilitySet>
    <iamRole>...</iamRole>
    <pushMemoryMetrics>...</pushMemoryMetrics>
    <portMappings>
      <name>...</name>
      <publicProtocol>...</publicProtocol>
      <privateProtocol>...</privateProtocol>
      <publicPort>...</publicPort>
      <privatePort>...</privatePort>
    </portMappings>
    <componentNics>
      <id>...</id>
      <accessMode>...</accessMode>
      <addressMode>...</addressMode>
      <staticIp>...</staticIp>
      <mac>...</mac>
      <hostName>...</hostName>
      <portForwardPairs/>
    </componentNics>
    <serviceComponentSettings>
      <id>...</id>
      <requestAttributes/>
      <groups/>
      <formElements/>
      <resources/>
    </serviceComponentSettings>
    <completionWorkflow>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </completionWorkflow>
    <cloudTemplateUrl>...</cloudTemplateUrl>
    <cloudTemplateBody>...</cloudTemplateBody>
    <cloudTemplateParameters>
      <name>...</name>
      <description>...</description>
      <defaultValue>...</defaultValue>
      <noEcho>...</noEcho>
      <value>...</value>
      <id>...</id>
      <type>...</type>
      <allowedValues>...</allowedValues>
    </cloudTemplateParameters>
    <targetType>...</targetType>
    <capabilities>...</capabilities>
    <capabilitiesReason>...</capabilitiesReason>
  </serviceComponents>
  <categories xsitype="...">
    <id>...</id>
    <name>...</name>
    <serviceCount>...</serviceCount>
  </categories>
  <externalRouterStaticallyAssigned>...</externalRouterStaticallyAssigned>
  <internalRouterIp>...</internalRouterIp>
  <internalRouterSubnet>...</internalRouterSubnet>
  <appliedPlacementAttributes xsitype="...">
    <placementAttribute>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </placementAttribute>
    <allowedValues>...</allowedValues>
  </appliedPlacementAttributes>
  <cloudTemplateDeployType>...</cloudTemplateDeployType>
  <serviceFormIncluded>...</serviceFormIncluded>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</PublishedService>

                
              

PUT /webservices/services/rest/v2/publishedservices/{id}

Modify a published service.

Request Parameters
name type description constraints
id path the id long
Request Body
media type data type description
application/xml PublishedService (XML) the updated service
Response Body
media type data type description
application/xml PublishedService (XML) the WS published service

Example

Request
PUT /webservices/services/rest/v2/publishedservices/{id}
Content-Type: application/xml
Accept: application/xml

                
<PublishedService>
  <serviceType>...</serviceType>
  <useStaticComponentForms>...</useStaticComponentForms>
  <resourceSummary>
    <totalCost>...</totalCost>
    <totalOsCost>...</totalOsCost>
    <totalCpuCost>...</totalCpuCost>
    <totalMemoryCost>...</totalMemoryCost>
    <totalDiskCost>...</totalDiskCost>
    <totalSupportCost>...</totalSupportCost>
    <totalExtraCost>...</totalExtraCost>
    <totalCpu>...</totalCpu>
    <totalMemory>...</totalMemory>
    <totalDisk>...</totalDisk>
    <totalCategorizedCosts>...</totalCategorizedCosts>
  </resourceSummary>
  <deployType>...</deployType>
  <name>...</name>
  <namingFormat>...</namingFormat>
  <iconId>...</iconId>
  <useDefaultNamingFormat>...</useDefaultNamingFormat>
  <highlyAvailable>...</highlyAvailable>
  <fenced>...</fenced>
  <startDeployedComponents>...</startDeployedComponents>
  <description>...</description>
  <serviceDeployable>...</serviceDeployable>
  <completionWorkflowId>...</completionWorkflowId>
  <retired>...</retired>
  <publishState>...</publishState>
  <serviceUsers xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </serviceUsers>
  <organizations xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organizations>
  <serviceComponents xsitype="...">
    <id>...</id>
    <cost>...</cost>
    <namingFormat>...</namingFormat>
    <useDefaultNamingFormat>...</useDefaultNamingFormat>
    <service>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </service>
    <linkedClone>...</linkedClone>
    <template>...</template>
    <group>...</group>
    <name>...</name>
    <description>...</description>
    <componentType>
      <id>...</id>
      <name>...</name>
      <description>...</description>
      <cost>...</cost>
    </componentType>
    <ref>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </ref>
    <serviceProperties>...</serviceProperties>
    <customizationSpecName>...</customizationSpecName>
    <instanceTypes>...</instanceTypes>
    <snapshot>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </snapshot>
    <availabilitySet>...</availabilitySet>
    <iamRole>...</iamRole>
    <pushMemoryMetrics>...</pushMemoryMetrics>
    <portMappings>
      <name>...</name>
      <publicProtocol>...</publicProtocol>
      <privateProtocol>...</privateProtocol>
      <publicPort>...</publicPort>
      <privatePort>...</privatePort>
    </portMappings>
    <componentNics>
      <id>...</id>
      <accessMode>...</accessMode>
      <addressMode>...</addressMode>
      <staticIp>...</staticIp>
      <mac>...</mac>
      <hostName>...</hostName>
      <portForwardPairs/>
    </componentNics>
    <serviceComponentSettings>
      <id>...</id>
      <requestAttributes/>
      <groups/>
      <formElements/>
      <resources/>
    </serviceComponentSettings>
    <completionWorkflow>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </completionWorkflow>
    <cloudTemplateUrl>...</cloudTemplateUrl>
    <cloudTemplateBody>...</cloudTemplateBody>
    <cloudTemplateParameters>
      <name>...</name>
      <description>...</description>
      <defaultValue>...</defaultValue>
      <noEcho>...</noEcho>
      <value>...</value>
      <id>...</id>
      <type>...</type>
      <allowedValues>...</allowedValues>
    </cloudTemplateParameters>
    <targetType>...</targetType>
    <capabilities>...</capabilities>
    <capabilitiesReason>...</capabilitiesReason>
  </serviceComponents>
  <categories xsitype="...">
    <id>...</id>
    <name>...</name>
    <serviceCount>...</serviceCount>
  </categories>
  <externalRouterStaticallyAssigned>...</externalRouterStaticallyAssigned>
  <internalRouterIp>...</internalRouterIp>
  <internalRouterSubnet>...</internalRouterSubnet>
  <appliedPlacementAttributes xsitype="...">
    <placementAttribute>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </placementAttribute>
    <allowedValues>...</allowedValues>
  </appliedPlacementAttributes>
  <cloudTemplateDeployType>...</cloudTemplateDeployType>
  <serviceFormIncluded>...</serviceFormIncluded>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</PublishedService>

                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
<PublishedService>
  <serviceType>...</serviceType>
  <useStaticComponentForms>...</useStaticComponentForms>
  <resourceSummary>
    <totalCost>...</totalCost>
    <totalOsCost>...</totalOsCost>
    <totalCpuCost>...</totalCpuCost>
    <totalMemoryCost>...</totalMemoryCost>
    <totalDiskCost>...</totalDiskCost>
    <totalSupportCost>...</totalSupportCost>
    <totalExtraCost>...</totalExtraCost>
    <totalCpu>...</totalCpu>
    <totalMemory>...</totalMemory>
    <totalDisk>...</totalDisk>
    <totalCategorizedCosts>...</totalCategorizedCosts>
  </resourceSummary>
  <deployType>...</deployType>
  <name>...</name>
  <namingFormat>...</namingFormat>
  <iconId>...</iconId>
  <useDefaultNamingFormat>...</useDefaultNamingFormat>
  <highlyAvailable>...</highlyAvailable>
  <fenced>...</fenced>
  <startDeployedComponents>...</startDeployedComponents>
  <description>...</description>
  <serviceDeployable>...</serviceDeployable>
  <completionWorkflowId>...</completionWorkflowId>
  <retired>...</retired>
  <publishState>...</publishState>
  <serviceUsers xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </serviceUsers>
  <organizations xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organizations>
  <serviceComponents xsitype="...">
    <id>...</id>
    <cost>...</cost>
    <namingFormat>...</namingFormat>
    <useDefaultNamingFormat>...</useDefaultNamingFormat>
    <service>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </service>
    <linkedClone>...</linkedClone>
    <template>...</template>
    <group>...</group>
    <name>...</name>
    <description>...</description>
    <componentType>
      <id>...</id>
      <name>...</name>
      <description>...</description>
      <cost>...</cost>
    </componentType>
    <ref>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </ref>
    <serviceProperties>...</serviceProperties>
    <customizationSpecName>...</customizationSpecName>
    <instanceTypes>...</instanceTypes>
    <snapshot>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </snapshot>
    <availabilitySet>...</availabilitySet>
    <iamRole>...</iamRole>
    <pushMemoryMetrics>...</pushMemoryMetrics>
    <portMappings>
      <name>...</name>
      <publicProtocol>...</publicProtocol>
      <privateProtocol>...</privateProtocol>
      <publicPort>...</publicPort>
      <privatePort>...</privatePort>
    </portMappings>
    <componentNics>
      <id>...</id>
      <accessMode>...</accessMode>
      <addressMode>...</addressMode>
      <staticIp>...</staticIp>
      <mac>...</mac>
      <hostName>...</hostName>
      <portForwardPairs/>
    </componentNics>
    <serviceComponentSettings>
      <id>...</id>
      <requestAttributes/>
      <groups/>
      <formElements/>
      <resources/>
    </serviceComponentSettings>
    <completionWorkflow>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </completionWorkflow>
    <cloudTemplateUrl>...</cloudTemplateUrl>
    <cloudTemplateBody>...</cloudTemplateBody>
    <cloudTemplateParameters>
      <name>...</name>
      <description>...</description>
      <defaultValue>...</defaultValue>
      <noEcho>...</noEcho>
      <value>...</value>
      <id>...</id>
      <type>...</type>
      <allowedValues>...</allowedValues>
    </cloudTemplateParameters>
    <targetType>...</targetType>
    <capabilities>...</capabilities>
    <capabilitiesReason>...</capabilitiesReason>
  </serviceComponents>
  <categories xsitype="...">
    <id>...</id>
    <name>...</name>
    <serviceCount>...</serviceCount>
  </categories>
  <externalRouterStaticallyAssigned>...</externalRouterStaticallyAssigned>
  <internalRouterIp>...</internalRouterIp>
  <internalRouterSubnet>...</internalRouterSubnet>
  <appliedPlacementAttributes xsitype="...">
    <placementAttribute>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </placementAttribute>
    <allowedValues>...</allowedValues>
  </appliedPlacementAttributes>
  <cloudTemplateDeployType>...</cloudTemplateDeployType>
  <serviceFormIncluded>...</serviceFormIncluded>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</PublishedService>

                
              

POST /webservices/services/rest/v2/publishedservices/{id}/action/publish

Edit a published service state (publish/unpublish).

Request Parameters
name type description constraints
id path the id long
Request Body
media type data type description
application/xml CatalogConfig (XML) the state
Response Body
media type data type description
application/xml PublishedService (XML) the WS published service

Example

Request
POST /webservices/services/rest/v2/publishedservices/{id}/action/publish
Content-Type: application/xml
Accept: application/xml

                
<CatalogConfig xsitype="...">
  <ServiceUsers xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </ServiceUsers>
  <publishState>...</publishState>
</CatalogConfig>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<PublishedService>
  <serviceType>...</serviceType>
  <useStaticComponentForms>...</useStaticComponentForms>
  <resourceSummary>
    <totalCost>...</totalCost>
    <totalOsCost>...</totalOsCost>
    <totalCpuCost>...</totalCpuCost>
    <totalMemoryCost>...</totalMemoryCost>
    <totalDiskCost>...</totalDiskCost>
    <totalSupportCost>...</totalSupportCost>
    <totalExtraCost>...</totalExtraCost>
    <totalCpu>...</totalCpu>
    <totalMemory>...</totalMemory>
    <totalDisk>...</totalDisk>
    <totalCategorizedCosts>...</totalCategorizedCosts>
  </resourceSummary>
  <deployType>...</deployType>
  <name>...</name>
  <namingFormat>...</namingFormat>
  <iconId>...</iconId>
  <useDefaultNamingFormat>...</useDefaultNamingFormat>
  <highlyAvailable>...</highlyAvailable>
  <fenced>...</fenced>
  <startDeployedComponents>...</startDeployedComponents>
  <description>...</description>
  <serviceDeployable>...</serviceDeployable>
  <completionWorkflowId>...</completionWorkflowId>
  <retired>...</retired>
  <publishState>...</publishState>
  <serviceUsers xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </serviceUsers>
  <organizations xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organizations>
  <serviceComponents xsitype="...">
    <id>...</id>
    <cost>...</cost>
    <namingFormat>...</namingFormat>
    <useDefaultNamingFormat>...</useDefaultNamingFormat>
    <service>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </service>
    <linkedClone>...</linkedClone>
    <template>...</template>
    <group>...</group>
    <name>...</name>
    <description>...</description>
    <componentType>
      <id>...</id>
      <name>...</name>
      <description>...</description>
      <cost>...</cost>
    </componentType>
    <ref>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </ref>
    <serviceProperties>...</serviceProperties>
    <customizationSpecName>...</customizationSpecName>
    <instanceTypes>...</instanceTypes>
    <snapshot>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </snapshot>
    <availabilitySet>...</availabilitySet>
    <iamRole>...</iamRole>
    <pushMemoryMetrics>...</pushMemoryMetrics>
    <portMappings>
      <name>...</name>
      <publicProtocol>...</publicProtocol>
      <privateProtocol>...</privateProtocol>
      <publicPort>...</publicPort>
      <privatePort>...</privatePort>
    </portMappings>
    <componentNics>
      <id>...</id>
      <accessMode>...</accessMode>
      <addressMode>...</addressMode>
      <staticIp>...</staticIp>
      <mac>...</mac>
      <hostName>...</hostName>
      <portForwardPairs/>
    </componentNics>
    <serviceComponentSettings>
      <id>...</id>
      <requestAttributes/>
      <groups/>
      <formElements/>
      <resources/>
    </serviceComponentSettings>
    <completionWorkflow>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </completionWorkflow>
    <cloudTemplateUrl>...</cloudTemplateUrl>
    <cloudTemplateBody>...</cloudTemplateBody>
    <cloudTemplateParameters>
      <name>...</name>
      <description>...</description>
      <defaultValue>...</defaultValue>
      <noEcho>...</noEcho>
      <value>...</value>
      <id>...</id>
      <type>...</type>
      <allowedValues>...</allowedValues>
    </cloudTemplateParameters>
    <targetType>...</targetType>
    <capabilities>...</capabilities>
    <capabilitiesReason>...</capabilitiesReason>
  </serviceComponents>
  <categories xsitype="...">
    <id>...</id>
    <name>...</name>
    <serviceCount>...</serviceCount>
  </categories>
  <externalRouterStaticallyAssigned>...</externalRouterStaticallyAssigned>
  <internalRouterIp>...</internalRouterIp>
  <internalRouterSubnet>...</internalRouterSubnet>
  <appliedPlacementAttributes xsitype="...">
    <placementAttribute>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </placementAttribute>
    <allowedValues>...</allowedValues>
  </appliedPlacementAttributes>
  <cloudTemplateDeployType>...</cloudTemplateDeployType>
  <serviceFormIncluded>...</serviceFormIncluded>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</PublishedService>

                
              

POST /webservices/services/rest/v2/publishedservices/{id}/action/request

This method has been deprecated.

Request a published service.

Request Parameters
name type description constraints
id path the published service Id long
Request Body
media type data type description
application/xml PSDeployParamCollection (XML) the deployment parameters
Response Body
media type data type description
text/xml anyType (XML) the HTTP response

Example

Request
POST /webservices/services/rest/v2/publishedservices/{id}/action/request
Content-Type: application/xml
Accept: text/xml

                
<PSDeployParamCollection>
  <componentParams>
    <componentName>...</componentName>
    <formElements>
      <RequestFormElements/>
    </formElements>
  </componentParams>
  <serviceformElements>
    <RequestFormElements>
      <label>...</label>
      <mandatory>...</mandatory>
      <formType>...</formType>
      <value>...</value>
    </RequestFormElements>
  </serviceformElements>
</PSDeployParamCollection>

                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

POST /webservices/services/rest/v2/publishedservices/{id}/action/submit

Request a published service.

Request Parameters
name type description constraints
id path the published service Id long
Request Body
media type data type description
application/xml PSDeployParamCollection (XML) the deployment parameters
Response Body
media type data type description
text/xml Request (XML) the submitted request DTO

Example

Request
POST /webservices/services/rest/v2/publishedservices/{id}/action/submit
Content-Type: application/xml
Accept: text/xml

                
<PSDeployParamCollection>
  <componentParams>
    <componentName>...</componentName>
    <formElements>
      <RequestFormElements/>
    </formElements>
  </componentParams>
  <serviceformElements>
    <RequestFormElements>
      <label>...</label>
      <mandatory>...</mandatory>
      <formType>...</formType>
      <value>...</value>
    </RequestFormElements>
  </serviceformElements>
</PSDeployParamCollection>

                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
<Request>
  <id>...</id>
  <organization xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organization>
  <state>...</state>
  <type>...</type>
  <requestDate>...</requestDate>
  <fulfillDate>...</fulfillDate>
  <formVersion>...</formVersion>
  <requester>...</requester>
  <assignedAdmin>...</assignedAdmin>
  <waitingOn>...</waitingOn>
  <requiredBy>...</requiredBy>
  <targetService xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </targetService>
  <duration>...</duration>
  <requestFailed>...</requestFailed>
</Request>

                
              

GET /webservices/services/rest/v2/publishedservices/{id}/metadata/newrequestparams

Retrieve the parameters needed for a single-service request. All of these must be filled out to submit the request successfully.

Request Parameters
name type description constraints
id path The id of the published service that you wish to submit a request for long
Response Body
media type data type description
application/xml PSDeployParamCollection (XML) the PS new request requirement

Example

Request
GET /webservices/services/rest/v2/publishedservices/{id}/metadata/newrequestparams
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<PSDeployParamCollection>
  <componentParams>
    <componentName>...</componentName>
    <formElements>
      <RequestFormElements/>
    </formElements>
  </componentParams>
  <serviceformElements>
    <RequestFormElements>
      <label>...</label>
      <mandatory>...</mandatory>
      <formType>...</formType>
      <value>...</value>
    </RequestFormElements>
  </serviceformElements>
</PSDeployParamCollection>

                
              

POST /webservices/services/rest/v2/publishedservices/action/request

This method has been deprecated.

Request multiple published services.

Request Body
media type data type description
application/xml MultiplePSDeployParamCollection (XML) the deployment parameters
Response Body
media type data type description
application/xml anyType (XML) the HTTP response

Example

Request
POST /webservices/services/rest/v2/publishedservices/action/request
Content-Type: application/xml
Accept: application/xml

                
<MultiplePSDeployParamCollection>
  <publishedServiceMap>...</publishedServiceMap>
</MultiplePSDeployParamCollection>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
...
                
              

POST /webservices/services/rest/v2/publishedservices/action/submit

Request multiple published services.

Request Body
media type data type description
application/xml MultiplePSDeployParamCollection (XML) the deployment parameters
Response Body
media type data type description
application/xml Request (XML) the collection of submitted requests

Example

Request
POST /webservices/services/rest/v2/publishedservices/action/submit
Content-Type: application/xml
Accept: application/xml

                
<MultiplePSDeployParamCollection>
  <publishedServiceMap>...</publishedServiceMap>
</MultiplePSDeployParamCollection>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<Request>
  <id>...</id>
  <organization xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organization>
  <state>...</state>
  <type>...</type>
  <requestDate>...</requestDate>
  <fulfillDate>...</fulfillDate>
  <formVersion>...</formVersion>
  <requester>...</requester>
  <assignedAdmin>...</assignedAdmin>
  <waitingOn>...</waitingOn>
  <requiredBy>...</requiredBy>
  <targetService xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </targetService>
  <duration>...</duration>
  <requestFailed>...</requestFailed>
</Request>

                
              

GET /webservices/services/rest/v2/publishedservices/metadata/newrequestparams

Retrieve the parameters needed for a multi-service request.

Request Parameters
name type description constraints multivalued
psid query the input list long yes
Response Body
media type data type description
application/xml MultiplePSDeployParamCollection (XML) the multiple ps new request requirement

Example

Request
GET /webservices/services/rest/v2/publishedservices/metadata/newrequestparams
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<MultiplePSDeployParamCollection>
  <publishedServiceMap>...</publishedServiceMap>
</MultiplePSDeployParamCollection>

                
              

GET /webservices/services/rest/v2/publishedservices/name/{ps_name}

Retrieve a published service by name.

Request Parameters
name type description
ps_name path the url encoded ps name
Response Body
media type data type description
application/xml PublishedService (XML) the WS published service by name

Example

Request
GET /webservices/services/rest/v2/publishedservices/name/{ps_name}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<PublishedService>
  <serviceType>...</serviceType>
  <useStaticComponentForms>...</useStaticComponentForms>
  <resourceSummary>
    <totalCost>...</totalCost>
    <totalOsCost>...</totalOsCost>
    <totalCpuCost>...</totalCpuCost>
    <totalMemoryCost>...</totalMemoryCost>
    <totalDiskCost>...</totalDiskCost>
    <totalSupportCost>...</totalSupportCost>
    <totalExtraCost>...</totalExtraCost>
    <totalCpu>...</totalCpu>
    <totalMemory>...</totalMemory>
    <totalDisk>...</totalDisk>
    <totalCategorizedCosts>...</totalCategorizedCosts>
  </resourceSummary>
  <deployType>...</deployType>
  <name>...</name>
  <namingFormat>...</namingFormat>
  <iconId>...</iconId>
  <useDefaultNamingFormat>...</useDefaultNamingFormat>
  <highlyAvailable>...</highlyAvailable>
  <fenced>...</fenced>
  <startDeployedComponents>...</startDeployedComponents>
  <description>...</description>
  <serviceDeployable>...</serviceDeployable>
  <completionWorkflowId>...</completionWorkflowId>
  <retired>...</retired>
  <publishState>...</publishState>
  <serviceUsers xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </serviceUsers>
  <organizations xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organizations>
  <serviceComponents xsitype="...">
    <id>...</id>
    <cost>...</cost>
    <namingFormat>...</namingFormat>
    <useDefaultNamingFormat>...</useDefaultNamingFormat>
    <service>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </service>
    <linkedClone>...</linkedClone>
    <template>...</template>
    <group>...</group>
    <name>...</name>
    <description>...</description>
    <componentType>
      <id>...</id>
      <name>...</name>
      <description>...</description>
      <cost>...</cost>
    </componentType>
    <ref>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </ref>
    <serviceProperties>...</serviceProperties>
    <customizationSpecName>...</customizationSpecName>
    <instanceTypes>...</instanceTypes>
    <snapshot>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </snapshot>
    <availabilitySet>...</availabilitySet>
    <iamRole>...</iamRole>
    <pushMemoryMetrics>...</pushMemoryMetrics>
    <portMappings>
      <name>...</name>
      <publicProtocol>...</publicProtocol>
      <privateProtocol>...</privateProtocol>
      <publicPort>...</publicPort>
      <privatePort>...</privatePort>
    </portMappings>
    <componentNics>
      <id>...</id>
      <accessMode>...</accessMode>
      <addressMode>...</addressMode>
      <staticIp>...</staticIp>
      <mac>...</mac>
      <hostName>...</hostName>
      <portForwardPairs/>
    </componentNics>
    <serviceComponentSettings>
      <id>...</id>
      <requestAttributes/>
      <groups/>
      <formElements/>
      <resources/>
    </serviceComponentSettings>
    <completionWorkflow>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </completionWorkflow>
    <cloudTemplateUrl>...</cloudTemplateUrl>
    <cloudTemplateBody>...</cloudTemplateBody>
    <cloudTemplateParameters>
      <name>...</name>
      <description>...</description>
      <defaultValue>...</defaultValue>
      <noEcho>...</noEcho>
      <value>...</value>
      <id>...</id>
      <type>...</type>
      <allowedValues>...</allowedValues>
    </cloudTemplateParameters>
    <targetType>...</targetType>
    <capabilities>...</capabilities>
    <capabilitiesReason>...</capabilitiesReason>
  </serviceComponents>
  <categories xsitype="...">
    <id>...</id>
    <name>...</name>
    <serviceCount>...</serviceCount>
  </categories>
  <externalRouterStaticallyAssigned>...</externalRouterStaticallyAssigned>
  <internalRouterIp>...</internalRouterIp>
  <internalRouterSubnet>...</internalRouterSubnet>
  <appliedPlacementAttributes xsitype="...">
    <placementAttribute>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </placementAttribute>
    <allowedValues>...</allowedValues>
  </appliedPlacementAttributes>
  <cloudTemplateDeployType>...</cloudTemplateDeployType>
  <serviceFormIncluded>...</serviceFormIncluded>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</PublishedService>

                
              

GET /webservices/services/rest/v2/references/organizations

Retrieve a list of organization references.

Request Parameters
name type description default constraints
max query The maximum number of entries to retrieve. 100 int
name query The name of the organization.    
offset query The index of the first item to return from the result set. Use in combination with maxCount to retrieve in batches. Defaults to 0. 0 int
Response Body
media type data type description
application/xml ManagedObjectReferenceCollection (XML) returns the collection of organization references. An empty collection is return if none are found.

Example

Request
GET /webservices/services/rest/v2/references/organizations
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ManagedObjectReferenceCollection>
  <ManagedObjectReferences xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ManagedObjectReferences>
</ManagedObjectReferenceCollection>

                
              

GET /webservices/services/rest/v2/references/publishedservices

Retrieve a collection of published services

Request Parameters
name type description default
name query of the published service
Response Body
media type data type description
application/xml ManagedObjectReferenceCollection (XML) the published services

Example

Request
GET /webservices/services/rest/v2/references/publishedservices
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ManagedObjectReferenceCollection>
  <ManagedObjectReferences xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ManagedObjectReferences>
</ManagedObjectReferenceCollection>

                
              

GET /webservices/services/rest/v2/references/stacks

Retrieve a list of Stack references, sorted by their ID.

Request Parameters
name type description default constraints
max query Maximum number of VMs to return. Defaults to 100. Use -1 to have no maximum. 100 int
msid query (Optional) ID of the management server - only VMs on this management server will be returned -1 long
offset query The index of the first item to return from the result set. Use in combination with maxCount to retrieve in batches. Defaults to 0. 0 int
orgName query (Optional) The organization name, which owns the VM.    
primaryOwnerLogin query (Optional) Login ID of the primary owner  
regionId query (Optional) ID of the region - only VMs in this region will be returned -1 long
remoteId query (Optional) Remote ID of the stack - only the stack with this remote ID will be returned    
stackName query (Optional) Name of the Stack - only Stacks matching this name will be returned    
Response Body
media type data type description
application/xml ManagedObjectReferenceCollection (XML) Collection of managed object references that match the specified query parameters

Example

Request
GET /webservices/services/rest/v2/references/stacks
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ManagedObjectReferenceCollection>
  <ManagedObjectReferences xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ManagedObjectReferences>
</ManagedObjectReferenceCollection>

                
              

GET /webservices/services/rest/v2/references/vms

Retrieve a list of VM references, sorted by their ID.

Request Parameters
name type description default constraints
dcid query (Optional) ID of the datacenter - only VMs in this datacenter will be returned -1 long
hostid query (Optional) ID of the host - only VMs running on this host will be returned -1 long
max query Maximum number of VMs to return. Defaults to 100. Use -1 to have no maximum. 100 int
msid query (Optional) ID of the management server - only VMs on this management server will be returned -1 long
offset query The index of the first item to return from the result set. Use in combination with maxCount to retrieve in batches. Defaults to 0. 0 int
orgName query (Optional) The organization name, which owns the VM.    
parentid query (Optional) ID of the parent - only VMs in this parent will be returend. For VMware, this is the parent folder. -1 long
primaryOwnerLogin query (Optional) Login ID of the primary owner  
vmname query (Optional) Name of the VM - only VMs matching this name will be returned    
Response Body
media type data type description
application/xml ManagedObjectReferenceCollection (XML) Collection of managed object references that match the specified query parameters

Example

Request
GET /webservices/services/rest/v2/references/vms
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ManagedObjectReferenceCollection>
  <ManagedObjectReferences xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ManagedObjectReferences>
</ManagedObjectReferenceCollection>

                
              

GET /webservices/services/rest/v2/regions

Retrieve regions.

Request Parameters
name type description default constraints
max query the max 100 int
projectid query the project id -1 long
Response Body
media type data type description
application/xml ManagedObjectReferenceCollection (XML) the regions

Example

Request
GET /webservices/services/rest/v2/regions
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ManagedObjectReferenceCollection>
  <ManagedObjectReferences xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ManagedObjectReferences>
</ManagedObjectReferenceCollection>

                
              

GET /webservices/services/rest/v2/regions/{id}

Retrieve region by Id.

Request Parameters
name type description default constraints
id path the id -1 long
Response Body
media type data type description
application/xml Region (XML) the region

Example

Request
GET /webservices/services/rest/v2/regions/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<Region>
  <securityGroups xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </securityGroups>
  <instanceTypes>
    <id>...</id>
    <managementServerType>...</managementServerType>
    <instanceFamily>...</instanceFamily>
    <instanceType>...</instanceType>
    <description>...</description>
    <name>...</name>
    <processorArch>...</processorArch>
    <vcpu>...</vcpu>
    <ecu>...</ecu>
    <memory>...</memory>
    <storage>...</storage>
    <instanceStorage>...</instanceStorage>
    <ebsOptimizedAvailable>...</ebsOptimizedAvailable>
    <networkPerformance>...</networkPerformance>
    <maxENIs>...</maxENIs>
    <maxIPsPerENI>...</maxIPsPerENI>
    <availableForSpotInstance>...</availableForSpotInstance>
  </instanceTypes>
  <VirtualClouds xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </VirtualClouds>
  <keyPairs xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </keyPairs>
  <ec2ClassicCloud xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ec2ClassicCloud>
  <parent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </parent>
  <childType>...</childType>
  <reference/>
  <managementServer/>
  <connected>...</connected>
  <remoteId>...</remoteId>
  <name>...</name>
  <operationalParent/>
  <deployedParent/>
  <repositoryParent/>
  <datastoreParent/>
  <attributes/>
  <expiryGroup/>
  <groups/>
  <managementServerType>...</managementServerType>
</Region>

                
              

GET /webservices/services/rest/v2/regions/{id}/availabilityzones

Get availability zone avaialble to a region.

Request Parameters
name type description default constraints
id path the region id -1 long
Response Body
media type data type description
application/xml ManagedObjectReferenceCollection (XML) the availability zones

Example

Request
GET /webservices/services/rest/v2/regions/{id}/availabilityzones
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ManagedObjectReferenceCollection>
  <ManagedObjectReferences xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ManagedObjectReferences>
</ManagedObjectReferenceCollection>

                
              

GET /webservices/services/rest/v2/regions/{id}/subnets

Get subnets available to a region.

Request Parameters
name type description default constraints
id path the region id -1 long
Response Body
media type data type description
application/xml ManagedObjectReferenceCollection (XML) the region subnets

Example

Request
GET /webservices/services/rest/v2/regions/{id}/subnets
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ManagedObjectReferenceCollection>
  <ManagedObjectReferences xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ManagedObjectReferences>
</ManagedObjectReferenceCollection>

                
              

POST /webservices/services/rest/v2/regions/{id}/subnets/{subnetid}/action/applynetworkzone

Apply network zone tag to network region subnet.

Request Parameters
name type description default constraints
id path the region id -1 long
subnetid path the subnet id -1 long
Request Body
media type data type description
application/xml NetworkZone (XML) the network zone tag
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/regions/{id}/subnets/{subnetid}/action/applynetworkzone
Content-Type: application/xml
Accept: text/xml

                
<NetworkZone xsitype="...">
  <id>...</id>
  <name>...</name>
</NetworkZone>

                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/regions/{id}/virtualclouds/{vcid}/securitygroups

Get security groups available to a virtual cloud.

Request Parameters
name type description default constraints
id path the region id -1 long
vcid path the virtual cloud id -1 long
Response Body
media type data type description
application/xml ManagedObjectReferenceCollection (XML) the virtual cloud security groups

Example

Request
GET /webservices/services/rest/v2/regions/{id}/virtualclouds/{vcid}/securitygroups
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ManagedObjectReferenceCollection>
  <ManagedObjectReferences xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ManagedObjectReferences>
</ManagedObjectReferenceCollection>

                
              

GET /webservices/services/rest/v2/regions/{id}/virtualclouds/{vcid}/subnets

Get subnets available to a virtual cloud.

Request Parameters
name type description default constraints
id path the region id -1 long
vcid path the virtual cloud id -1 long
Response Body
media type data type description
application/xml ManagedObjectReferenceCollection (XML) the virtual cloud subnets

Example

Request
GET /webservices/services/rest/v2/regions/{id}/virtualclouds/{vcid}/subnets
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ManagedObjectReferenceCollection>
  <ManagedObjectReferences xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ManagedObjectReferences>
</ManagedObjectReferenceCollection>

                
              

POST /webservices/services/rest/v2/regions/{id}/virtualclouds/{vcid}/subnets/{subnetid}/action/applynetworkzone

Apply network zone tag to virtual cloud subnet.

Request Parameters
name type description default constraints
id path the region id -1 long
subnetid path the subnet id -1 long
vcid path the virtual cloud id -1 long
Request Body
media type data type description
application/xml NetworkZone (XML) the network zone tag
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/regions/{id}/virtualclouds/{vcid}/subnets/{subnetid}/action/applynetworkzone
Content-Type: application/xml
Accept: text/xml

                
<NetworkZone xsitype="...">
  <id>...</id>
  <name>...</name>
</NetworkZone>

                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/remoteaccess/{key}

Retrieve the remote access connection settings.

Request Parameters
name type description
key path the key
Response Body
media type data type description
application/xml RemoteAccessSettings (XML) the remote access settings

Example

Request
GET /webservices/services/rest/v2/remoteaccess/{key}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RemoteAccessSettings>
  <host>...</host>
  <port>...</port>
  <token>...</token>
  <url>...</url>
  <credentials>
    <username>...</username>
    <password>...</password>
    <category>...</category>
    <description>...</description>
    <name>...</name>
    <keyPairName>...</keyPairName>
    <rsa>...</rsa>
    <credentialFormat>...</credentialFormat>
  </credentials>
  <protocol>...</protocol>
  <vmName>...</vmName>
</RemoteAccessSettings>

                
              

GET /webservices/services/rest/v2/requests

Retrieve a collection of service requests. Default max is 100.

Response Body
media type data type description
application/xml RequestCollection (XML) the requests

Example

Request
GET /webservices/services/rest/v2/requests
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RequestCollection>
  <Requests>
    <id>...</id>
    <organization>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organization>
    <state>...</state>
    <type>...</type>
    <requestDate>...</requestDate>
    <fulfillDate>...</fulfillDate>
    <formVersion>...</formVersion>
    <requester>...</requester>
    <assignedAdmin>...</assignedAdmin>
    <waitingOn>...</waitingOn>
    <requiredBy>...</requiredBy>
    <targetService>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </targetService>
    <duration>...</duration>
    <requestFailed>...</requestFailed>
  </Requests>
</RequestCollection>

                
              

GET /webservices/services/rest/v2/requests/{key}

Gets a specific request by its id or get the request counts when using /requests/count

Response Body
media type data type description
application/xml anyType (XML) Returns the specific request or the total number of requests

Example

Request
GET /webservices/services/rest/v2/requests/{key}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
...
                
              

POST /webservices/services/rest/v2/requests/{request_id}/action/addcomment

Add a comment to the specified request.

Request Parameters
name type description constraints
request_id path the request id long
Request Body
media type data type description
text/plain (custom) the comment
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/requests/{request_id}/action/addcomment
Content-Type: text/plain
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

POST /webservices/services/rest/v2/requests/{request_id}/action/approve

Approve a request.

Request Parameters
name type description constraints
request_id path the request id long
Request Body
media type data type description
text/plain (custom) the comment
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/requests/{request_id}/action/approve
Content-Type: text/plain
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

POST /webservices/services/rest/v2/requests/{request_id}/action/assign

Assign a user to a request.

Request Parameters
name type description constraints
request_id path the request id long
Request Body
media type data type description
application/xml RequestAssignment (XML) the assignment
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/requests/{request_id}/action/assign
Content-Type: application/xml
Accept: text/xml

                
<RequestAssignment xsitype="...">
  <userLoginId>...</userLoginId>
  <comment>...</comment>
</RequestAssignment>

                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

POST /webservices/services/rest/v2/requests/{request_id}/action/copy

Copy a request.

Request Parameters
name type description constraints
request_id path the source request id long
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/requests/{request_id}/action/copy
Content-Type: text/plain
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

POST /webservices/services/rest/v2/requests/{request_id}/action/fulfillchanges

Fulfill the specified change request.

Request Parameters
name type description constraints
request_id path the request id long
Request Body
media type data type description
application/xml RequestFormElementCollection (XML) the form element collection
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/requests/{request_id}/action/fulfillchanges
Content-Type: application/xml
Accept: text/xml

                
<RequestFormElementCollection>
  <RequestFormElements xsitype="...">
    <label>...</label>
    <mandatory>...</mandatory>
    <formType>...</formType>
    <value>...</value>
  </RequestFormElements>
</RequestFormElementCollection>

                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

POST /webservices/services/rest/v2/requests/{request_id}/action/linkvm

Link a VM to the specified service request.

Request Parameters
name type description constraints
request_id path the request id long
Request Body
media type data type description
application/xml ServiceRequestLink (XML) the sr link
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/requests/{request_id}/action/linkvm
Content-Type: application/xml
Accept: text/xml

                
<ServiceRequestLink xsitype="...">
  <VMId>...</VMId>
  <releaseVM>...</releaseVM>
  <comment>...</comment>
</ServiceRequestLink>

                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

POST /webservices/services/rest/v2/requests/{request_id}/action/reject

Reject a request.

Request Parameters
name type description default constraints
request_id path the request id   long
wfid query The optional Id of a command workflow to execute on all deployed targets -1 long
Request Body
media type data type description
text/plain (custom) the comment
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/requests/{request_id}/action/reject
Content-Type: text/plain
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

POST /webservices/services/rest/v2/requests/{request_id}/action/release

Release the VM (mark the specified request as completed).

Request Parameters
name type description constraints
request_id path the request id long
Request Body
media type data type description
text/plain (custom) the comment
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/requests/{request_id}/action/release
Content-Type: text/plain
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

POST /webservices/services/rest/v2/requests/{request_id}/action/schedulechanges/{timestamp}

Schedule fulfillment of the specified change request.

Request Parameters
name type description constraints
request_id path the request id long
timestamp path the timestamp in utc  
Request Body
media type data type description
application/xml RequestFormElementCollection (XML) the form element collection
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/requests/{request_id}/action/schedulechanges/{timestamp}
Content-Type: application/xml
Accept: text/xml

                
<RequestFormElementCollection>
  <RequestFormElements xsitype="...">
    <label>...</label>
    <mandatory>...</mandatory>
    <formType>...</formType>
    <value>...</value>
  </RequestFormElements>
</RequestFormElementCollection>

                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/requests/{request_id}/metadata/comments

Retrieve all comments associated with the specified request

Request Parameters
name type description constraints
request_id path the request id long
Response Body
media type data type description
application/xml CommentCollection (XML) the comment fo request

Example

Request
GET /webservices/services/rest/v2/requests/{request_id}/metadata/comments
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<CommentCollection>
  <Comments>
    <userText>...</userText>
    <author>...</author>
    <timestamp>...</timestamp>
    <systemGeneratedText>...</systemGeneratedText>
  </Comments>
</CommentCollection>

                
              

GET /webservices/services/rest/v2/requests/{request_id}/metadata/form

Retrieves form details for change request.

Request Parameters
name type description constraints
request_id path the request id long
Response Body
media type data type description
application/xml RequestFormElementCollection (XML) the change request form details

Example

Request
GET /webservices/services/rest/v2/requests/{request_id}/metadata/form
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RequestFormElementCollection>
  <RequestFormElements xsitype="...">
    <label>...</label>
    <mandatory>...</mandatory>
    <formType>...</formType>
    <value>...</value>
  </RequestFormElements>
</RequestFormElementCollection>

                
              

GET /webservices/services/rest/v2/requests/{request_id}/rservices

Retrieve a collection of requested services for this request.

Request Parameters
name type description constraints
request_id path the request id long
Response Body
media type data type description
application/xml RequestedServiceCollection (XML) the requested services

Example

Request
GET /webservices/services/rest/v2/requests/{request_id}/rservices
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RequestedServiceCollection>
  <RequestedServices>
    <id>...</id>
    <publishedServiceId>...</publishedServiceId>
    <name>...</name>
    <description>...</description>
    <state>...</state>
    <deployedService>
      <name>...</name>
      <completionWorkflow/>
      <components/>
      <target/>
    </deployedService>
  </RequestedServices>
</RequestedServiceCollection>

                
              

GET /webservices/services/rest/v2/requests/{request_id}/rservices/{service_id}

Retrieves the specific requested service as specified by the id.

Request Parameters
name type description constraints
request_id path the request id long
service_id path the requested service id long
Response Body
media type data type description
application/xml RequestedService (XML) the requested service by id

Example

Request
GET /webservices/services/rest/v2/requests/{request_id}/rservices/{service_id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RequestedService>
  <id>...</id>
  <publishedServiceId>...</publishedServiceId>
  <name>...</name>
  <description>...</description>
  <state>...</state>
  <deployedService>
    <name>...</name>
    <completionWorkflow>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </completionWorkflow>
    <components>
      <id>...</id>
      <target/>
      <completionWorkflow/>
    </components>
    <target>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </target>
  </deployedService>
</RequestedService>

                
              

POST /webservices/services/rest/v2/requests/{request_id}/rservices/{service_id}/action/deploy

Deploy the specified requested service.

Request Parameters
name type description constraints
request_id path the request id long
service_id path the requested service id long
Request Body
media type data type description
application/xml DeploymentParams (XML) the deploy params
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/requests/{request_id}/rservices/{service_id}/action/deploy
Content-Type: application/xml
Accept: text/xml

                
<DeploymentParams xsitype="...">
  <CustomAttributes>
    <allowedValues>...</allowedValues>
    <portalEditable>...</portalEditable>
    <enumerated>...</enumerated>
    <description>...</description>
    <targetManagedObjectTypes>...</targetManagedObjectTypes>
    <name>...</name>
    <value>...</value>
    <costItems/>
    <regularExpression>...</regularExpression>
    <validationMessage>...</validationMessage>
  </CustomAttributes>
  <expiryDate>...</expiryDate>
  <ownership xsitype="...">
    <organization>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organization>
    <Owners>
      <id>...</id>
      <loginId>...</loginId>
      <displayName>...</displayName>
      <email>...</email>
      <itContact>...</itContact>
      <primary>...</primary>
    </Owners>
  </ownership>
  <memoryInMB>...</memoryInMB>
  <numCPU>...</numCPU>
  <releaseTarget>...</releaseTarget>
  <releaseTargetComment>...</releaseTargetComment>
  <datastoreName>...</datastoreName>
  <targetHostName>...</targetHostName>
  <resourcePoolName>...</resourcePoolName>
  <folderName>...</folderName>
  <snapshotId>...</snapshotId>
  <approved>...</approved>
  <suspect>...</suspect>
  <endOfLife>...</endOfLife>
  <createLinkedClone>...</createLinkedClone>
  <highAvailability>...</highAvailability>
  <powerOn>...</powerOn>
  <name>...</name>
  <clusterName>...</clusterName>
  <managementServerName>...</managementServerName>
  <datacenterName>...</datacenterName>
  <nics>
    <macAddress>...</macAddress>
    <adapterType>...</adapterType>
    <uniqueNetId>...</uniqueNetId>
    <logicalNetwork>...</logicalNetwork>
    <name>...</name>
    <addressType>...</addressType>
    <id>...</id>
    <summary>...</summary>
    <uuid>...</uuid>
    <vmId>...</vmId>
    <key>...</key>
    <label>...</label>
    <connected>...</connected>
    <startConnected>...</startConnected>
  </nics>
</DeploymentParams>

                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/requests/{request_id}/rservices/{service_id}/components

Retrieve the collection of requested components for the requested service.

Request Parameters
name type description constraints
request_id path the request id long
service_id path the requested service id long
Response Body
media type data type description
application/xml RequestedComponentCollection (XML) the requested components

Example

Request
GET /webservices/services/rest/v2/requests/{request_id}/rservices/{service_id}/components
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RequestedComponentCollection>
  <RequestedComponents>
    <id>...</id>
    <name>...</name>
    <description>...</description>
    <state>...</state>
    <requestedServiceId>...</requestedServiceId>
    <deployedComponent>
      <id>...</id>
      <target/>
      <completionWorkflow/>
    </deployedComponent>
  </RequestedComponents>
</RequestedComponentCollection>

                
              

GET /webservices/services/rest/v2/requests/{request_id}/rservices/{service_id}/components/{component_id}

Retrieves the specific requested component as specified by the id.

Request Parameters
name type description constraints
component_id path the requested component id long
request_id path the request id long
service_id path the requested service id long
Response Body
media type data type description
application/xml RequestedComponent (XML) the requested component by id

Example

Request
GET /webservices/services/rest/v2/requests/{request_id}/rservices/{service_id}/components/{component_id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RequestedComponent>
  <id>...</id>
  <name>...</name>
  <description>...</description>
  <state>...</state>
  <requestedServiceId>...</requestedServiceId>
  <deployedComponent>
    <id>...</id>
    <target>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </target>
    <completionWorkflow>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </completionWorkflow>
  </deployedComponent>
</RequestedComponent>

                
              

POST /webservices/services/rest/v2/requests/{request_id}/rservices/{service_id}/components/{component_id}/action/deploy

Deploy the specified requested service component.

Request Parameters
name type description constraints
component_id path the requested component id long
request_id path the request id long
service_id path the requested service id long
Request Body
media type data type description
application/xml DeploymentParams (XML) the deploy params
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/requests/{request_id}/rservices/{service_id}/components/{component_id}/action/deploy
Content-Type: application/xml
Accept: text/xml

                
<DeploymentParams xsitype="...">
  <CustomAttributes>
    <allowedValues>...</allowedValues>
    <portalEditable>...</portalEditable>
    <enumerated>...</enumerated>
    <description>...</description>
    <targetManagedObjectTypes>...</targetManagedObjectTypes>
    <name>...</name>
    <value>...</value>
    <costItems/>
    <regularExpression>...</regularExpression>
    <validationMessage>...</validationMessage>
  </CustomAttributes>
  <expiryDate>...</expiryDate>
  <ownership xsitype="...">
    <organization>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organization>
    <Owners>
      <id>...</id>
      <loginId>...</loginId>
      <displayName>...</displayName>
      <email>...</email>
      <itContact>...</itContact>
      <primary>...</primary>
    </Owners>
  </ownership>
  <memoryInMB>...</memoryInMB>
  <numCPU>...</numCPU>
  <releaseTarget>...</releaseTarget>
  <releaseTargetComment>...</releaseTargetComment>
  <datastoreName>...</datastoreName>
  <targetHostName>...</targetHostName>
  <resourcePoolName>...</resourcePoolName>
  <folderName>...</folderName>
  <snapshotId>...</snapshotId>
  <approved>...</approved>
  <suspect>...</suspect>
  <endOfLife>...</endOfLife>
  <createLinkedClone>...</createLinkedClone>
  <highAvailability>...</highAvailability>
  <powerOn>...</powerOn>
  <name>...</name>
  <clusterName>...</clusterName>
  <managementServerName>...</managementServerName>
  <datacenterName>...</datacenterName>
  <nics>
    <macAddress>...</macAddress>
    <adapterType>...</adapterType>
    <uniqueNetId>...</uniqueNetId>
    <logicalNetwork>...</logicalNetwork>
    <name>...</name>
    <addressType>...</addressType>
    <id>...</id>
    <summary>...</summary>
    <uuid>...</uuid>
    <vmId>...</vmId>
    <key>...</key>
    <label>...</label>
    <connected>...</connected>
    <startConnected>...</startConnected>
  </nics>
</DeploymentParams>

                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

POST /webservices/services/rest/v2/requests/{request_id}/rservices/{service_id}/components/{component_id}/action/release

Release a requested service component.

Request Parameters
name type description constraints
component_id path the requested component id long
request_id path the request id long
service_id path the requested service id long
Request Body
media type data type description
text/plain (custom) the comment
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/requests/{request_id}/rservices/{service_id}/components/{component_id}/action/release
Content-Type: text/plain
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/requests/{request_id}/rservices/{service_id}/components/{component_id}/metadata/form

Retrieves form details for the specified component.

Request Parameters
name type description constraints
component_id path the requested component id long
request_id path the request id long
service_id path the requested service id long
Response Body
media type data type description
application/xml RequestFormElementCollection (XML) the requested component form details

Example

Request
GET /webservices/services/rest/v2/requests/{request_id}/rservices/{service_id}/components/{component_id}/metadata/form
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RequestFormElementCollection>
  <RequestFormElements xsitype="...">
    <label>...</label>
    <mandatory>...</mandatory>
    <formType>...</formType>
    <value>...</value>
  </RequestFormElements>
</RequestFormElementCollection>

                
              

GET /webservices/services/rest/v2/requests/{request_id}/rservices/{service_id}/components/{component_id}/metadata/workflow

Retrieve workflows associated with the requested component. Does not include workflows for completed or rejected requests

Request Parameters
name type description constraints
component_id path the requested component id long
request_id path the request id long
service_id path the requested service id long
Response Body
media type data type description
application/xml RunningWorkflow (XML) the workflow for for requested component

Example

Request
GET /webservices/services/rest/v2/requests/{request_id}/rservices/{service_id}/components/{component_id}/metadata/workflow
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RunningWorkflow>
  <id>...</id>
  <definitionId>...</definitionId>
  <name>...</name>
  <currentStepNumber>...</currentStepNumber>
  <currentStepId>...</currentStepId>
  <currentStepName>...</currentStepName>
  <startTimestamp>...</startTimestamp>
  <completedTimestamp>...</completedTimestamp>
  <workflowType>...</workflowType>
  <initiator>...</initiator>
  <error>...</error>
  <steps xsitype="...">
    <name>...</name>
    <originalObjectId>...</originalObjectId>
  </steps>
  <users xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </users>
  <organization xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organization>
  <comments>
    <userText>...</userText>
    <author>...</author>
    <timestamp>...</timestamp>
    <systemGeneratedText>...</systemGeneratedText>
  </comments>
  <progress>...</progress>
  <target xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </target>
  <status>...</status>
  <request xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </request>
  <duration>...</duration>
  <addOwnerAsAdmin>...</addOwnerAsAdmin>
  <global>...</global>
  <autoDeploy>...</autoDeploy>
</RunningWorkflow>

                
              

GET /webservices/services/rest/v2/requests/{request_id}/rservices/{service_id}/metadata/form

Retrieves form details for the specified service.

Request Parameters
name type description constraints
request_id path the request id long
service_id path the requested service id long
Response Body
media type data type description
application/xml RequestFormElementCollection (XML) the requested service form details

Example

Request
GET /webservices/services/rest/v2/requests/{request_id}/rservices/{service_id}/metadata/form
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RequestFormElementCollection>
  <RequestFormElements xsitype="...">
    <label>...</label>
    <mandatory>...</mandatory>
    <formType>...</formType>
    <value>...</value>
  </RequestFormElements>
</RequestFormElementCollection>

                
              

GET /webservices/services/rest/v2/requests/{request_id}/rservices/{service_id}/metadata/workflow

Retrieve running workflows associated with the specified requested service. Does not include workflows for completed or rejected requests

Request Parameters
name type description constraints
request_id path the request id long
service_id path the requested service id long
Response Body
media type data type description
application/xml RunningWorkflow (XML) the completion workflow for requested service

Example

Request
GET /webservices/services/rest/v2/requests/{request_id}/rservices/{service_id}/metadata/workflow
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RunningWorkflow>
  <id>...</id>
  <definitionId>...</definitionId>
  <name>...</name>
  <currentStepNumber>...</currentStepNumber>
  <currentStepId>...</currentStepId>
  <currentStepName>...</currentStepName>
  <startTimestamp>...</startTimestamp>
  <completedTimestamp>...</completedTimestamp>
  <workflowType>...</workflowType>
  <initiator>...</initiator>
  <error>...</error>
  <steps xsitype="...">
    <name>...</name>
    <originalObjectId>...</originalObjectId>
  </steps>
  <users xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </users>
  <organization xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organization>
  <comments>
    <userText>...</userText>
    <author>...</author>
    <timestamp>...</timestamp>
    <systemGeneratedText>...</systemGeneratedText>
  </comments>
  <progress>...</progress>
  <target xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </target>
  <status>...</status>
  <request xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </request>
  <duration>...</duration>
  <addOwnerAsAdmin>...</addOwnerAsAdmin>
  <global>...</global>
  <autoDeploy>...</autoDeploy>
</RunningWorkflow>

                
              

GET /webservices/services/rest/v2/requests/{request_id}/workflow

Retrieve running workflows associated with the specified request. Does not include workflows for completed or rejected requests

Request Parameters
name type description constraints
request_id path the request id long
Response Body
media type data type description
application/xml RunningWorkflow (XML) the running workflow for request

Example

Request
GET /webservices/services/rest/v2/requests/{request_id}/workflow
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RunningWorkflow>
  <id>...</id>
  <definitionId>...</definitionId>
  <name>...</name>
  <currentStepNumber>...</currentStepNumber>
  <currentStepId>...</currentStepId>
  <currentStepName>...</currentStepName>
  <startTimestamp>...</startTimestamp>
  <completedTimestamp>...</completedTimestamp>
  <workflowType>...</workflowType>
  <initiator>...</initiator>
  <error>...</error>
  <steps xsitype="...">
    <name>...</name>
    <originalObjectId>...</originalObjectId>
  </steps>
  <users xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </users>
  <organization xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organization>
  <comments>
    <userText>...</userText>
    <author>...</author>
    <timestamp>...</timestamp>
    <systemGeneratedText>...</systemGeneratedText>
  </comments>
  <progress>...</progress>
  <target xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </target>
  <status>...</status>
  <request xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </request>
  <duration>...</duration>
  <addOwnerAsAdmin>...</addOwnerAsAdmin>
  <global>...</global>
  <autoDeploy>...</autoDeploy>
</RunningWorkflow>

                
              

POST /webservices/services/rest/v2/requests/action/subscribenotification

Subscribe to request notifications.

Request Body
media type data type description
text/plain (custom) the user login id
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/requests/action/subscribenotification
Content-Type: text/plain
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

POST /webservices/services/rest/v2/requests/action/unsubscribenotification

Unsubscribe from request notifications.

Request Body
media type data type description
text/plain (custom) the user login id
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/requests/action/unsubscribenotification
Content-Type: text/plain
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/requests/state/{request_state}

Get service requests in a specific state.

Request Parameters
name type description default constraints
request_state path the request state    
max query the max count 100 int
Response Body
media type data type description
application/xml RequestCollection (XML) the requests by state

Example

Request
GET /webservices/services/rest/v2/requests/state/{request_state}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RequestCollection>
  <Requests>
    <id>...</id>
    <organization>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organization>
    <state>...</state>
    <type>...</type>
    <requestDate>...</requestDate>
    <fulfillDate>...</fulfillDate>
    <formVersion>...</formVersion>
    <requester>...</requester>
    <assignedAdmin>...</assignedAdmin>
    <waitingOn>...</waitingOn>
    <requiredBy>...</requiredBy>
    <targetService>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </targetService>
    <duration>...</duration>
    <requestFailed>...</requestFailed>
  </Requests>
</RequestCollection>

                
              

GET /webservices/services/rest/v2/requests/type/{request_type}

Retrieve requests by type.

Request Parameters
name type description default constraints
request_type path the request type    
max query the max count 100 int
Response Body
media type data type description
application/xml RequestCollection (XML) the requests by type

Example

Request
GET /webservices/services/rest/v2/requests/type/{request_type}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RequestCollection>
  <Requests>
    <id>...</id>
    <organization>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organization>
    <state>...</state>
    <type>...</type>
    <requestDate>...</requestDate>
    <fulfillDate>...</fulfillDate>
    <formVersion>...</formVersion>
    <requester>...</requester>
    <assignedAdmin>...</assignedAdmin>
    <waitingOn>...</waitingOn>
    <requiredBy>...</requiredBy>
    <targetService>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </targetService>
    <duration>...</duration>
    <requestFailed>...</requestFailed>
  </Requests>
</RequestCollection>

                
              

GET /webservices/services/rest/v2/roles

Retrieve all the roles

Response Body
media type data type description
application/xml RoleCollectionWrapper (XML) all the roles

Example

Request
GET /webservices/services/rest/v2/roles
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RoleCollection>
  <roles xsitype="...">
    <type>...</type>
    <id>...</id>
    <name>...</name>
    <permissions>...</permissions>
  </roles>
</RoleCollection>

                
              

POST /webservices/services/rest/v2/roles

Create a role.

Request Body
media type data type description
application/xml Role (XML) - the role DTO
Response Body
media type data type description
application/xml Role (XML) the created role

Example

Request
POST /webservices/services/rest/v2/roles
Content-Type: application/xml
Accept: application/xml

                
<Role xsitype="...">
  <type>...</type>
  <id>...</id>
  <name>...</name>
  <permissions>...</permissions>
</Role>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<Role xsitype="...">
  <type>...</type>
  <id>...</id>
  <name>...</name>
  <permissions>...</permissions>
</Role>

                
              

DELETE /webservices/services/rest/v2/roles/{id}

Delete a role

Request Parameters
name type description default constraints
id path - the role Id -1 long
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
DELETE /webservices/services/rest/v2/roles/{id}
Content-Type: text/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/roles/{id}

Retrieve a role by Id.

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
application/xml Role (XML) the role

Example

Request
GET /webservices/services/rest/v2/roles/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<Role xsitype="...">
  <type>...</type>
  <id>...</id>
  <name>...</name>
  <permissions>...</permissions>
</Role>

                
              

PUT /webservices/services/rest/v2/roles/{id}

Edit a role.

Request Parameters
name type description constraints
id path the roleId long
Request Body
media type data type description
application/xml Role (XML) the role DTO
Response Body
media type data type description
application/xml Role (XML) the modified role

Example

Request
PUT /webservices/services/rest/v2/roles/{id}
Content-Type: application/xml
Accept: application/xml

                
<Role xsitype="...">
  <type>...</type>
  <id>...</id>
  <name>...</name>
  <permissions>...</permissions>
</Role>

                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
<Role xsitype="...">
  <type>...</type>
  <id>...</id>
  <name>...</name>
  <permissions>...</permissions>
</Role>

                
              

GET /webservices/services/rest/v2/roles/name/{name}

Retrieve a role by name. If it does not exist, an exception will be thrown.

Request Parameters
name type description
name path the url encoded role name
Response Body
media type data type description
application/xml Role (XML) the role

Example

Request
GET /webservices/services/rest/v2/roles/name/{name}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<Role xsitype="...">
  <type>...</type>
  <id>...</id>
  <name>...</name>
  <permissions>...</permissions>
</Role>

                
              

GET /webservices/services/rest/v2/runtimeservers

Retrieve a list of hosts.

Request Parameters
name type description default constraints
max query the max count 100 int
msid query the ms id -1 long
Response Body
media type data type description
application/xml RuntimeServerCollection (XML) the runtime servers

Example

Request
GET /webservices/services/rest/v2/runtimeservers
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RuntimeServerCollection>
  <RuntimeServers>
    <address>...</address>
    <connectionState>...</connectionState>
    <maintenanceMode>...</maintenanceMode>
    <manufacturer>...</manufacturer>
    <model>...</model>
    <processors>...</processors>
    <processorType>...</processorType>
    <numCores>...</numCores>
    <numCpuPackages>...</numCpuPackages>
    <avgCpuMhz>...</avgCpuMhz>
    <numNics>...</numNics>
    <vmotionEnabled>...</vmotionEnabled>
    <hyperthreadActive>...</hyperthreadActive>
    <configuredCredentialsEnabled>...</configuredCredentialsEnabled>
    <configuredCredentials>...</configuredCredentials>
    <memory>...</memory>
    <uuid>...</uuid>
    <mgmtServiceVersion>...</mgmtServiceVersion>
    <creationDate>...</creationDate>
    <parentResource>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </parentResource>
    <mountedDatastores>
      <datastore/>
      <runtimeServer/>
      <path>...</path>
      <accessMode>...</accessMode>
      <remoteId>...</remoteId>
    </mountedDatastores>
    <inCluster>...</inCluster>
    <reference/>
    <managementServer/>
    <connected>...</connected>
    <remoteId>...</remoteId>
    <name>...</name>
    <operationalParent/>
    <deployedParent/>
    <repositoryParent/>
    <datastoreParent/>
    <attributes/>
    <expiryGroup/>
    <groups/>
    <managementServerType>...</managementServerType>
  </RuntimeServers>
</RuntimeServerCollection>

                
              

GET /webservices/services/rest/v2/security/sessions

Return a collection of all currently active sessions.

Response Body
media type data type description
application/xml ActiveSessionCollection (XML) WSActiveSessioncollection the collection of active sessions

Example

Request
GET /webservices/services/rest/v2/security/sessions
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ActiveSessionCollection>
  <ActiveSession>
    <userId>...</userId>
    <uuid>...</uuid>
    <appName>...</appName>
  </ActiveSession>
</ActiveSessionCollection>

                
              

GET /webservices/services/rest/v2/security/sessions/count

Get the counts about the number of active sessions per application. Returns both the number of active sessions and the configured maximums.

Response Body
media type data type description
application/xml SessionInfoCollection (XML) WSSessionInfoCollection the collection of session info.

Example

Request
GET /webservices/services/rest/v2/security/sessions/count
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<SessionInfoCollection>
  <SessionInfo>
    <sessions>...</sessions>
    <maxSessions>...</maxSessions>
    <application>...</application>
  </SessionInfo>
</SessionInfoCollection>

                
              

GET /webservices/services/rest/v2/servicecategories

Get a list of service categories

Response Body
media type data type description
application/xml ServiceCategoryCollection (XML) the service categories

Example

Request
GET /webservices/services/rest/v2/servicecategories
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ServiceCategoryCollection>
  <ServiceCategories xsitype="...">
    <id>...</id>
    <name>...</name>
    <serviceCount>...</serviceCount>
  </ServiceCategories>
</ServiceCategoryCollection>

                
              

GET /webservices/services/rest/v2/servicecategories/{id}

Retrieve a service catalog category by ID.

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
application/xml ServiceCategory (XML) the service category

Example

Request
GET /webservices/services/rest/v2/servicecategories/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ServiceCategory xsitype="...">
  <id>...</id>
  <name>...</name>
  <serviceCount>...</serviceCount>
</ServiceCategory>

                
              

POST /webservices/services/rest/v2/sessions

Login.

Request Body
media type data type description
text/plain (custom) the body
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/sessions
Content-Type: text/plain
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

DELETE /webservices/services/rest/v2/sessions/{securityToken}

Log out.

Request Parameters
name type description
securityToken path the security token
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
DELETE /webservices/services/rest/v2/sessions/{securityToken}
Content-Type: text/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: text/xml

                
...
                
              

POST /webservices/services/rest/v2/sessions/{securityToken}/action/keepalive

Prolong the current session (keep the current session active).

Request Parameters
name type description
securityToken path the security token
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/sessions/{securityToken}/action/keepalive
Content-Type: text/plain
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: text/xml

                
...
                
              

DELETE /webservices/services/rest/v2/stacks/{id}

Delete a Stack

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
DELETE /webservices/services/rest/v2/stacks/{id}
Content-Type: text/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/stacks/{id}

Queries for a stack by its ID.

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
application/xml Stack (XML) the VM by id

Example

Request
GET /webservices/services/rest/v2/stacks/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<Stack>
  <stackId>...</stackId>
  <stackStatus>...</stackStatus>
  <stackStatusReason>...</stackStatusReason>
  <description>...</description>
  <outputs xsitype="...">
    <outputKey>...</outputKey>
    <outputValue>...</outputValue>
    <description>...</description>
  </outputs>
  <lastUpdatedTime>...</lastUpdatedTime>
  <owners xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </owners>
  <primaryOwner xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </primaryOwner>
  <itContact xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </itContact>
  <eolState>...</eolState>
  <suspectState>...</suspectState>
  <expiryDate>...</expiryDate>
  <expiryState>...</expiryState>
  <approvalState>...</approvalState>
  <organization xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organization>
  <objectHandleId>...</objectHandleId>
  <connectionState>...</connectionState>
  <creationDate>...</creationDate>
  <createdBy>...</createdBy>
  <existsInInventory>...</existsInInventory>
  <compliant>...</compliant>
  <cost>...</cost>
  <runningCost>...</runningCost>
  <resources>
    <id>...</id>
    <stack>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </stack>
    <resourceGroup>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </resourceGroup>
    <logicalId>...</logicalId>
    <physicalId>...</physicalId>
    <resourceName>...</resourceName>
    <resourceType>...</resourceType>
    <resourceStatus>...</resourceStatus>
    <resourceStatusReason>...</resourceStatusReason>
    <lastStatusUpdatedTime>...</lastStatusUpdatedTime>
    <description>...</description>
  </resources>
  <errors xsitype="...">
    <id>...</id>
    <thirdParty>...</thirdParty>
    <severity>...</severity>
    <location>...</location>
    <message>...</message>
  </errors>
  <reference>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </reference>
  <managementServer>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </managementServer>
  <connected>...</connected>
  <remoteId>...</remoteId>
  <name>...</name>
  <operationalParent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </operationalParent>
  <deployedParent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </deployedParent>
  <repositoryParent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </repositoryParent>
  <datastoreParent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </datastoreParent>
  <attributes>
    <id>...</id>
    <attribute/>
    <value>...</value>
  </attributes>
  <expiryGroup>
    <name>...</name>
    <description>...</description>
    <targetManagedObjectTypes>...</targetManagedObjectTypes>
    <allowedValues/>
    <portalEditable>...</portalEditable>
    <enumerated>...</enumerated>
    <costItems/>
    <regularExpression>...</regularExpression>
    <validationMessage>...</validationMessage>
    <subList>...</subList>
    <parentId>...</parentId>
    <parentName>...</parentName>
  </expiryGroup>
  <groups>
    <groupType>...</groupType>
    <permanent>...</permanent>
  </groups>
  <managementServerType>...</managementServerType>
</Stack>

                
              

POST /webservices/services/rest/v2/stacks/{id}/action/applyattribute

Apply a custom attribute value to the specified Stack

The custom attribute Id or name, as well as the value must be specified. If both the id and name are specified, the Id takes precedence.

Request Parameters
name type description constraints
id path the id long
Request Body
media type data type description
application/xml CustomAttribute (XML) the attribute
Response Body
media type data type description
application/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/stacks/{id}/action/applyattribute
Content-Type: application/xml
Accept: application/xml

                
<CustomAttribute>
  <allowedValues>...</allowedValues>
  <portalEditable>...</portalEditable>
  <enumerated>...</enumerated>
  <description>...</description>
  <targetManagedObjectTypes>...</targetManagedObjectTypes>
  <name>...</name>
  <value>...</value>
  <costItems>
    <name>...</name>
    <cost>...</cost>
    <costFormula>...</costFormula>
  </costItems>
  <regularExpression>...</regularExpression>
  <validationMessage>...</validationMessage>
</CustomAttribute>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
...
                
              

POST /webservices/services/rest/v2/stacks/{id}/action/applyexpirygroup

Apply an expiry group to the specified Stack.

Request Parameters
name type description constraints
id path the id long
Request Body
media type data type description
text/plain (custom) name of the the expiry group
Response Body
media type data type description
application/xml TaskInfo (XML) the WS task info

Example

Request
POST /webservices/services/rest/v2/stacks/{id}/action/applyexpirygroup
Content-Type: text/plain
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

POST /webservices/services/rest/v2/stacks/{id}/action/applyownership

Apply ownership to the specified Stack.

Request Parameters
name type description constraints
id path ID of the Stack to apply ownership to long
Request Body
media type data type description
application/xml Ownership (XML) Ownership information to apply to the VM
Response Body
media type data type description
application/xml TaskInfo (XML) WSTaskInfo that can be monitored to determine when the apply ownership task completes

Example

Request
POST /webservices/services/rest/v2/stacks/{id}/action/applyownership
Content-Type: application/xml
Accept: application/xml

                
<Ownership xsitype="...">
  <organization xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organization>
  <Owners xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </Owners>
</Ownership>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

GET /webservices/services/rest/v2/stacks/objecthandle/{object_handle_id}

Retrieve a Stack by its object handle ID.

Request Parameters
name type description constraints
object_handle_id path the id long
Response Body
media type data type description
application/xml Stack (XML) the VM by object handle id

Example

Request
GET /webservices/services/rest/v2/stacks/objecthandle/{object_handle_id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<Stack>
  <stackId>...</stackId>
  <stackStatus>...</stackStatus>
  <stackStatusReason>...</stackStatusReason>
  <description>...</description>
  <outputs xsitype="...">
    <outputKey>...</outputKey>
    <outputValue>...</outputValue>
    <description>...</description>
  </outputs>
  <lastUpdatedTime>...</lastUpdatedTime>
  <owners xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </owners>
  <primaryOwner xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </primaryOwner>
  <itContact xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </itContact>
  <eolState>...</eolState>
  <suspectState>...</suspectState>
  <expiryDate>...</expiryDate>
  <expiryState>...</expiryState>
  <approvalState>...</approvalState>
  <organization xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organization>
  <objectHandleId>...</objectHandleId>
  <connectionState>...</connectionState>
  <creationDate>...</creationDate>
  <createdBy>...</createdBy>
  <existsInInventory>...</existsInInventory>
  <compliant>...</compliant>
  <cost>...</cost>
  <runningCost>...</runningCost>
  <resources>
    <id>...</id>
    <stack>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </stack>
    <resourceGroup>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </resourceGroup>
    <logicalId>...</logicalId>
    <physicalId>...</physicalId>
    <resourceName>...</resourceName>
    <resourceType>...</resourceType>
    <resourceStatus>...</resourceStatus>
    <resourceStatusReason>...</resourceStatusReason>
    <lastStatusUpdatedTime>...</lastStatusUpdatedTime>
    <description>...</description>
  </resources>
  <errors xsitype="...">
    <id>...</id>
    <thirdParty>...</thirdParty>
    <severity>...</severity>
    <location>...</location>
    <message>...</message>
  </errors>
  <reference>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </reference>
  <managementServer>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </managementServer>
  <connected>...</connected>
  <remoteId>...</remoteId>
  <name>...</name>
  <operationalParent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </operationalParent>
  <deployedParent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </deployedParent>
  <repositoryParent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </repositoryParent>
  <datastoreParent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </datastoreParent>
  <attributes>
    <id>...</id>
    <attribute/>
    <value>...</value>
  </attributes>
  <expiryGroup>
    <name>...</name>
    <description>...</description>
    <targetManagedObjectTypes>...</targetManagedObjectTypes>
    <allowedValues/>
    <portalEditable>...</portalEditable>
    <enumerated>...</enumerated>
    <costItems/>
    <regularExpression>...</regularExpression>
    <validationMessage>...</validationMessage>
    <subList>...</subList>
    <parentId>...</parentId>
    <parentName>...</parentName>
  </expiryGroup>
  <groups>
    <groupType>...</groupType>
    <permanent>...</permanent>
  </groups>
  <managementServerType>...</managementServerType>
</Stack>

                
              

GET /webservices/services/rest/v2/storagereservations

Gets the storage reservations.

Response Body
media type data type description
application/xml StorageReservationCollection (XML) the collection of storage reservations

Example

Request
GET /webservices/services/rest/v2/storagereservations
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<StorageReservationCollection>
  <storageReservations>
    <id>...</id>
    <timestamp>...</timestamp>
    <taskId>...</taskId>
    <requestId>...</requestId>
    <requestedServiceId>...</requestedServiceId>
    <datastoreReservations>
      <datastore/>
      <sizeBytes>...</sizeBytes>
    </datastoreReservations>
  </storageReservations>
</StorageReservationCollection>

                
              

DELETE /webservices/services/rest/v2/storagereservations/{reservationId}

Delete storage reservation.

Request Parameters
name type description constraints
reservationId path the reservation id long
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
DELETE /webservices/services/rest/v2/storagereservations/{reservationId}
Content-Type: text/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/tasks/{id}/info

Retrieve a task info.

Request Parameters
name type description constraints
id path the task id long
Response Body
media type data type description
application/xml TaskInfo (XML) the task info

Example

Request
GET /webservices/services/rest/v2/tasks/{id}/info
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

GET /webservices/services/rest/v2/tasks/metadata/current

Retrieves task information for all current tasks. A task is included in the list of current tasks if any of the following is true:"

  • the task is queued
  • the task is executing
  • the task is being cancelled
  • the task has been cancelled in the last five minutes
  • the task has failed in the last five minutes
  • the task has completed successfully in the last five minutes
  • The list of tasks returned matches the list of tasks that appears in the bottom pane of the Web UI.

Response Body
media type data type description
application/xml TaskInfoCollection (XML) the all current tasks

Example

Request
GET /webservices/services/rest/v2/tasks/metadata/current
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<TaskInfoCollection>
  <TasksInfos>
    <state>...</state>
    <userid>...</userid>
    <name>...</name>
    <timeSubmitted>...</timeSubmitted>
    <timeStarted>...</timeStarted>
    <timeCompleted>...</timeCompleted>
    <source>...</source>
    <destination>...</destination>
    <percentComplete>...</percentComplete>
    <relatedObjects>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </relatedObjects>
    <finalState>...</finalState>
    <correlationId>...</correlationId>
  </TasksInfos>
</TaskInfoCollection>

                
              

GET /webservices/services/rest/v2/templates/{xml_tag_name}

Retrieve a template.

Request Parameters
name type description
xml_tag_name path the xml tag name
Response Body
media type data type description
application/xml anyType (XML) the DTO template

Example

Request
GET /webservices/services/rest/v2/templates/{xml_tag_name}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
...
                
              

GET /webservices/services/rest/v2/vapps

Retrieve a list of vApps.

Request Parameters
name type description default constraints
dcid query the datacenterid -1 long
max query the max count 100 int
msid query the ms id -1 long
parentid query the parente id -1 long
remoteid query the remoteid    
vappname query the v app name    
Response Body
media type data type description
application/xml VirtualAppCollection (XML) the v apps

Example

Request
GET /webservices/services/rest/v2/vapps
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<VirtualAppCollection>
  <VirtualApps>
    <expiryDate>...</expiryDate>
    <expiryExtensionsRemaining>...</expiryExtensionsRemaining>
    <expiryState>...</expiryState>
    <organization>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organization>
    <owners>
      <id>...</id>
      <loginId>...</loginId>
      <displayName>...</displayName>
      <email>...</email>
      <itContact>...</itContact>
      <primary>...</primary>
    </owners>
    <product>...</product>
    <vendor>...</vendor>
    <version>...</version>
    <state>...</state>
    <productUrl>...</productUrl>
    <ipAddress>...</ipAddress>
    <dnsName>...</dnsName>
    <objectHandleId>...</objectHandleId>
    <cost>...</cost>
    <runningCost>...</runningCost>
    <parentReference/>
    <ownerReference/>
  </VirtualApps>
</VirtualAppCollection>

                
              

DELETE /webservices/services/rest/v2/vapps/{id}

Delete a vApp

Request Parameters
name type description constraints
id path the id of the vApp long
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
DELETE /webservices/services/rest/v2/vapps/{id}
Content-Type: text/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/vapps/{id}

Retrieve a vApp by its ID.

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
application/xml VirtualApp (XML) the v app by id

Example

Request
GET /webservices/services/rest/v2/vapps/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<VirtualApp>
  <expiryDate>...</expiryDate>
  <expiryExtensionsRemaining>...</expiryExtensionsRemaining>
  <expiryState>...</expiryState>
  <organization xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organization>
  <owners xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </owners>
  <product>...</product>
  <vendor>...</vendor>
  <version>...</version>
  <state>...</state>
  <productUrl>...</productUrl>
  <ipAddress>...</ipAddress>
  <dnsName>...</dnsName>
  <objectHandleId>...</objectHandleId>
  <cost>...</cost>
  <runningCost>...</runningCost>
  <parentReference>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </parentReference>
  <ownerReference>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ownerReference>
  <reference/>
  <managementServer/>
  <connected>...</connected>
  <remoteId>...</remoteId>
  <name>...</name>
  <operationalParent/>
  <deployedParent/>
  <repositoryParent/>
  <datastoreParent/>
  <attributes/>
  <expiryGroup/>
  <groups/>
  <managementServerType>...</managementServerType>
</VirtualApp>

                
              

POST /webservices/services/rest/v2/vapps/{id}/action/applyownership

Apply ownership to the specified Virtual Service (vApp)

Request Parameters
name type description constraints
id path ID of the vApp to apply ownership to long
Request Body
media type data type description
application/xml Ownership (XML) Ownership information to apply to the vApp
Response Body
media type data type description
application/xml TaskInfo (XML) WSTaskInfo that can be monitored to determine when the apply ownership task completes

Example

Request
POST /webservices/services/rest/v2/vapps/{id}/action/applyownership
Content-Type: application/xml
Accept: application/xml

                
<Ownership xsitype="...">
  <organization xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organization>
  <Owners xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </Owners>
</Ownership>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

POST /webservices/services/rest/v2/vapps/{id}/action/requestchange

This method has been deprecated.

Make a change request for the specified vApp.

Request Parameters
name type description constraints
id path the vApp id long
Request Body
media type data type description
application/xml ChangeRequestParam (XML) the change request parameters
Response Body
media type data type description
application/xml anyType (XML) the HTTP response

Example

Request
POST /webservices/services/rest/v2/vapps/{id}/action/requestchange
Content-Type: application/xml
Accept: application/xml

                
<ChangeRequestParam>
  <formElements>
    <RequestFormElements>
      <label>...</label>
      <mandatory>...</mandatory>
      <formType>...</formType>
      <value>...</value>
    </RequestFormElements>
  </formElements>
  <formId>...</formId>
</ChangeRequestParam>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
...
                
              

POST /webservices/services/rest/v2/vapps/{id}/action/submitchange

Make a change request for the specified vApp.

Request Parameters
name type description constraints
id path the vApp id long
Request Body
media type data type description
application/xml ChangeRequestParam (XML) the change request parameters
Response Body
media type data type description
application/xml Request (XML) the submitted request DTOO

Example

Request
POST /webservices/services/rest/v2/vapps/{id}/action/submitchange
Content-Type: application/xml
Accept: application/xml

                
<ChangeRequestParam>
  <formElements>
    <RequestFormElements>
      <label>...</label>
      <mandatory>...</mandatory>
      <formType>...</formType>
      <value>...</value>
    </RequestFormElements>
  </formElements>
  <formId>...</formId>
</ChangeRequestParam>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<Request>
  <id>...</id>
  <organization xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organization>
  <state>...</state>
  <type>...</type>
  <requestDate>...</requestDate>
  <fulfillDate>...</fulfillDate>
  <formVersion>...</formVersion>
  <requester>...</requester>
  <assignedAdmin>...</assignedAdmin>
  <waitingOn>...</waitingOn>
  <requiredBy>...</requiredBy>
  <targetService xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </targetService>
  <duration>...</duration>
  <requestFailed>...</requestFailed>
</Request>

                
              

GET /webservices/services/rest/v2/vapps/{id}/metadata/changerequestparams/{formid}

Retrieve parameters needed for a vApp change request using the specified form.

Request Parameters
name type description constraints
formid path the form id long
id path the id long
Response Body
media type data type description
application/xml ChangeRequestParam (XML) the v app change request requirement

Example

Request
GET /webservices/services/rest/v2/vapps/{id}/metadata/changerequestparams/{formid}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ChangeRequestParam>
  <formElements>
    <RequestFormElements>
      <label>...</label>
      <mandatory>...</mandatory>
      <formType>...</formType>
      <value>...</value>
    </RequestFormElements>
  </formElements>
  <formId>...</formId>
</ChangeRequestParam>

                
              

GET /webservices/services/rest/v2/vapps/objecthandle/{object_handle_id}

Queries for a virtual app by its object handle ID.

Request Parameters
name type description constraints
object_handle_id path the id long
Response Body
media type data type description
application/xml VirtualApp (XML) the v app by object handle id

Example

Request
GET /webservices/services/rest/v2/vapps/objecthandle/{object_handle_id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<VirtualApp>
  <expiryDate>...</expiryDate>
  <expiryExtensionsRemaining>...</expiryExtensionsRemaining>
  <expiryState>...</expiryState>
  <organization xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organization>
  <owners xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </owners>
  <product>...</product>
  <vendor>...</vendor>
  <version>...</version>
  <state>...</state>
  <productUrl>...</productUrl>
  <ipAddress>...</ipAddress>
  <dnsName>...</dnsName>
  <objectHandleId>...</objectHandleId>
  <cost>...</cost>
  <runningCost>...</runningCost>
  <parentReference>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </parentReference>
  <ownerReference>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ownerReference>
  <reference/>
  <managementServer/>
  <connected>...</connected>
  <remoteId>...</remoteId>
  <name>...</name>
  <operationalParent/>
  <deployedParent/>
  <repositoryParent/>
  <datastoreParent/>
  <attributes/>
  <expiryGroup/>
  <groups/>
  <managementServerType>...</managementServerType>
</VirtualApp>

                
              

GET /webservices/services/rest/v2/vminstancetypes

Retrieve all VM instance types

Response Body
media type data type description
application/xml VMInstanceTypeCollection (XML) the VM instance types

Example

Request
GET /webservices/services/rest/v2/vminstancetypes
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<VMInstanceTypeCollection>
  <VMInstanceTypes>
    <id>...</id>
    <managementServerType>...</managementServerType>
    <instanceFamily>...</instanceFamily>
    <instanceType>...</instanceType>
    <description>...</description>
    <name>...</name>
    <processorArch>...</processorArch>
    <vcpu>...</vcpu>
    <ecu>...</ecu>
    <memory>...</memory>
    <storage>...</storage>
    <instanceStorage>...</instanceStorage>
    <ebsOptimizedAvailable>...</ebsOptimizedAvailable>
    <networkPerformance>...</networkPerformance>
    <maxENIs>...</maxENIs>
    <maxIPsPerENI>...</maxIPsPerENI>
    <availableForSpotInstance>...</availableForSpotInstance>
  </VMInstanceTypes>
</VMInstanceTypeCollection>

                
              

GET /webservices/services/rest/v2/vminstancetypes/mstype/{mstype}

Retrieve all VM instance types for the specified management server type.

Request Parameters
name type description
mstype path the management server type
Response Body
media type data type description
application/xml VMInstanceTypeCollection (XML) the VM instance types by management server

Example

Request
GET /webservices/services/rest/v2/vminstancetypes/mstype/{mstype}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<VMInstanceTypeCollection>
  <VMInstanceTypes>
    <id>...</id>
    <managementServerType>...</managementServerType>
    <instanceFamily>...</instanceFamily>
    <instanceType>...</instanceType>
    <description>...</description>
    <name>...</name>
    <processorArch>...</processorArch>
    <vcpu>...</vcpu>
    <ecu>...</ecu>
    <memory>...</memory>
    <storage>...</storage>
    <instanceStorage>...</instanceStorage>
    <ebsOptimizedAvailable>...</ebsOptimizedAvailable>
    <networkPerformance>...</networkPerformance>
    <maxENIs>...</maxENIs>
    <maxIPsPerENI>...</maxIPsPerENI>
    <availableForSpotInstance>...</availableForSpotInstance>
  </VMInstanceTypes>
</VMInstanceTypeCollection>

                
              

GET /webservices/services/rest/v2/vms

Retrieve a list of VMs, sorted by their ID. Note that it is inadvisable to retrieve a very large number of VMs at once as this may place excessive load on the system; instead, use "maxCount" and "offset" to batch your access.

Request Parameters
name type description default constraints
dcid query (Optional) ID of the datacenter - only VMs in this datacenter will be returned -1 long
hostid query (Optional) ID of the host - only VMs running on this host will be returned -1 long
max query Maximum number of VMs to return. Defaults to 100. Use -1 to have no maximum. 100 int
msid query (Optional) ID of the management server - only VMs on this management server will be returned -1 long
offset query The index of the first item to return from the result set. Use in combination with maxCount to retrieve in batches. Defaults to 0. 0 int
orgName query (Optional) The organization name, which owns the VM.    
parentid query (Optional) ID of the parent - only VMs in this parent will be returned. For VMware, this is the parent folder. -1 long
primaryOwnerLogin query (Optional) Login ID of the primary owner  
remoteid query (Optional) Remote ID of the VM, which is the unique identifier on the managed system it resides on. Only VMs matching this remote ID will be returned    
vmname query (Optional) Name of the VM - only VMs matching this name will be returned    
Response Body
media type data type description
application/xml VirtualMachineCollection (XML) Collection of VMs that match the specified query parameters

Example

Request
GET /webservices/services/rest/v2/vms
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<VirtualMachineCollection>
  <VirtualMachines>
    <objectHandleId>...</objectHandleId>
    <lastDatastoreScanDate>...</lastDatastoreScanDate>
    <configFile>...</configFile>
    <state>...</state>
    <connectionState>...</connectionState>
    <runtimeGUID>...</runtimeGUID>
    <template>...</template>
    <guestOS>...</guestOS>
    <configGuestId>...</configGuestId>
    <numCPU>...</numCPU>
    <memory>...</memory>
    <instanceType>
      <id>...</id>
      <managementServerType>...</managementServerType>
      <instanceFamily>...</instanceFamily>
      <instanceType>...</instanceType>
      <description>...</description>
      <name>...</name>
      <processorArch>...</processorArch>
      <vcpu>...</vcpu>
      <ecu>...</ecu>
      <memory>...</memory>
      <storage>...</storage>
      <instanceStorage>...</instanceStorage>
      <ebsOptimizedAvailable>...</ebsOptimizedAvailable>
      <networkPerformance>...</networkPerformance>
      <maxENIs>...</maxENIs>
      <maxIPsPerENI>...</maxIPsPerENI>
      <availableForSpotInstance>...</availableForSpotInstance>
    </instanceType>
    <availabilitySet>...</availabilitySet>
    <toolStatus>...</toolStatus>
    <ipAddress>...</ipAddress>
    <networkString>...</networkString>
    <macAddressString>...</macAddressString>
    <ipv4AddressString>...</ipv4AddressString>
    <ipv6AddressString>...</ipv6AddressString>
    <dnsName>...</dnsName>
    <operationalStates>...</operationalStates>
    <cpuReservation>...</cpuReservation>
    <cpuLimit>...</cpuLimit>
    <cpuShares>...</cpuShares>
    <cpuSharesLevel>...</cpuSharesLevel>
    <memReservation>...</memReservation>
    <memLimit>...</memLimit>
    <memShares>...</memShares>
    <memSharesLevel>...</memSharesLevel>
    <diskSpaceConsumed>...</diskSpaceConsumed>
    <diskSpaceCommitted>...</diskSpaceCommitted>
    <customizableOS>...</customizableOS>
    <networkCards>
      <macAddress>...</macAddress>
      <adapterType>...</adapterType>
      <uniqueNetId>...</uniqueNetId>
      <logicalNetwork>...</logicalNetwork>
      <name>...</name>
      <addressType>...</addressType>
    </networkCards>
    <disks>
      <size>...</size>
      <diskType>...</diskType>
      <iops>...</iops>
      <diskMode>...</diskMode>
      <fileName>...</fileName>
      <datastore/>
    </disks>
    <parent>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </parent>
    <runtimeServer>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </runtimeServer>
    <resourcePool>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </resourcePool>
    <datastores>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </datastores>
    <creationDate>...</creationDate>
    <createdBy>...</createdBy>
    <iamRole>...</iamRole>
    <printEmbedded>...</printEmbedded>
    <existsInInventory>...</existsInInventory>
    <existsOnDisk>...</existsOnDisk>
    <approvalState>...</approvalState>
    <owners>
      <id>...</id>
      <loginId>...</loginId>
      <displayName>...</displayName>
      <email>...</email>
      <itContact>...</itContact>
      <primary>...</primary>
    </owners>
    <eolState>...</eolState>
    <expiryDate>...</expiryDate>
    <expiryExtensionsRemaining>...</expiryExtensionsRemaining>
    <expiryState>...</expiryState>
    <suspectState>...</suspectState>
    <mismatch>...</mismatch>
    <diskSpaceScanned>...</diskSpaceScanned>
    <containerSpaceUsed>...</containerSpaceUsed>
    <cost>...</cost>
    <runningCost>...</runningCost>
    <freeDiskSpace>...</freeDiskSpace>
    <logicalDiskSize>...</logicalDiskSize>
    <snapshotCount>...</snapshotCount>
    <unallocatedDiskSpace>...</unallocatedDiskSpace>
    <unpartitionedDiskSpace>...</unpartitionedDiskSpace>
    <vmScanUser>...</vmScanUser>
    <lastDeployedDate>...</lastDeployedDate>
    <lastInInventoryDate>...</lastInInventoryDate>
    <poweredOffSince>...</poweredOffSince>
    <compliant>...</compliant>
    <organization>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organization>
    <cluster>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </cluster>
    <resourceGroup>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </resourceGroup>
    <reference/>
    <managementServer/>
    <connected>...</connected>
    <remoteId>...</remoteId>
    <name>...</name>
    <operationalParent/>
    <deployedParent/>
    <repositoryParent/>
    <datastoreParent/>
    <attributes/>
    <expiryGroup/>
    <groups/>
    <managementServerType>...</managementServerType>
  </VirtualMachines>
</VirtualMachineCollection>

                
              

DELETE /webservices/services/rest/v2/vms/{id}

Delete a VM

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
text/xml anyType (XML) the response

Example

Request
DELETE /webservices/services/rest/v2/vms/{id}
Content-Type: text/xml
Accept: text/xml

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: text/xml

                
...
                
              

GET /webservices/services/rest/v2/vms/{id}

Queries for a virtual machine by its ID.

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
application/xml VirtualMachine (XML) the VM by id

Example

Request
GET /webservices/services/rest/v2/vms/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<VirtualMachine>
  <objectHandleId>...</objectHandleId>
  <lastDatastoreScanDate>...</lastDatastoreScanDate>
  <configFile>...</configFile>
  <state>...</state>
  <connectionState>...</connectionState>
  <runtimeGUID>...</runtimeGUID>
  <template>...</template>
  <guestOS>...</guestOS>
  <configGuestId>...</configGuestId>
  <numCPU>...</numCPU>
  <memory>...</memory>
  <instanceType>
    <id>...</id>
    <managementServerType>...</managementServerType>
    <instanceFamily>...</instanceFamily>
    <instanceType>...</instanceType>
    <description>...</description>
    <name>...</name>
    <processorArch>...</processorArch>
    <vcpu>...</vcpu>
    <ecu>...</ecu>
    <memory>...</memory>
    <storage>...</storage>
    <instanceStorage>...</instanceStorage>
    <ebsOptimizedAvailable>...</ebsOptimizedAvailable>
    <networkPerformance>...</networkPerformance>
    <maxENIs>...</maxENIs>
    <maxIPsPerENI>...</maxIPsPerENI>
    <availableForSpotInstance>...</availableForSpotInstance>
  </instanceType>
  <availabilitySet>...</availabilitySet>
  <toolStatus>...</toolStatus>
  <ipAddress>...</ipAddress>
  <networkString>...</networkString>
  <macAddressString>...</macAddressString>
  <ipv4AddressString>...</ipv4AddressString>
  <ipv6AddressString>...</ipv6AddressString>
  <dnsName>...</dnsName>
  <operationalStates>...</operationalStates>
  <cpuReservation>...</cpuReservation>
  <cpuLimit>...</cpuLimit>
  <cpuShares>...</cpuShares>
  <cpuSharesLevel>...</cpuSharesLevel>
  <memReservation>...</memReservation>
  <memLimit>...</memLimit>
  <memShares>...</memShares>
  <memSharesLevel>...</memSharesLevel>
  <diskSpaceConsumed>...</diskSpaceConsumed>
  <diskSpaceCommitted>...</diskSpaceCommitted>
  <customizableOS>...</customizableOS>
  <networkCards>
    <macAddress>...</macAddress>
    <adapterType>...</adapterType>
    <uniqueNetId>...</uniqueNetId>
    <logicalNetwork>...</logicalNetwork>
    <name>...</name>
    <addressType>...</addressType>
    <id>...</id>
    <summary>...</summary>
    <uuid>...</uuid>
    <vmId>...</vmId>
    <key>...</key>
    <label>...</label>
    <connected>...</connected>
    <startConnected>...</startConnected>
  </networkCards>
  <disks>
    <size>...</size>
    <diskType>...</diskType>
    <iops>...</iops>
    <diskMode>...</diskMode>
    <fileName>...</fileName>
    <datastore>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </datastore>
    <id>...</id>
    <summary>...</summary>
    <uuid>...</uuid>
    <vmId>...</vmId>
    <key>...</key>
    <label>...</label>
    <connected>...</connected>
    <startConnected>...</startConnected>
  </disks>
  <parent xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </parent>
  <runtimeServer xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </runtimeServer>
  <resourcePool xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </resourcePool>
  <datastores xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </datastores>
  <creationDate>...</creationDate>
  <createdBy>...</createdBy>
  <iamRole>...</iamRole>
  <printEmbedded>...</printEmbedded>
  <existsInInventory>...</existsInInventory>
  <existsOnDisk>...</existsOnDisk>
  <approvalState>...</approvalState>
  <owners xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </owners>
  <eolState>...</eolState>
  <expiryDate>...</expiryDate>
  <expiryExtensionsRemaining>...</expiryExtensionsRemaining>
  <expiryState>...</expiryState>
  <suspectState>...</suspectState>
  <mismatch>...</mismatch>
  <diskSpaceScanned>...</diskSpaceScanned>
  <containerSpaceUsed>...</containerSpaceUsed>
  <cost>...</cost>
  <runningCost>...</runningCost>
  <freeDiskSpace>...</freeDiskSpace>
  <logicalDiskSize>...</logicalDiskSize>
  <snapshotCount>...</snapshotCount>
  <unallocatedDiskSpace>...</unallocatedDiskSpace>
  <unpartitionedDiskSpace>...</unpartitionedDiskSpace>
  <vmScanUser>...</vmScanUser>
  <lastDeployedDate>...</lastDeployedDate>
  <lastInInventoryDate>...</lastInInventoryDate>
  <poweredOffSince>...</poweredOffSince>
  <compliant>...</compliant>
  <organization xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organization>
  <cluster xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </cluster>
  <resourceGroup xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </resourceGroup>
  <reference>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </reference>
  <managementServer>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </managementServer>
  <connected>...</connected>
  <remoteId>...</remoteId>
  <name>...</name>
  <operationalParent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </operationalParent>
  <deployedParent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </deployedParent>
  <repositoryParent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </repositoryParent>
  <datastoreParent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </datastoreParent>
  <attributes>
    <id>...</id>
    <attribute/>
    <value>...</value>
  </attributes>
  <expiryGroup>
    <name>...</name>
    <description>...</description>
    <targetManagedObjectTypes>...</targetManagedObjectTypes>
    <allowedValues/>
    <portalEditable>...</portalEditable>
    <enumerated>...</enumerated>
    <costItems/>
    <regularExpression>...</regularExpression>
    <validationMessage>...</validationMessage>
    <subList>...</subList>
    <parentId>...</parentId>
    <parentName>...</parentName>
  </expiryGroup>
  <groups>
    <groupType>...</groupType>
    <permanent>...</permanent>
  </groups>
  <managementServerType>...</managementServerType>
</VirtualMachine>

                
              

POST /webservices/services/rest/v2/vms/{id}/action/applyapproval

Apply the approval state to the specified VM [true or false].

Request Parameters
name type description constraints
id path the id long
Request Body
media type data type description
text/plain (custom) the approval str
Response Body
media type data type description
application/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/vms/{id}/action/applyapproval
Content-Type: text/plain
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
...
                
              

POST /webservices/services/rest/v2/vms/{id}/action/applyattribute

Apply a custom attribute value to the specified VM

The custom attribute Id or name, as well as the value must be specified. If both the id and name are specified, the Id takes precedence.

Request Parameters
name type description constraints
id path the id long
Request Body
media type data type description
application/xml CustomAttribute (XML) the attribute
Response Body
media type data type description
application/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/vms/{id}/action/applyattribute
Content-Type: application/xml
Accept: application/xml

                
<CustomAttribute>
  <allowedValues>...</allowedValues>
  <portalEditable>...</portalEditable>
  <enumerated>...</enumerated>
  <description>...</description>
  <targetManagedObjectTypes>...</targetManagedObjectTypes>
  <name>...</name>
  <value>...</value>
  <costItems>
    <name>...</name>
    <cost>...</cost>
    <costFormula>...</costFormula>
  </costItems>
  <regularExpression>...</regularExpression>
  <validationMessage>...</validationMessage>
</CustomAttribute>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
...
                
              

POST /webservices/services/rest/v2/vms/{id}/action/applycompliancedata

Apply compliance data to the specified VM.

Request Parameters
name type description constraints
id path the id long
Request Body
media type data type description
application/xml ComplianceData (XML) the data submitted
Response Body
media type data type description
application/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/vms/{id}/action/applycompliancedata
Content-Type: application/xml
Accept: application/xml

                
<ComplianceData xsitype="...">
  <Attributes>
    <portalEditable>...</portalEditable>
    <enumerated>...</enumerated>
    <description>...</description>
    <targetManagedObjectTypes>...</targetManagedObjectTypes>
    <name>...</name>
    <value>...</value>
    <costItems>
      <name>...</name>
      <cost>...</cost>
      <costFormula>...</costFormula>
    </costItems>
    <regularExpression>...</regularExpression>
    <validationMessage>...</validationMessage>
  </Attributes>
  <primaryOwner xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </primaryOwner>
  <expiryDate>...</expiryDate>
</ComplianceData>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
...
                
              

POST /webservices/services/rest/v2/vms/{id}/action/applyeof

Apply the end of life state to the specified VM [true or false].

Request Parameters
name type description constraints
id path the id long
Request Body
media type data type description
text/plain (custom) the end of life state
Response Body
media type data type description
application/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/vms/{id}/action/applyeof
Content-Type: text/plain
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
...
                
              

POST /webservices/services/rest/v2/vms/{id}/action/applyexpirydate

Apply expiry date to the specified VM [Empty string = No Expiry, 0 = Never Expires, and > 0 = expiry date set].

Request Parameters
name type description constraints
id path the id long
Request Body
media type data type description
text/plain (custom) the expiry date
Response Body
media type data type description
application/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/vms/{id}/action/applyexpirydate
Content-Type: text/plain
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
...
                
              

POST /webservices/services/rest/v2/vms/{id}/action/applyexpirygroup

Apply an expiry group to the specified VM.

Request Parameters
name type description constraints
id path the id long
Request Body
media type data type description
text/plain (custom) the expiry group
Response Body
media type data type description
application/xml TaskInfo (XML) the WS task info

Example

Request
POST /webservices/services/rest/v2/vms/{id}/action/applyexpirygroup
Content-Type: text/plain
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

POST /webservices/services/rest/v2/vms/{id}/action/applymaintenancegroup

Apply maintenance group to the specified VM.

Request Parameters
name type description constraints
id path the id long
Request Body
media type data type description
text/plain (custom) the maintenance group
Response Body
media type data type description
application/xml TaskInfo (XML) the WS task info

Example

Request
POST /webservices/services/rest/v2/vms/{id}/action/applymaintenancegroup
Content-Type: text/plain
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

POST /webservices/services/rest/v2/vms/{id}/action/applyownership

Apply ownership to the specified VM.

Request Parameters
name type description constraints
id path ID of the VM to apply ownership to long
Request Body
media type data type description
application/xml Ownership (XML) Ownership information to apply to the VM
Response Body
media type data type description
application/xml TaskInfo (XML) WSTaskInfo that can be monitored to determine when the apply ownership task completes

Example

Request
POST /webservices/services/rest/v2/vms/{id}/action/applyownership
Content-Type: application/xml
Accept: application/xml

                
<Ownership xsitype="...">
  <organization xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organization>
  <Owners xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </Owners>
</Ownership>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

POST /webservices/services/rest/v2/vms/{id}/action/applypowergroup

Apply power schedule group to the specified VM.

Request Parameters
name type description constraints
id path the id long
Request Body
media type data type description
text/plain (custom) the power schedule group
Response Body
media type data type description
application/xml TaskInfo (XML) the WS task info

Example

Request
POST /webservices/services/rest/v2/vms/{id}/action/applypowergroup
Content-Type: text/plain
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

POST /webservices/services/rest/v2/vms/{id}/action/applyrightsizinggroup

Apply rightsizing group to the specified VM.

Request Parameters
name type description constraints
id path the id long
Request Body
media type data type description
text/plain (custom) the rightsizing group
Response Body
media type data type description
application/xml TaskInfo (XML) the WS task info

Example

Request
POST /webservices/services/rest/v2/vms/{id}/action/applyrightsizinggroup
Content-Type: text/plain
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

POST /webservices/services/rest/v2/vms/{id}/action/applysuspect

Apply the suspect state to the specified VM [true or false].

Request Parameters
name type description constraints
id path the id long
Request Body
media type data type description
text/plain (custom) the suspect state
Response Body
media type data type description
application/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/vms/{id}/action/applysuspect
Content-Type: text/plain
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
...
                
              

POST /webservices/services/rest/v2/vms/{id}/action/requestchange

This method has been deprecated.

Make a change request for the specified VM.

Request Parameters
name type description constraints
id path the VM Id long
Request Body
media type data type description
application/xml ChangeRequestParam (XML) the change request parameter
Response Body
media type data type description
application/xml anyType (XML) the HTTP response

Example

Request
POST /webservices/services/rest/v2/vms/{id}/action/requestchange
Content-Type: application/xml
Accept: application/xml

                
<ChangeRequestParam>
  <formElements>
    <RequestFormElements>
      <label>...</label>
      <mandatory>...</mandatory>
      <formType>...</formType>
      <value>...</value>
    </RequestFormElements>
  </formElements>
  <formId>...</formId>
</ChangeRequestParam>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
...
                
              

POST /webservices/services/rest/v2/vms/{id}/action/resetexpiryextensionsperformed

Reset expiry extensions performed for the specified VM.

Request Parameters
name type description constraints
id path the id long
Response Body
media type data type description
application/xml anyType (XML) the response

Example

Request
POST /webservices/services/rest/v2/vms/{id}/action/resetexpiryextensionsperformed
Content-Type: text/plain
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
...
                
              

POST /webservices/services/rest/v2/vms/{id}/action/share

Share the specified VM.

Request Parameters
name type description constraints
id path the id long
Request Body
media type data type description
application/xml ShareOptions (XML) the share options
Response Body
media type data type description
application/xml ShareResult (XML) the WS share result

Example

Request
POST /webservices/services/rest/v2/vms/{id}/action/share
Content-Type: application/xml
Accept: application/xml

                
<ShareOptions xsitype="...">
  <serviceName>...</serviceName>
  <serviceDescription>...</serviceDescription>
  <daysUntilExpired>...</daysUntilExpired>
  <notifyRecipients>...</notifyRecipients>
  <keepSourceOwnership>...</keepSourceOwnership>
  <saveMemoryState>...</saveMemoryState>
  <emailSubject>...</emailSubject>
  <emailComments>...</emailComments>
  <sharedOrganization xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </sharedOrganization>
  <sharedUsers xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </sharedUsers>
</ShareOptions>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<ShareResult>
  <organizationId>...</organizationId>
  <serviceId>...</serviceId>
  <portalUrl>...</portalUrl>
  <vcommanderUrl>...</vcommanderUrl>
  <VCommanderServiceLink>...</VCommanderServiceLink>
  <portalServiceLink>...</portalServiceLink>
</ShareResult>

                
              

POST /webservices/services/rest/v2/vms/{id}/action/submitchange

Make a change request for the specified VM.

Request Parameters
name type description constraints
id path the VM Id long
Request Body
media type data type description
application/xml ChangeRequestParam (XML) the change request parameter
Response Body
media type data type description
application/xml Request (XML) the submitted request DTO

Example

Request
POST /webservices/services/rest/v2/vms/{id}/action/submitchange
Content-Type: application/xml
Accept: application/xml

                
<ChangeRequestParam>
  <formElements>
    <RequestFormElements>
      <label>...</label>
      <mandatory>...</mandatory>
      <formType>...</formType>
      <value>...</value>
    </RequestFormElements>
  </formElements>
  <formId>...</formId>
</ChangeRequestParam>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<Request>
  <id>...</id>
  <organization xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organization>
  <state>...</state>
  <type>...</type>
  <requestDate>...</requestDate>
  <fulfillDate>...</fulfillDate>
  <formVersion>...</formVersion>
  <requester>...</requester>
  <assignedAdmin>...</assignedAdmin>
  <waitingOn>...</waitingOn>
  <requiredBy>...</requiredBy>
  <targetService xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </targetService>
  <duration>...</duration>
  <requestFailed>...</requestFailed>
</Request>

                
              

GET /webservices/services/rest/v2/vms/{id}/metadata/changerequestparams/{formid}

Retrieve parameters needed for a VM change request using the specified form.

Request Parameters
name type description constraints
formid path the form id long
id path the id long
Response Body
media type data type description
application/xml ChangeRequestParam (XML) the VM change request requirement

Example

Request
GET /webservices/services/rest/v2/vms/{id}/metadata/changerequestparams/{formid}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<ChangeRequestParam>
  <formElements>
    <RequestFormElements>
      <label>...</label>
      <mandatory>...</mandatory>
      <formType>...</formType>
      <value>...</value>
    </RequestFormElements>
  </formElements>
  <formId>...</formId>
</ChangeRequestParam>

                
              

POST /webservices/services/rest/v2/vms/{vm_id}/workflows/{workflow_id}/action/execute

Execute a service (VM) workflow

Request Parameters
name type description constraints
vm_id path the vm id long
workflow_id path the workflow definition id long
Response Body
media type data type description
application/xml TaskInfo (XML) a task info for tracking the progress of the task

Example

Request
POST /webservices/services/rest/v2/vms/{vm_id}/workflows/{workflow_id}/action/execute
Content-Type: text/plain
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

POST /webservices/services/rest/v2/vms/{vmid}/action/createsnapshot

Creates a new snapshot

Request Parameters
name type description default constraints
description form description of the snapshot (optional)  
memory form True to capture VM memory (optional) false boolean
name form name of the snapshot    
quiesce form True to quiesce the VM (optional) false boolean
vmid path ID of the VM   long
Response Body
media type data type description
application/xml TaskInfo (XML) A handle to the task

Example

Request
POST /webservices/services/rest/v2/vms/{vmid}/action/createsnapshot
Content-Type: application/x-www-form-urlencoded
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

POST /webservices/services/rest/v2/vms/{vmid}/action/deletesnapshot

Deletes a specific snapshot. One of name, remoteId or snapshotId are required

Request Parameters
name type description default constraints
name form name of the snapshot to delete (optional)  
remoteId form remoteId of the snapshot to delete (optional)  
snapshotId form snapshotId of the snapshot to delete (optional) long
vmid path ID of the VM   long
Response Body
media type data type description
application/xml TaskInfo (XML) A handle to the task

Example

Request
POST /webservices/services/rest/v2/vms/{vmid}/action/deletesnapshot
Content-Type: application/x-www-form-urlencoded
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

POST /webservices/services/rest/v2/vms/{vmid}/action/revertsnapshot

Reverts a VM to a specific snapshot. One of name, remoteId or snapshotId are required

Request Parameters
name type description default constraints
name form name of the snapshot to revert to (optional)  
remoteId form remoteId of the snapshot to revert to (optional)  
snapshotId form snapshotId of the snapshot to revert to (optional) long
vmid path ID of the VMremoteId   long
Response Body
media type data type description
application/xml TaskInfo (XML) A handle to the task

Example

Request
POST /webservices/services/rest/v2/vms/{vmid}/action/revertsnapshot
Content-Type: application/x-www-form-urlencoded
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

POST /webservices/services/rest/v2/vms/{vmid}/disks/{diskkey}/mount

Mount a media file for the specified VM disk.

Request Parameters
name type description constraints
diskkey path the disk key int
vmid path the VM id long
Request Body
media type data type description
application/xml MediaFileMountSpec (XML) the media file parameter
Response Body
media type data type description
application/xml TaskInfo (XML) the task info of the mountMediaFile task

Example

Request
POST /webservices/services/rest/v2/vms/{vmid}/disks/{diskkey}/mount
Content-Type: application/xml
Accept: application/xml

                
<MediaFileMountSpec xsitype="...">
  <mediaFilePath>...</mediaFilePath>
</MediaFileMountSpec>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

POST /webservices/services/rest/v2/vms/{vmid}/disks/{diskkey}/unmount

Unmount a media file from the specified VM disk.

Request Parameters
name type description constraints
diskkey path the disk key int
vmid path the VM id long
Response Body
media type data type description
application/xml TaskInfo (XML) the task info of the unmountMediaFile task

Example

Request
POST /webservices/services/rest/v2/vms/{vmid}/disks/{diskkey}/unmount
Content-Type: application/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

GET /webservices/services/rest/v2/vms/{vmid}/snapshots

Get the list of snapshots for a VM

Request Parameters
name type description constraints
vmid path ID of the VM long
Response Body
media type data type description
application/xml VirtualMachineSnapshotCollection (XML) a list of snapshots

Example

Request
GET /webservices/services/rest/v2/vms/{vmid}/snapshots
Content-Type: application/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<VirtualMachineSnapshotCollection>
  <items>
    <remoteId>...</remoteId>
    <parentId>...</parentId>
    <createTime>...</createTime>
    <creator>...</creator>
    <name>...</name>
    <description>...</description>
    <quiesced>...</quiesced>
    <memory>...</memory>
    <size>...</size>
  </items>
</VirtualMachineSnapshotCollection>

                
              

GET /webservices/services/rest/v2/vms/objecthandle/{object_handle_id}

Retrieve a VM by its object handle ID.

Request Parameters
name type description constraints
object_handle_id path the id long
Response Body
media type data type description
application/xml VirtualMachine (XML) the VM by object handle id

Example

Request
GET /webservices/services/rest/v2/vms/objecthandle/{object_handle_id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<VirtualMachine>
  <objectHandleId>...</objectHandleId>
  <lastDatastoreScanDate>...</lastDatastoreScanDate>
  <configFile>...</configFile>
  <state>...</state>
  <connectionState>...</connectionState>
  <runtimeGUID>...</runtimeGUID>
  <template>...</template>
  <guestOS>...</guestOS>
  <configGuestId>...</configGuestId>
  <numCPU>...</numCPU>
  <memory>...</memory>
  <instanceType>
    <id>...</id>
    <managementServerType>...</managementServerType>
    <instanceFamily>...</instanceFamily>
    <instanceType>...</instanceType>
    <description>...</description>
    <name>...</name>
    <processorArch>...</processorArch>
    <vcpu>...</vcpu>
    <ecu>...</ecu>
    <memory>...</memory>
    <storage>...</storage>
    <instanceStorage>...</instanceStorage>
    <ebsOptimizedAvailable>...</ebsOptimizedAvailable>
    <networkPerformance>...</networkPerformance>
    <maxENIs>...</maxENIs>
    <maxIPsPerENI>...</maxIPsPerENI>
    <availableForSpotInstance>...</availableForSpotInstance>
  </instanceType>
  <availabilitySet>...</availabilitySet>
  <toolStatus>...</toolStatus>
  <ipAddress>...</ipAddress>
  <networkString>...</networkString>
  <macAddressString>...</macAddressString>
  <ipv4AddressString>...</ipv4AddressString>
  <ipv6AddressString>...</ipv6AddressString>
  <dnsName>...</dnsName>
  <operationalStates>...</operationalStates>
  <cpuReservation>...</cpuReservation>
  <cpuLimit>...</cpuLimit>
  <cpuShares>...</cpuShares>
  <cpuSharesLevel>...</cpuSharesLevel>
  <memReservation>...</memReservation>
  <memLimit>...</memLimit>
  <memShares>...</memShares>
  <memSharesLevel>...</memSharesLevel>
  <diskSpaceConsumed>...</diskSpaceConsumed>
  <diskSpaceCommitted>...</diskSpaceCommitted>
  <customizableOS>...</customizableOS>
  <networkCards>
    <macAddress>...</macAddress>
    <adapterType>...</adapterType>
    <uniqueNetId>...</uniqueNetId>
    <logicalNetwork>...</logicalNetwork>
    <name>...</name>
    <addressType>...</addressType>
    <id>...</id>
    <summary>...</summary>
    <uuid>...</uuid>
    <vmId>...</vmId>
    <key>...</key>
    <label>...</label>
    <connected>...</connected>
    <startConnected>...</startConnected>
  </networkCards>
  <disks>
    <size>...</size>
    <diskType>...</diskType>
    <iops>...</iops>
    <diskMode>...</diskMode>
    <fileName>...</fileName>
    <datastore>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </datastore>
    <id>...</id>
    <summary>...</summary>
    <uuid>...</uuid>
    <vmId>...</vmId>
    <key>...</key>
    <label>...</label>
    <connected>...</connected>
    <startConnected>...</startConnected>
  </disks>
  <parent xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </parent>
  <runtimeServer xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </runtimeServer>
  <resourcePool xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </resourcePool>
  <datastores xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </datastores>
  <creationDate>...</creationDate>
  <createdBy>...</createdBy>
  <iamRole>...</iamRole>
  <printEmbedded>...</printEmbedded>
  <existsInInventory>...</existsInInventory>
  <existsOnDisk>...</existsOnDisk>
  <approvalState>...</approvalState>
  <owners xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </owners>
  <eolState>...</eolState>
  <expiryDate>...</expiryDate>
  <expiryExtensionsRemaining>...</expiryExtensionsRemaining>
  <expiryState>...</expiryState>
  <suspectState>...</suspectState>
  <mismatch>...</mismatch>
  <diskSpaceScanned>...</diskSpaceScanned>
  <containerSpaceUsed>...</containerSpaceUsed>
  <cost>...</cost>
  <runningCost>...</runningCost>
  <freeDiskSpace>...</freeDiskSpace>
  <logicalDiskSize>...</logicalDiskSize>
  <snapshotCount>...</snapshotCount>
  <unallocatedDiskSpace>...</unallocatedDiskSpace>
  <unpartitionedDiskSpace>...</unpartitionedDiskSpace>
  <vmScanUser>...</vmScanUser>
  <lastDeployedDate>...</lastDeployedDate>
  <lastInInventoryDate>...</lastInInventoryDate>
  <poweredOffSince>...</poweredOffSince>
  <compliant>...</compliant>
  <organization xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organization>
  <cluster xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </cluster>
  <resourceGroup xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </resourceGroup>
  <reference>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </reference>
  <managementServer>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </managementServer>
  <connected>...</connected>
  <remoteId>...</remoteId>
  <name>...</name>
  <operationalParent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </operationalParent>
  <deployedParent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </deployedParent>
  <repositoryParent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </repositoryParent>
  <datastoreParent>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </datastoreParent>
  <attributes>
    <id>...</id>
    <attribute/>
    <value>...</value>
  </attributes>
  <expiryGroup>
    <name>...</name>
    <description>...</description>
    <targetManagedObjectTypes>...</targetManagedObjectTypes>
    <allowedValues/>
    <portalEditable>...</portalEditable>
    <enumerated>...</enumerated>
    <costItems/>
    <regularExpression>...</regularExpression>
    <validationMessage>...</validationMessage>
    <subList>...</subList>
    <parentId>...</parentId>
    <parentName>...</parentName>
  </expiryGroup>
  <groups>
    <groupType>...</groupType>
    <permanent>...</permanent>
  </groups>
  <managementServerType>...</managementServerType>
</VirtualMachine>

                
              

GET /webservices/services/rest/v2/workflows

Retrieve the list of running workflows. Does not include workflows for completed or rejected requests

Request Parameters
name type description default constraints
max query Maximum number of elements to return 20 int
offset query The index of the first item to return from the result set. Use in combination with max to retrieve in batches. Defaults to 0. 0 int
Response Body
media type data type description
application/xml RunningWorkflowCollection (XML) The running workflows

Example

Request
GET /webservices/services/rest/v2/workflows
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RunningWorkflowCollection>
  <RunningWorkflows>
    <id>...</id>
    <definitionId>...</definitionId>
    <name>...</name>
    <currentStepNumber>...</currentStepNumber>
    <currentStepId>...</currentStepId>
    <currentStepName>...</currentStepName>
    <startTimestamp>...</startTimestamp>
    <completedTimestamp>...</completedTimestamp>
    <workflowType>...</workflowType>
    <initiator>...</initiator>
    <error>...</error>
    <steps>
      <name>...</name>
      <originalObjectId>...</originalObjectId>
    </steps>
    <users>
      <id>...</id>
      <loginId>...</loginId>
      <displayName>...</displayName>
      <email>...</email>
      <itContact>...</itContact>
      <primary>...</primary>
    </users>
    <organization>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organization>
    <comments>
      <userText>...</userText>
      <author>...</author>
      <timestamp>...</timestamp>
      <systemGeneratedText>...</systemGeneratedText>
    </comments>
    <progress>...</progress>
    <target>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </target>
    <status>...</status>
    <request>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </request>
    <duration>...</duration>
    <addOwnerAsAdmin>...</addOwnerAsAdmin>
    <global>...</global>
    <autoDeploy>...</autoDeploy>
  </RunningWorkflows>
</RunningWorkflowCollection>

                
              

GET /webservices/services/rest/v2/workflows/{id}

Retrieve a workflow by ID.

Request Parameters
name type description constraints
id path the workflow id long
Response Body
media type data type description
application/xml RunningWorkflow (XML) the running workflow by id

Example

Request
GET /webservices/services/rest/v2/workflows/{id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RunningWorkflow>
  <id>...</id>
  <definitionId>...</definitionId>
  <name>...</name>
  <currentStepNumber>...</currentStepNumber>
  <currentStepId>...</currentStepId>
  <currentStepName>...</currentStepName>
  <startTimestamp>...</startTimestamp>
  <completedTimestamp>...</completedTimestamp>
  <workflowType>...</workflowType>
  <initiator>...</initiator>
  <error>...</error>
  <steps xsitype="...">
    <name>...</name>
    <originalObjectId>...</originalObjectId>
  </steps>
  <users xsitype="...">
    <id>...</id>
    <loginId>...</loginId>
    <displayName>...</displayName>
    <email>...</email>
    <itContact>...</itContact>
    <primary>...</primary>
  </users>
  <organization xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </organization>
  <comments>
    <userText>...</userText>
    <author>...</author>
    <timestamp>...</timestamp>
    <systemGeneratedText>...</systemGeneratedText>
  </comments>
  <progress>...</progress>
  <target xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </target>
  <status>...</status>
  <request xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </request>
  <duration>...</duration>
  <addOwnerAsAdmin>...</addOwnerAsAdmin>
  <global>...</global>
  <autoDeploy>...</autoDeploy>
</RunningWorkflow>

                
              

POST /webservices/services/rest/v2/workflows/{id}/action/skip

Skips all the steps of the specified workflow.

Request Parameters
name type description constraints
id path ID of the target running workflow long
Request Body
media type data type description
text/plain (custom) Comment explaining why - this is mandatory
Response Body
media type data type description
application/xml TaskInfo (XML) Task info that can be monitored to see when task completes successfully.

Example

Request
POST /webservices/services/rest/v2/workflows/{id}/action/skip
Content-Type: text/plain
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

GET /webservices/services/rest/v2/workflows/{id}/steps

Retrieve steps of the specified workflow.

Request Parameters
name type description constraints
id path the workflow id long
Response Body
media type data type description
application/xml WorkflowStepCollection (XML) the running workflow steps

Example

Request
GET /webservices/services/rest/v2/workflows/{id}/steps
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<WorkflowStepCollection>
  <WorkflowSteps>
    <id>...</id>
    <name>...</name>
    <type>...</type>
    <stepNumber>...</stepNumber>
    <runningWorkflowId>...</runningWorkflowId>
    <condition>...</condition>
    <alreadyActioned>...</alreadyActioned>
    <startTimestamp>...</startTimestamp>
    <completedTimestamp>...</completedTimestamp>
    <error>...</error>
    <skipped>...</skipped>
    <duration>...</duration>
    <guestOSCredential>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </guestOSCredential>
    <domainCredential>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </domainCredential>
  </WorkflowSteps>
</WorkflowStepCollection>

                
              

GET /webservices/services/rest/v2/workflows/{id}/steps/{step_id}

Retrieve a workflow step by ID.

Request Parameters
name type description constraints
id path the workflow id long
step_id path the step id long
Response Body
media type data type description
application/xml WorkflowStep (XML) the running workflow step by id

Example

Request
GET /webservices/services/rest/v2/workflows/{id}/steps/{step_id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<WorkflowStep>
  <id>...</id>
  <name>...</name>
  <type>...</type>
  <stepNumber>...</stepNumber>
  <runningWorkflowId>...</runningWorkflowId>
  <condition>...</condition>
  <alreadyActioned>...</alreadyActioned>
  <startTimestamp>...</startTimestamp>
  <completedTimestamp>...</completedTimestamp>
  <error>...</error>
  <skipped>...</skipped>
  <duration>...</duration>
  <guestOSCredential xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </guestOSCredential>
  <domainCredential xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </domainCredential>
</WorkflowStep>

                
              

POST /webservices/services/rest/v2/workflows/{id}/steps/action/repeat

Repeats the current step of the specified workflow.

Request Parameters
name type description constraints
id path ID of the target running workflow long
Request Body
media type data type description
text/plain (custom) Comment explaining why - this is mandatory
Response Body
media type data type description
application/xml TaskInfo (XML) Task info that can be monitored to see when task completes successfully.

Example

Request
POST /webservices/services/rest/v2/workflows/{id}/steps/action/repeat
Content-Type: text/plain
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

POST /webservices/services/rest/v2/workflows/{id}/steps/action/skip

Skips the current step for the specified workflow.

Request Parameters
name type description constraints
id path ID of the target running workflow long
Request Body
media type data type description
text/plain (custom) Comment explaining why - this is mandatory
Response Body
media type data type description
application/xml TaskInfo (XML) Task info that can be monitored to see when task completes successfully.

Example

Request
POST /webservices/services/rest/v2/workflows/{id}/steps/action/skip
Content-Type: text/plain
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
<TaskInfo>
  <state>...</state>
  <userid>...</userid>
  <name>...</name>
  <timeSubmitted>...</timeSubmitted>
  <timeStarted>...</timeStarted>
  <timeCompleted>...</timeCompleted>
  <source>...</source>
  <destination>...</destination>
  <percentComplete>...</percentComplete>
  <relatedObjects xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </relatedObjects>
  <finalState>...</finalState>
  <correlationId>...</correlationId>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</TaskInfo>

                
              

GET /webservices/services/rest/v2/workflows/metadata/approvers/{one_email_address}

Retrieve all running workflows that are pending approval from the specified approver. Example: If we have "bob@embotics.com;sally@embotics.com" as approvers, then "sally@embotics.com" will match, while "sally" alone will not.

Request Parameters
name type description default constraints
one_email_address path Email address of approver    
max query the max count 20 int
offset query The index of the first item to return from the result set. Use in combination with max to retrieve in batches. Defaults to 0. 0 int
Response Body
media type data type description
application/xml RunningWorkflowCollection (XML) the running workflows by pending approver

Example

Request
GET /webservices/services/rest/v2/workflows/metadata/approvers/{one_email_address}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RunningWorkflowCollection>
  <RunningWorkflows>
    <id>...</id>
    <definitionId>...</definitionId>
    <name>...</name>
    <currentStepNumber>...</currentStepNumber>
    <currentStepId>...</currentStepId>
    <currentStepName>...</currentStepName>
    <startTimestamp>...</startTimestamp>
    <completedTimestamp>...</completedTimestamp>
    <workflowType>...</workflowType>
    <initiator>...</initiator>
    <error>...</error>
    <steps>
      <name>...</name>
      <originalObjectId>...</originalObjectId>
    </steps>
    <users>
      <id>...</id>
      <loginId>...</loginId>
      <displayName>...</displayName>
      <email>...</email>
      <itContact>...</itContact>
      <primary>...</primary>
    </users>
    <organization>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organization>
    <comments>
      <userText>...</userText>
      <author>...</author>
      <timestamp>...</timestamp>
      <systemGeneratedText>...</systemGeneratedText>
    </comments>
    <progress>...</progress>
    <target>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </target>
    <status>...</status>
    <request>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </request>
    <duration>...</duration>
    <addOwnerAsAdmin>...</addOwnerAsAdmin>
    <global>...</global>
    <autoDeploy>...</autoDeploy>
  </RunningWorkflows>
</RunningWorkflowCollection>

                
              

GET /webservices/services/rest/v2/workflows/metadata/initiators/{login_id}

Retrieve all running workflows by login ID of the initiator. Does not include workflows for completed or rejected requests

Request Parameters
name type description default constraints
login_id path Login ID of the workflow initiator    
max query Maximum number of elements to return 20 int
offset query The index of the first item to return from the result set. Use in combination with max to retrieve in batches. Defaults to 0. 0 int
Response Body
media type data type description
application/xml RunningWorkflowCollection (XML) the running workflows by initiator

Example

Request
GET /webservices/services/rest/v2/workflows/metadata/initiators/{login_id}
Content-Type: text/xml
Accept: application/xml

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<RunningWorkflowCollection>
  <RunningWorkflows>
    <id>...</id>
    <definitionId>...</definitionId>
    <name>...</name>
    <currentStepNumber>...</currentStepNumber>
    <currentStepId>...</currentStepId>
    <currentStepName>...</currentStepName>
    <startTimestamp>...</startTimestamp>
    <completedTimestamp>...</completedTimestamp>
    <workflowType>...</workflowType>
    <initiator>...</initiator>
    <error>...</error>
    <steps>
      <name>...</name>
      <originalObjectId>...</originalObjectId>
    </steps>
    <users>
      <id>...</id>
      <loginId>...</loginId>
      <displayName>...</d