Get Blueprint Request Using GET 1

Get Blueprint Request Using GET 1

Returns blueprint request details

Request
URI
GET
https://{api_host}//cava-s-182-041.eng.vmware.com/blueprint/api/blueprint-requests/{requestId}
COPY
Path Parameters
string
requestId
Required

requestId

Query Parameters
string
apiVersion
Optional

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

Responses
200

OK

Returns BlueprintRequest of type(s) application/json 
{
    "blueprintId": "string",
    "blueprintVersion": "string",
    "cancelRequestedAt": "string",
    "cancelRequestedBy": "string",
    "content": "string",
    "createdAt": "string",
    "createdBy": "string",
    "deploymentId": "string",
    "deploymentName": "string",
    "description": "string",
    "destroy": false,
    "failureMessage": "string",
    "flowExecutionId": "string",
    "flowId": "string",
    "id": "string",
    "ignoreDeleteFailures": false,
    "orgId": "string",
    "plan": false,
    "projectId": "string",
    "projectName": "string",
    "reason": "string",
    "requestTrackerId": "string",
    "simulate": false,
    "status": "string",
    "updatedAt": "string",
    "updatedBy": "string",
    "validationMessages": [
        {
            "message": "string",
            "path": "string",
            "resourceName": "string",
            "type": "string"
        }
    ]
}
string As uuid As uuid
blueprintId
Optional

Blueprint Id

string
blueprintVersion
Optional

Blueprint version

string As date-time As date-time
cancelRequestedAt
Optional

Cancel request time

string
cancelRequestedBy
Optional

Cancel requested by

string
content
Optional

Blueprint YAML content

string As date-time As date-time
createdAt
Optional

Created time

string
createdBy
Optional

Created by

string
deploymentId
Optional

Existing deployment Id

string
deploymentName
Optional

Name for the new deployment

string
description
Optional

Description for the new request

boolean
destroy
Optional

Destroy existing deployment

string
failureMessage
Optional

Failure message

string
flowExecutionId
Optional

Flow execution Id

string
flowId
Optional

Flow Id

string
id
Optional

Object ID

boolean
ignoreDeleteFailures
Optional

Ignore delete failures in blueprint request

object
inputs
Optional

Blueprint request inputs

string
orgId
Optional

Org ID

boolean
plan
Optional

Plan only without affecting existing deployment

string
projectId
Optional

Project ID

string
projectName
Optional

Project Name

string
reason
Optional

Reason for requesting a blueprint

string
requestTrackerId
Optional

Request tracker Id

boolean
simulate
Optional

Simulate blueprint request with providers

string
status
Optional

Status

Possible values are : CREATED, STARTED, FINISHED, FAILED, CANCELLED,
string As date-time As date-time
updatedAt
Optional

Updated time

string
updatedBy
Optional

Updated by

array of BlueprintValidationMessage
validationMessages
Optional

Validation messages


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

On This Page
Blueprint Requests Operations
POST
Cancel Blueprint Request Using POST
POST
Create Blueprint Request Using POST 1
DELETE
Delete Blueprint Request Using DELETE 1
GET
Get Blueprint Plan Using GET 1
GET
Get Blueprint Request Using GET 1
GET
Get Blueprint Resources Plan Using GET 1
GET
List Blueprint Requests Using GET 1