Get Blueprint Document

Get Blueprint Document

Get an existing composite blueprint document by its objectId.

Request
URI
GET
https://{api_host}/composition-service/api/blueprintdocuments/{id}
COPY
Path Parameters
string
id
Required

The objectId of the blueprint.


Responses
200

Success - return the composite blueprint document.

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

Possible values are : DRAFT, PUBLISHED, RETIRED,
array of string
propertyGroups
Optional

propertyGroups


403

Forbidden.

Operation doesn't return any data structure

404

Blueprint not found.

Operation doesn't return any data structure