v2 API Resource

GET /webservices/services/rest/v2/accounts

Retrieve all accounts.

Example

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

                
...
                
              

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>
    <organizationName>...</organizationName>
  </Accounts>
</AccountCollection>

                
              

POST /webservices/services/rest/v2/accounts

Create a user account.

Example

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>
  <organizationName>...</organizationName>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Account>

                
              

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>
  <organizationName>...</organizationName>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Account>

                
              

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

Delete an account.

Example

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

                
...
                
              

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

                
...
                
              

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

Retrieve an account by id.

Example

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

                
...
                
              

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>
  <organizationName>...</organizationName>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Account>

                
              

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

Update an account

Example

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>
  <organizationName>...</organizationName>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Account>

                
              

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>
  <organizationName>...</organizationName>
  <displayName>...</displayName>
  <type>...</type>
  <id>...</id>
</Account>

                
              

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

Set an account role assignments.

Example

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

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

                
              

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.

Example

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

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

                
              

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.

Example

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

                
...
                
              

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

Example

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

                
...
                
              

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

                
...
                
              

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

Clears the account cache

Example

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

                
...
                
              

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

                
...
                
              

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

Create an organization.

Example

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>

                
              

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.

Example

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>

                
              

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

Example

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

                
...
                
              

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.

Example

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>

                
              

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.

Example

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

                
...
                
              

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

                
...
                
              

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

Retrieve a custom attribute by ID.

Example

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

                
...
                
              

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.

Example

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>

                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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/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.

Example

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

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

                
              

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)

Example

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

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

                
              

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

Example

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

                
...
                
              

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

Example

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>

                
              

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.

Example

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>

                
              

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.

Example

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

                
...
                
              

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

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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

Example

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

                
...
                
              

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

Example

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

                
...
                
              

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.

Example

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>

                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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>

                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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

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

                
              

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

                
...
                
              

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

Delete network zone.

Example

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

                
...
                
              

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

                
...
                
              

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

Gets the network zone by id.

Example

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

                
...
                
              

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

Example

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

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

                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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

Create an organization.

Example

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>

                
              

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.

Example

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

                
...
                
              

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}

Edit an organization.

Example

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>

                
              

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

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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

                
...
                
              

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

Retrieve the list of workflow definitions.

Example

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

                
...
                
              

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.

Example

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>

                
              

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.

Example

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

                
...
                
              

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

                
...
                
              

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

Retrieve a workflow definition by ID.

Example

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

                
...
                
              

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.

Example

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>

                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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

Example

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

                
...
                
              

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

                
...
                
              

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

Import a collection of workflow definitions.

Example

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

                
...
                
              

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

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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

                
...
                
              

GET /webservices/services/rest/v2/credentials

Retrieve a collection of shared credentials (without passwords).

Example

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

                
...
                
              

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

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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

Example

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

                
...
                
              

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

Example

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

                
...
                
              

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.

Example

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

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

                
              

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.

Example

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

                
...
                
              

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

                
...
                
              

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

Retrieve a custom component type by ID.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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>

                
              

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.

Example

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

                
...
                
              

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

                
...
                
              

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

Retrieve deployment destination by Id.

Example

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

                
...
                
              

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.

Example

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>

                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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

Example

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

                
...
                
              

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

                
...
                
              

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

Retrieve deployment destination by name.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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

                
<RequestFormCollection>
  <RequestForms xsitype="...">
    <formId>...</formId>
    <version>...</version>
    <menuText>...</menuText>
    <displayName>...</displayName>
    <requestType>...</requestType>
    <formComponentType>...</formComponentType>
    <changeRequestTargetType>...</changeRequestTargetType>
    <RequestFormElements>
      <label>...</label>
      <mandatory>...</mandatory>
      <formType>...</formType>
      <value>...</value>
    </RequestFormElements>
    <display>...</display>
    <expression>...</expression>
    <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.

