Get Approval Requests V3
Returns approval requests
Request
URI
GET
https://vra-interop-222-139.lvn.broadcom.net/approval/api/approvals
COPY
Query Parameters
string
requestState
Optional
requestState
Possible values are :
APPROVED,
REJECTED,
PENDING,
EXPIRED,
CANCELLED,
string
approverState
Optional
approverState
Possible values are :
APPROVED,
REJECTED,
PENDING,
EXPIRED,
CANCELLED,
string
search
Optional
Searching is enabled on following attributes: deploymentId, deploymentName, projectId, projectName, requestedBy or action.
boolean
filterEntitledRequests
Optional
Flag for approval admin to filter the approval requests which has himself/herself as one of the approver
string
apiVersion
Optional
The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /approval/api/about
integer
page
Optional
Results page you want to retrieve (0..N)
integer
size
Optional
Number of records per page.
string
sort
Optional
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending.
Header Parameters
string
Accept
Optional
Accept
Responses
200
Success - returns approval requests
Returns
PageDeploymentApprovalRequest
of type(s)
application/json
{
"content": [
{
"action": "string",
"adminActioned": false,
"adminDetails": {
"comment": "string"
},
"adminName": "string",
"autoApproval": false,
"createdAt": "string",
"currentLevel": 0,
"decision": "string",
"deploymentId": "string",
"deploymentName": "string",
"expired": false,
"expiryAt": "string",
"expiryComment": "string",
"id": "string",
"lastUpdatedAt": "string",
"levels": [
{
"adminActioned": false,
"adminDetails": {
"comment": "string"
},
"adminName": "string",
"appliedPolicies": [
{
"approvers": [
{
"actionedAt": "string",
"actionedBy": "string",
"approver": "string",
"approverType": "string",
"comments": "string",
"id": "string",
"isActive": false,
"level": 0,
"status": "string"
}
],
"id": "string",
"level": 0,
"mode": "string",
"policyId": "string",
"policyName": "string",
"status": "string"
}
],
"id": "string",
"lastUpdatedAt": "string",
"level": 0,
"status": "string"
}
],
"orgId": "string",
"projectId": "string",
"projectName": "string",
"requestDetails": {
"blueprintDetails": {
"id": "string",
"name": "string",
"version": "string"
},
"catalogDetails": {
"id": "string",
"name": "string",
"version": "string"
},
"deploymentDetails": {
"currency": "string",
"deploymentCreationCost": "number"
},
"inputs": {},
"resourceDetails": {
"resourceDetails": [
{
"name": "string",
"properties": {
"properties": "string"
},
"type": "string"
}
]
}
},
"requestId": "string",
"requestedBy": "string",
"status": "string",
"totalLevels": 0
}
],
"empty": false,
"first": false,
"last": false,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": false,
"sort": [
{
"ascending": false,
"direction": "string",
"ignoreCase": false,
"nullHandling": "string",
"property": "string"
}
],
"unpaged": false
},
"size": 0,
"sort": [
{
"ascending": false,
"direction": "string",
"ignoreCase": false,
"nullHandling": "string",
"property": "string"
}
],
"totalElements": 0,
"totalPages": 0
}
array of
object
content
Optional
content
boolean
empty
Optional
empty
boolean
first
Optional
first
boolean
last
Optional
last
integer As int32
As int32
number
Optional
number
integer As int32
As int32
numberOfElements
Optional
numberOfElements
object
pageable
Optional
pageable
integer As int32
As int32
size
Optional
size
array of
object
sort
Optional
sort
integer As int64
As int64
totalElements
Optional
totalElements
integer As int32
As int32
totalPages
Optional
totalPages
401
Unauthorized
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/approval/api/approvals