Reservation API
The Reservation API uses Representational State Transfer (REST) web services that enable you to create, retrieve, update, delete, and work with reservations. You can integrate the API with your other business applications. The API is exposed by the Data Hub component and is located at the following path on the TrueSight Capacity Optimization Data Hub server: https://<datahubHost>:8280/dh-services/rsv
Before you begin
Ensure that the following requirements are met:
- The appropriate read or write activity is assigned to your user role to access the API. For more information, see Adding and managing roles.
Valid user credentials or a bearer token is available for authentication. For more information, see Accessing the public APIs.
API methods
The following table provides the details of the Reservation API methods:
Resource | Method | URI pattern | Description | Required activity |
---|---|---|---|---|
Reservations | GET |
| Retrieve data for an existing reservation, along with alert status information. | Read access to Reservation API |
PUT |
| Update an existing reservation and perform the placement, if items are specified. You can update an existing reservation to do the placement, select a pool, update the resources and update the status of the reservation. | Write access to Reservation API | |
POST | rsv/reservations | Create a new reservation and perform the placement, if items are specified. Alert status information is also listed. | Write access to Reservation API | |
DELETE |
| Delete an existing reservation. | Write access to Reservation API | |
POST |
| Search for reservations that match query criteria. | Read access to Reservation API | |
GET |
| Retrieve the details of a reservation item. | Read access to Reservation API | |
PUT |
| Update a reservation item. | Write access to Reservation API | |
DELETE |
| Delete a reservation item. | Write access to Reservation API | |
| GET |
| Retrieve the details of an existing offboarding. | Read access to Reservation API |
PUT | rsv/offboardings/{offboarding-id} | Update an existing offboarding. | Write access to Reservation API | |
POST | rsv/offboardings | Create a new offboarding. | Write access to Reservation API | |
DELETE |
| Delete an existing offboarding. | Write access to Reservation API | |
POST |
| Search for an existing offboarding based on query criteria. | Read access to Reservation API | |
Onboardings | GET |
| Retrieve the details of an existing onboarding. | Read access to Reservation API |
PUT |
| Update an existing onboarding. | Write access to Reservation API | |
POST |
| Create a new onboarding. | Write access to Reservation API | |
DELETE |
| Delete an existing onboarding. | Write access to Reservation API | |
POST |
| Search for an existing onboarding based on query criteria. | Read access to Reservation API | |
Reservation targets | GET |
| Retrieve the details of a reservation target. | Read access to Reservation API |
POST |
| Search for a reservation target based on query criteria. | Read access to Reservation API | |
GET |
| Retrieve the details of an existing capacity pool. | Read access to Reservation API | |
POST |
| Search for a capacity pool based on query criteria. | Read access to Reservation API | |
Tenants | GET |
| Retrieve tenant details with alert status information. | Read access to Reservation API |
POST |
| Search for tenants based on query criteria. | Read access to Reservation API | |
GET |
| Retrieve the details of a system template. | Read access to Reservation API | |
PUT |
| Update a system template. | Write access to Reservation API | |
POST | rsv/systemtemplates | Create a new system template. | Write access to Reservation API | |
DELETE |
| Delete a system template. | Write access to Reservation API | |
POST |
| Search for a system template based on query criteria. | Read access to Reservation API | |
Service templates | GET |
| Retrieve the details of a service template. | Read access to Reservation API |
POST | rsv/search/servicetemplates | Search for a service template based on query criteria. | Read access to Reservation API |
Reservation
Info
- For a reservation with resources, placement is not possible. You can use PUT call after you create the reservation, to place it.
If a Reservation is placed, with POST or PUT, the status could stay PROCESSING for a while, until the Auto Forecasting Service (AFS) processes the Reservation. The AFS runs every five minutes. So you may have to wait for maximum five minutes, to see the updated status:
- REQUEST_COMMIT
- REQUEST_PENDING
- REQUEST_REALIZE
- REQUEST_EXPIRE
- REQUEST_DECLINE
- A reservation can be automatically committed only after you perform the placement. Even if you create a reservation with auto-commit
Get data for a reservation
Retrieves data for an existing reservation, along with alert status information.
HTTP method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
GET |
| Reservation ID |
Sample request and response files
Update an existing reservation
Updates an existing reservation and does the placement, if items are specified. You can update an existing reservation to do the placement, select a pool, update the resources and update the status of the reservation.
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
PUT |
|
|
|
Sample request and response files
Create a new reservation
Creates a new reservation and does the placement, if items are specified. Alert status information is also listed.
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
POST |
|
|
|
Sample request and response files
Delete an existing reservation
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
DELETE |
| Reservation ID |
Sample request and response files
Search for a reservation
Search for reservations that match query criteria
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
POST |
| filters |
Sample request and response files
Get details for a reservation item
Retrieve the details of a reservation item.
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
GET |
|
|
Sample request and response files
The following sample request and response files explain getting details about a reservation item given its id and given the reservation id where the item is used. The request retrieves the details of reservation items. Depending on the reservation configuration, a reservation item can be either a template instance or a custom resource instance and the returned data change accordingly.
Update a reservation item
If a reservation target is already specified, you can change it, but you cannot remove it. If a target is not already specified, you cannot specify a new one.
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
PUT |
|
|
Sample request and response files
Delete a reservation item
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
DELETE |
|
|
Sample request and response files
Offboardings action
Get offboarding details
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
GET |
| Offboarding ID |
Sample request and response files
Update an existing offboarding
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
PUT | rsv/offboardings/{offboarding-id} |
|
|
Sample request and response files
Create a new offboarding
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
POST | rsv/offboardings |
|
|
Sample request and response files
Delete an existing offboarding
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
DELETE |
| Offboarding ID |
Sample request and response files
Search for an existing offboarding based on query criteria
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
POST |
|
|
Sample request and response files
Onboardings action
Get details for an onboarding
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
GET |
| Onboarding ID |
Sample request and response files
Update an existing onboarding
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
PUT |
|
|
|
Sample request and response files
Create a new onboarding
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
POST |
|
|
|
Sample request and response files
Delete an existing onboarding
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
DELETE |
| Onboarding ID |
Sample request and response files
Search for an existing onboarding based on query criteria
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
POST |
|
|
Sample request and response files
Reservation targets action
Get details for a Reservation Target
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
GET |
| Reservation Target ID |
Sample request and response files
Search for a Reservation Target that matches the query criteria
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
POST |
| filters |
Sample request and response files
Capacity pools action
Get data for an existing capacity pool
HTTP method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
GET |
| Capacity Pool ID |
Sample request and response files
Search for capacity pools that match query criteria
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
POST |
|
|
Sample request and response files
Tenants action
Get tenant details and alert status information
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
GET |
| Tenant ID |
Sample request and response files
Search for tenants based on query criteria
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
POST |
|
|
Sample request and response files
System templates action
Get details about a system template
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
GET |
| Template ID |
Sample request and response files
Update a system template
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
PUT |
| Template ID |
|
Sample request and response files
Create a new system template
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
POST | rsv/systemtemplates |
|
|
Sample request and response files
Delete a system template
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
DELETE |
| Template ID |
Sample request and response files
Search for system template based on query criteria
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
POST |
|
|
Sample request and response files
Service templates action
Get details about a service template
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
GET |
| Template ID |
Sample request and response files
Search for service template based on query criteria
Method | URI pattern | Required | Optional Request Parameters |
---|---|---|---|
POST | rsv/search/servicetemplates |
|
Comments
Log in or register to comment.