Get Reclamation Requests

Get Reclamation Requests

Get all the reclamation requests.

Request
URI
GET
https://{api_host}/management-service/api/management/requests
COPY
Query Parameters
integer
page
Optional
Constraints: default: 1

Page Number

integer
limit
Optional
Constraints: default: 20

Number of entries per page

string
$orderby
Optional

Multiple comma-separated properties sorted in ascending or descending order

integer
$top
Optional

Sets the number of returned entries from the top of the response (total number per page in relation to skip)

integer
$skip
Optional

Sets how many entries you would like to skip

string
$filter
Optional

Boolean expression for whether a particular entry should be included in the response

Responses
200

Success - return the paginated list of reclamation requests.

Returns ReclamationDetails of type(s) */* 
{
    "assignedDate": "string",
    "resourceId": "string",
    "requestReason": "string",
    "waitBeforeForcingLeasePeriod": 0,
    "currentLeaseExpiryDate": "string",
    "workItemId": "string",
    "userComments": "string",
    "machineName": "string",
    "iaasMachineId": "string",
    "requestor": "string",
    "ownerName": "string",
    "dailyCost": "number",
    "newLeasePeriod": 0,
    "id": 0,
    "state": "string",
    "requireAdditionalNotification": false,
    "currencyCode": "string",
    "tenant": "string"
}
string As date-time As date-time
assignedDate
Required

assignedDate

string
resourceId
Optional
Constraints: minLength: 0 maxLength: 255

resourceId

string
requestReason
Required
Constraints: minLength: 0 maxLength: 2000

requestReason

integer As int32 As int32
waitBeforeForcingLeasePeriod
Required

waitBeforeForcingLeasePeriod

string As date-time As date-time
currentLeaseExpiryDate
Optional

currentLeaseExpiryDate

string
workItemId
Optional
Constraints: minLength: 0 maxLength: 255

workItemId

string
userComments
Optional
Constraints: minLength: 0 maxLength: 2000

userComments

string
machineName
Required

machineName

string
iaasMachineId
Optional
Constraints: minLength: 0 maxLength: 255

iaasMachineId

string
requestor
Required
Constraints: minLength: 1 maxLength: 255

requestor

string
ownerName
Required
Constraints: minLength: 1 maxLength: 255

ownerName

number As double As double
dailyCost
Required

dailyCost

integer As int32 As int32
newLeasePeriod
Required

newLeasePeriod

integer As int64 As int64
id
Optional

id

string
state
Required

state

Possible values are : PENDING, APPROVED, REJECTED, EXPIRED, CANCELED,
boolean
requireAdditionalNotification
Required

requireAdditionalNotification

string
currencyCode
Optional

currencyCode

string
tenant
Required
Constraints: minLength: 1 maxLength: 255

tenant


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/management-service/api/management/requests
On This Page
Reclamation Operations
POST
Cancel Reclamation Requests
PUT
Get Certificate
POST
Process Callback
POST
Create Management Endpoint
GET
Get Management Endpoint
DELETE
Remove Management Endpoint
PUT
Update Management Endpoint
PUT
Get Vm Performance Metrics
GET
Is Vrops Configured
PUT
Test Connection
GET
Get Vm Performance Metrics For Vm
GET
Get Reclamation Requests
POST
Create Work Items