List Blueprints Using GET 1

List Blueprints Using GET 1

Lists draft blueprint

Request
URI
GET
https://{api_host}//cava-s-182-041.eng.vmware.com/blueprint/api/blueprints
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, name.

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
name
Optional

Filter by name

string of array
projects
Optional

A comma-separated list. Results must be associated with one of these project IDs.

boolean
released
Optional

Filter blueprints with at least one released version

string
search
Optional

Search by name and description

boolean
versioned
Optional

Filter blueprints with at least one version


Responses
200

OK

Returns PageOfBlueprint of type(s) application/json
{
    "content": [
        {
            "content": "string",
            "contentSourceId": "string",
            "contentSourcePath": "string",
            "contentSourceSyncAt": "string",
            "contentSourceSyncMessages": [
                "string"
            ],
            "contentSourceSyncStatus": "string",
            "contentSourceType": "string",
            "createdAt": "string",
            "createdBy": "string",
            "description": "string",
            "id": "string",
            "name": "string",
            "orgId": "string",
            "projectId": "string",
            "projectName": "string",
            "requestScopeOrg": false,
            "selfLink": "string",
            "status": "string",
            "totalReleasedVersions": 0,
            "totalVersions": 0,
            "updatedAt": "string",
            "updatedBy": "string",
            "valid": false,
            "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
}
array of Blueprint
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