You can use the REST API reservation service to display a schema definition for a specific vRealize Automation reservation type, for example a vSphere reservation.

Before you begin

  • Log in to vRealize Automation as a fabric group administrator.

  • Verify that the host name and fully qualified domain name of the vRealize Automation instance are available.

  • If you are not using the API Explorer, verify that you have a valid HTTP bearer token that matches your login credentials. See REST API Authentication.

  • Obtain the schema class ID of the reservation type to create. See Display a List of Supported Reservation Types.

Procedure

Display a schema definition for a specific vRealize Automation vSphere reservation type.
curl --insecure -H "Accept:application/json" 
-H "Authorization: Bearer $token" 
https://$host/reservation-service/api/data-service/schema/Infrastructure.Reservation.Virtual.vSphere/default

The schema definition in this example includes 9 extension fields that are supported for the vSphere type reservation.

{
  "fields": [{
    "id": "reservationNetworks",
    "label": "Network",
    "dataType": {
      "type": "complex",
      "componentTypeId": "com.mycompany.csp.iaas.blueprint.service",
      "componentId": null,
      "classId": "reservationNetwork",
      "typeFilter": null,
      "label": "Network"
    },
    "displayAdvice": "DATA_TABLE",
    "permissibleValues": {
      "type": "dynamic",
      "customAllowed": false,
      "dependencies": ["computeResource"]
    },
    "state": {
      "dependencies": [],
      "facets": [{
        "type": "mandatory",
        "value": {
          "type": "constantClause",
          "value": {
            "type": "boolean",
            "value": true
          }
        }
      }]
    },
    "isMultiValued": true
  },
  {
    "id": "reservationVCNSTransportZone",
    "label": "Transport Zone",
    "description": "Transport zone of the vCNS settings",
    "dataType": {
      "type": "ref",
      "componentTypeId": "com.mycompany.csp.iaas.blueprint.service",
      "componentId": null,
      "classId": "NetworkScopes",
      "typeFilter": null,
      "label": "Transport Zone"
    },
    "displayAdvice": null,
    "permissibleValues": {
      "type": "dynamic",
      "customAllowed": false,
      "dependencies": ["computeResource"]
    },
    "state": {
      "dependencies": [],
      "facets": []
    },
    "isMultiValued": false
  },
  {
    "id": "reservationVCNSSecurityGroups",
    "label": "Security Groups",
    "description": "Security groups of the vCNS settings",
    "dataType": {
      "type": "ref",
      "componentTypeId": "com.mycompany.csp.iaas.blueprint.service",
      "componentId": null,
      "classId": "SecurityGroups",
      "typeFilter": null,
      "label": "Security Group"
    },
    "displayAdvice": null,
    "permissibleValues": {
      "type": "dynamic",
      "customAllowed": false,
      "dependencies": ["computeResource"]
    },
    "state": {
      "dependencies": [],
      "facets": []
    },
    "isMultiValued": true
  },
  {
    "id": "reservationMemory",
    "label": "Memory",
    "dataType": {
      "type": "complex",
      "componentTypeId": "com.mycompany.csp.iaas.blueprint.service",
      "componentId": null,
      "classId": "reservationMemory",
      "typeFilter": null,
      "label": "Memory"
    },
    "displayAdvice": "DATA_TABLE",
    "permissibleValues": {
      "type": "dynamic",
      "customAllowed": false,
      "dependencies": ["computeResource"]
    },
    "state": {
      "dependencies": [],
      "facets": [{
        "type": "mandatory",
        "value": {
          "type": "constantClause",
          "value": {
            "type": "boolean",
            "value": true
          }
        }
      }]
    },
    "isMultiValued": false
  },
  {
    "id": "computeResource",
    "label": "Compute Resource",
    "description": "The compute resource for the reservation",
    "dataType": {
      "type": "ref",
      "componentTypeId": "com.mycompany.csp.iaas.blueprint.service",
      "componentId": null,
      "classId": "ComputeResource",
      "typeFilter": "InterfaceTypeId",
      "label": "Compute Resource"
    },
    "displayAdvice": null,
    "permissibleValues": {
      "type": "dynamic",
      "customAllowed": false,
      "dependencies": []
    },
    "state": {
      "dependencies": [],
      "facets": [{
        "type": "mandatory",
        "value": {
          "type": "constantClause",
          "value": {
            "type": "boolean",
            "value": true
          }
        }
      }]
    },
    "isMultiValued": false
  },
  {
    "id": "machineQuota",
    "label": "Machine Quota",
    "description": "The machine quota for the reservation",
    "dataType": {
      "type": "primitive",
      "typeId": "INTEGER"
    },
    "displayAdvice": null,
    "state": {
      "dependencies": [],
      "facets": []
    },
    "isMultiValued": false
  },
  {
    "id": "reservationStorages",
    "label": "Storage",
    "dataType": {
      "type": "complex",
      "componentTypeId": "com.mycompany.csp.iaas.blueprint.service",
      "componentId": null,
      "classId": "reservationStorage",
      "typeFilter": null,
      "label": "Storage"
    },
    "displayAdvice": "DATA_TABLE",
    "permissibleValues": {
      "type": "dynamic",
      "customAllowed": false,
      "dependencies": ["computeResource"]
    },
    "state": {
      "dependencies": [],
      "facets": [{
        "type": "mandatory",
        "value": {
          "type": "constantClause",
          "value": {
            "type": "boolean",
            "value": true
          }
        }
      }]
    },
    "isMultiValued": true
  },
  {
    "id": "resourcePool",
    "label": "Resource Pool",
    "description": "The resource pool for the reservation",
    "dataType": {
      "type": "ref",
      "componentTypeId": "com.mycompany.csp.iaas.blueprint.service",
      "componentId": null,
      "classId": "ResourcePools",
      "typeFilter": null,
      "label": "Resource Pool"
    },
    "displayAdvice": null,
    "permissibleValues": {
      "type": "dynamic",
      "customAllowed": false,
      "dependencies": ["computeResource"]
    },
    "state": {
      "dependencies": [],
      "facets": []
    },
    "isMultiValued": false
  },
  {
    "id": "reservationVCNSRoutedGateways",
    "label": "Routed Gateways",
    "dataType": {
      "type": "complex",
      "componentTypeId": "com.mycompany.csp.iaas.blueprint.service",
      "componentId": null,
      "classId": "reservationVCNSRoutedGateway",
      "typeFilter": null,
      "label": "Routed Gateways"
    },
    "displayAdvice": "DATA_TABLE",
    "permissibleValues": {
      "type": "dynamic",
      "customAllowed": false,
      "dependencies": ["computeResource"]
    },
    "state": {
      "dependencies": [],
      "facets": []
    },
    "isMultiValued": true
  }]
}