Example

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>
  <changeRequestTargetType>...</changeRequestTargetType>
  <RequestFormElements xsitype="...">
    <label>...</label>
    <mandatory>...</mandatory>
    <formType>...</formType>
    <value>...</value>
  </RequestFormElements>
  <display>...</display>
  <expression>...</expression>
  <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>

                
              

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

                
<RequestForm xsitype="...">
  <formId>...</formId>
  <version>...</version>
  <menuText>...</menuText>
  <displayName>...</displayName>
  <requestType>...</requestType>
  <formComponentType>...</formComponentType>
  <changeRequestTargetType>...</changeRequestTargetType>
  <RequestFormElements xsitype="...">
    <label>...</label>
    <mandatory>...</mandatory>
    <formType>...</formType>
    <value>...</value>
  </RequestFormElements>
  <display>...</display>
  <expression>...</expression>
  <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.

Example

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

                
...
                
              

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

                
...
                
              

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

Update a request form.

Example

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>
  <changeRequestTargetType>...</changeRequestTargetType>
  <RequestFormElements xsitype="...">
    <label>...</label>
    <mandatory>...</mandatory>
    <formType>...</formType>
    <value>...</value>
  </RequestFormElements>
  <display>...</display>
  <expression>...</expression>
  <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>

                
              

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

                
<RequestForm xsitype="...">
  <formId>...</formId>
  <version>...</version>
  <menuText>...</menuText>
  <displayName>...</displayName>
  <requestType>...</requestType>
  <formComponentType>...</formComponentType>
  <changeRequestTargetType>...</changeRequestTargetType>
  <RequestFormElements xsitype="...">
    <label>...</label>
    <mandatory>...</mandatory>
    <formType>...</formType>
    <value>...</value>
  </RequestFormElements>
  <display>...</display>
  <expression>...</expression>
  <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.

Example

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

                
...
                
              

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

                
<RequestForm xsitype="...">
  <formId>...</formId>
  <version>...</version>
  <menuText>...</menuText>
  <displayName>...</displayName>
  <requestType>...</requestType>
  <formComponentType>...</formComponentType>
  <changeRequestTargetType>...</changeRequestTargetType>
  <RequestFormElements xsitype="...">
    <label>...</label>
    <mandatory>...</mandatory>
    <formType>...</formType>
    <value>...</value>
  </RequestFormElements>
  <display>...</display>
  <expression>...</expression>
  <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.

Example

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

                
...
                
              

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

Example

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

                
...
                
              

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

                
...
                
              

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

Import all request forms.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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

                
<RequestFormCollection>
  <RequestForms xsitype="...">
    <formId>...</formId>
    <version>...</version>
    <menuText>...</menuText>
    <displayName>...</displayName>
    <requestType>...</requestType>
    <formComponentType>...</formComponentType>
    <changeRequestTargetType>...</changeRequestTargetType>
    <RequestFormElements>
      <label>...</label>
      <mandatory>...</mandatory>
      <formType>...</formType>
      <value>...</value>
    </RequestFormElements>
    <display>...</display>
    <expression>...</expression>
    <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

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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

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

                
              

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.

Example

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

                
...
                
              

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.

Example

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>

                
              

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

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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

Example

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

                
...
                
              

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.

Example

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>

                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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>

                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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

Example

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

                
...
                
              

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.

Example

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

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

                
              

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

                
...
                
              

GET /webservices/services/rest/v2/placementattributes

Retrieve all placement attributes

Example

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

                
...
                
              

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.

Example

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

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

                
              

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.

Example

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

                
...
                
              

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

                
...
                
              

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

Retrieve a specific placement attribute

Example

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

                
...
                
              

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.

Example

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>

                
              

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

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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.

Example

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>

                
              

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.

Example

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

                
...
                
              

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

                
...
                
              

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

Retrieve a policy by Id.

Example

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

                
...
                
              

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.

Example

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>

                
              

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.

Example

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

                
...
                
              

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.

Example

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

                
...
                
              

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

Example

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

                
...
                
              

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

Example

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

                
...
                
              

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.

Example

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>

                
              

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.

Example

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

                
...
                
              

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

                
...
                
              

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

Retrieve a published service by ID.

Example

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

                
...
                
              

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.