Search (SHIFT+S)
API Reference
- Block Services
- File Services
- Object Service
- Compute Services
-
Virtual Data Center Services
- Authentication Provider
- Auto Tiering
- Block Virtual Pool
- File Virtual Pool
- Migration
- Fabric Manager
- Network
- Protection System
- Storage Provider
- SMIS Provider
- Storage Tier
- Storage System
- Storage Port
- Storage Pool
- Trust Store Resource
- UnManaged Volume
- Unmanaged File System
- UnManaged Export Mask
- Virtual Array
- Virtual Data Center Capacity
- Virtual Data Center
- User Group
- Virtual Nas
- Tenant Services
- Config Services
- UI Services
- UI Services (Deprecated)
- System Management Services
- Other Services
- API Error Codes

Create Order
POST /catalog/orders
Required Roles
This call has no restrictions.
Request Payload
All parameters are required unless otherwise stated.
Field | Description | Type | Notes |
<order_create> | |||
<tenantId> | URI | ||
<parameters> |
0-* Elements |
||
<friendly_value> | String | ||
<label> | String | ||
<value> | String | ||
<friendly_label> | String | ||
</parameters> | |||
<catalog_service> | URI | ||
</order_create> |
Response Body
Field | Description | Type | Notes |
<order> | |||
<order_number> | String | ||
<date_completed> | Date | ||
<execution_window> | |||
<id> | ViPR ID of the related object | URI | |
<link> | A hyperlink to the related object | ||
</execution_window> | |||
<message> | String | ||
<catalog_service> | |||
<id> | ViPR ID of the related object | URI | |
<link> | A hyperlink to the related object | ||
</catalog_service> | |||
<order_status> | String | ||
<submitted_by> | String | ||
<summary> | String | ||
<tenant> | |||
<id> | ViPR ID of the related object | URI | |
<link> | A hyperlink to the related object | ||
</tenant> | |||
<last_updated> | Date | ||
<parameters> | |||
<parameter> |
0-* Elements |
||
<friendly_value> | String | ||
<label> | String | ||
<value> | String | ||
<friendly_label> | String | ||
</parameter> | |||
</parameters> | |||
<name> | The name assigned to this resource in ViPR. The resource name is set by a user and can be changed at any time. It is not a unique identifier. | String | |
<id> | An identifier that is generated by ViPR when the resource is created. The resource ID is guaranteed to be unique and immutable across all virtual data centers for all time. | URI |
Valid Values:
|
<link> | A hyperlink to the details for this resource | ||
<creation_time> | A timestamp that shows when this resource was created in ViPR | DateTime |
Valid Values:
|
<tags> | Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search. | ||
<tag> | String |
0-* Elements |
|
</tags> | |||
<inactive> | Whether or not the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ViPR database. | Boolean |
Valid Values:
|
<global> | Boolean | ||
<remote> | Boolean | ||
<vdc> | |||
<id> | ViPR ID of the related object | URI | |
<link> | A hyperlink to the related object | ||
</vdc> | |||
<internal> | Whether or not the resource is an internal resource. | Boolean |
Valid Values:
|
</order> |