List Blueprint Requests Using GET 1

List Blueprint Requests Using GET 1

Lists blueprint requests

Request
URI
GET
https://{api_host}//cava-s-182-041.eng.vmware.com/blueprint/api/blueprint-requests
COPY
Query Parameters
string of array
$orderby
Optional

Sorting criteria in the format: property (asc|desc). Default sort order is descending on updatedAt. Sorting is supported on fields createdAt, updatedAt, createdBy, updatedBy.

string of array
$select
Optional

Fields to include in content. Use * to get all fields.

integer
$skip
Optional

Number of records you want to skip

$skip example
1
integer
$top
Optional

Number of records you want

$top example
1
string
apiVersion
Optional

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

string
deploymentId
Optional

Deployment Id filter

boolean
includePlan
Optional

Plan Requests filter


Responses
200

OK

Returns PageOfBlueprintRequest of type(s) application/json
{
    "content": [
        {
            "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"
                }
            ]
        }
    ],
    "empty": false,
    "first": false,
    "last": false,
    "number": 0,
    "numberOfElements": 0,
    "size": 0,
    "sort": {
        "empty": false,
        "sorted": false,
        "unsorted": false
    },
    "totalElements": 0,
    "totalPages": 0
}
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

integer As int32 As int32
size
Optional

size

sort
Optional

sort

integer As int64 As int64
totalElements
Optional

totalElements

integer As int32 As int32
totalPages
Optional

totalPages


400

Bad Request

Operation doesn't return any data structure

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure