Get Blueprint Documents

Get Blueprint Documents

Get a list of composite blueprint documents visible to the caller.

Request
URI
GET
https:///composition-service/api/blueprintdocuments
COPY
Query Parameters
integer
page
Optional

Page Number

integer
limit
Optional

Number of entries per page

string
$orderby
Optional

Multiple comma-separated properties sorted in ascending or descending order

integer
$top
Optional

Sets the number of returned entries from the top of the response (total number per page in relation to skip)

integer
$skip
Optional

Sets how many entries you would like to skip

string
$filter
Optional

Boolean expression for whether a particular entry should be included in the response


Responses
200

Success - return a page of BlueprintDocument objects.

Returns BlueprintDocument of type(s) */*
{
    "name": "string",
    "description": "string",
    "id": "string",
    "status": "string",
    "propertyGroups": [
        "string"
    ]
}
object
layout
Optional

layout

object
components
Optional

components

string
name
Optional

name

string
description
Optional

description

string
id
Optional

id

object
properties
Optional

properties

string
status
Optional

status

array of string
propertyGroups
Optional

propertyGroups


403

Forbidden.

Operation doesn't return any data structure