Create Or Update Blueprint Document

Create Or Update Blueprint Document

Create or update a composite blueprint document.

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

The objectId of the blueprint.

Request Body

The new blueprint to create.

BlueprintDocument of type(s) application/json
Required 
{
    "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

Responses
200

Success - return the created or updated 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


400

Invalid request - bad data.

Operation doesn't return any data structure

403

Forbidden.

Operation doesn't return any data structure

On This Page
Blueprint Documents Operations
PUT
Create Or Update Blueprint Document
DELETE
Delete Blueprint Document