Get Approval Request V3

Get Approval Request V3

Returns details of the approval request

Request
URI
GET
https://vra-interop-222-139.lvn.broadcom.net/approval/api/approvals/{id}
COPY
Path Parameters
string
id
Required

approval request id

Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /approval/api/about

Header Parameters
string
Accept
Optional

Accept

Authentication
This operation uses the following authentication methods.
Responses
200

success

Returns DeploymentApprovalRequest of type(s) application/json 
{
    "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
}
string
action
Optional

action

boolean
adminActioned
Optional

adminActioned

object
adminDetails
Optional

adminDetails

string
adminName
Optional

adminName

boolean
autoApproval
Optional

autoApproval

string As date-time As date-time
createdAt
Optional

createdAt

integer As int32 As int32
currentLevel
Optional

currentLevel

string
decision
Optional

decision

Possible values are : APPROVE, REJECT, NO_EXPIRY,
string
deploymentId
Optional

deploymentId

string
deploymentName
Optional

deploymentName

boolean
expired
Optional

expired

string As date-time As date-time
expiryAt
Optional

expiryAt

string
expiryComment
Optional

expiryComment

string As uuid As uuid
id
Optional

id

string As date-time As date-time
lastUpdatedAt
Optional

lastUpdatedAt

array of object
levels
Optional

levels

string
orgId
Optional

orgId

string
projectId
Optional

projectId

string
projectName
Optional

projectName

object
requestDetails
Optional

requestDetails

string
requestId
Optional

requestId

string
requestedBy
Optional

requestedBy

string
status
Optional

status

Possible values are : APPROVED, REJECTED, PENDING, EXPIRED, CANCELLED,
integer As int32 As int32
totalLevels
Optional

totalLevels


401

unauthorized

Operation doesn't return any data structure

403

access denied - doesn't have permission to view the specified approval request

Operation doesn't return any data structure

404

not found

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/approval/api/approvals/{id}
On This Page
Approval Request Operations
GET
Get Approval Requests V3
POST
Execute Action On Approval Request
GET
Get Logged In User Groups
GET
Get Approval Request V3