List Blueprint Requests Using GET

List Blueprint Requests Using GET

Lists blueprint requests

Request
URI
GET
https://{api_host}/blueprint/api/blueprint-requests
COPY
Query Parameters
integer
page
Optional
Constraints: minimum: 0 default: 0

Zero-based page index (0..N)

integer
size
Optional
Constraints: minimum: 1 default: 20

The size of the page to be returned

string of array
sort
Optional
Constraints: default: updatedAt,DESC

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

string of array
$select
Optional

Fields to include in content.

string
deploymentId
Optional

Deployment Id filter

boolean
includePlan
Optional

Plan Requests filter

string
apiVersion
Optional

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

integer
$top
Optional

Number of records you want

$top example
1
integer
$skip
Optional

Number of records you want to skip

$skip example
1
string
$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.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PageBlueprintRequest 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,
            "inputs": {
                "inputs": {}
            },
            "orgId": "string",
            "plan": false,
            "projectId": "string",
            "projectName": "string",
            "reason": "string",
            "requestTrackerId": "string",
            "simulate": false,
            "status": "string",
            "targetResources": [
                "string"
            ],
            "updatedAt": "string",
            "updatedBy": "string",
            "validationMessages": [
                {
                    "message": "string",
                    "metadata": {
                        "metadata": "string"
                    },
                    "path": "string",
                    "resourceName": "string",
                    "type": "string"
                }
            ]
        }
    ],
    "empty": false,
    "first": false,
    "last": false,
    "number": 0,
    "numberOfElements": 0,
    "pageable": {
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 0,
        "paged": false,
        "sort": {
            "empty": false,
            "sorted": false,
            "unsorted": false
        },
        "unpaged": false
    },
    "size": 0,
    "sort": {
        "empty": false,
        "sorted": false,
        "unsorted": false
    },
    "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

object
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

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/blueprint/api/blueprint-requests
On This Page
Blueprint Requests Operations
GET
List Blueprint Requests Using GET
POST
Create Blueprint Request Using POST
DELETE
Delete Blueprint Request Using DELETE
GET
Get Blueprint Request Using GET
POST
Cancel Blueprint Request Using POST
GET
Get Blueprint Request Execution Using GET
GET
Get Blueprint Resources Plan Using GET 1
GET
Get Blueprint Resources Plan Using GET