Update Blueprint

Update Blueprint

Update an existing composite blueprint.

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

The objectId of the blueprint to update.

Query Parameters
boolean
Required

If true, skip specification and recursion validations. Default is false.

Request Body

The updated blueprint data.

CompositeBlueprint of type(s) application/json
Required 
{
    "catalogItemTypeId": "string",
    "description": "string",
    "externalId": "string",
    "version": 0,
    "propertyGroups": [
        "string"
    ],
    "lastUpdated": "string",
    "createdDate": "string",
    "tenantId": "string",
    "name": "string",
    "publishStatusName": "string",
    "snapshotVersion": "string",
    "id": "string",
    "usingCustomForm": false,
    "publishStatus": "string"
}
object
components
Optional

components

string
catalogItemTypeId
Optional

catalogItemTypeId

string
description
Optional

description

string
externalId
Optional

externalId

integer As int64 As int64
version
Optional

version

array of string
propertyGroups
Optional

propertyGroups

object
layout
Optional

layout

string As date-time As date-time
lastUpdated
Optional

lastUpdated

string As date-time As date-time
createdDate
Optional

createdDate

string
tenantId
Optional

tenantId

string
name
Required

name

string
publishStatusName
Optional

publishStatusName

string As uuid As uuid
snapshotVersion
Optional

snapshotVersion

string
id
Optional

id

boolean
usingCustomForm
Optional

usingCustomForm

string
publishStatus
Required

publishStatus

Possible values are : DRAFT, PUBLISHED, RETIRED,
object
properties
Optional

properties

Responses
200

Success - return the updated composite blueprint.

Returns CompositeBlueprint of type(s) */* 
{
    "catalogItemTypeId": "string",
    "description": "string",
    "externalId": "string",
    "version": 0,
    "propertyGroups": [
        "string"
    ],
    "lastUpdated": "string",
    "createdDate": "string",
    "tenantId": "string",
    "name": "string",
    "publishStatusName": "string",
    "snapshotVersion": "string",
    "id": "string",
    "usingCustomForm": false,
    "publishStatus": "string"
}
object
components
Optional

components

string
catalogItemTypeId
Optional

catalogItemTypeId

string
description
Optional

description

string
externalId
Optional

externalId

integer As int64 As int64
version
Optional

version

array of string
propertyGroups
Optional

propertyGroups

object
layout
Optional

layout

string As date-time As date-time
lastUpdated
Optional

lastUpdated

string As date-time As date-time
createdDate
Optional

createdDate

string
tenantId
Optional

tenantId

string
name
Required

name

string
publishStatusName
Optional

publishStatusName

string As uuid As uuid
snapshotVersion
Optional

snapshotVersion

string
id
Optional

id

boolean
usingCustomForm
Optional

usingCustomForm

string
publishStatus
Required

publishStatus

Possible values are : DRAFT, PUBLISHED, RETIRED,
object
properties
Optional

properties


400

Invalid request - bad data.

Operation doesn't return any data structure

403

Forbidden.

Operation doesn't return any data structure

404

Blueprint not found.

Operation doesn't return any data structure

On This Page
Blueprints Operations
POST
Create Blueprint
DELETE
Delete Blueprint
DELETE
Delete Custom Form
GET
Disable Custom Forms
GET
Enable Custom Forms
GET
Get Form
POST
Set Custom Form
PUT
Update Blueprint
PUT
Update Blueprint Publish Status
GET
Validate Form