Update Blueprint Using PUT

Updates a blueprint

Request

URI

PUT

https://{api_host}/blueprint/api/blueprints/{blueprintId}

COPY

Path Parameters

string

blueprintId

Required

blueprintId

Query Parameters

string

apiVersion

Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /blueprint/api/about

Request Body

Blueprint of type(s) application/json

Required

{
    "content": "string",
    "contentSourceId": "string",
    "contentSourcePath": "string",
    "contentSourceSyncAt": "string",
    "contentSourceSyncMessages": [
        "string"
    ],
    "contentSourceSyncStatus": "string",
    "contentSourceType": "string",
    "createdAt": "string",
    "createdBy": "string",
    "description": "string",
    "formId": "string",
    "iconId": "string",
    "id": "string",
    "name": "string",
    "orgId": "string",
    "organizationSharings": [
        {
            "createdAt": "string",
            "createdBy": "string",
            "orgId": "string",
            "updatedAt": "string",
            "updatedBy": "string"
        }
    ],
    "projectId": "string",
    "projectName": "string",
    "requestScopeOrg": false,
    "selfLink": "string",
    "status": "string",
    "totalReleasedVersions": 0,
    "totalVersions": 0,
    "updatedAt": "string",
    "updatedBy": "string",
    "valid": false,
    "validationMessages": [
        {
            "message": "string",
            "metadata": {
                "metadata": "string"
            },
            "path": "string",
            "resourceName": "string",
            "type": "string"
        }
    ]
}

string

content

Optional

Blueprint YAML content

string

contentSourceId

Optional

Content source id

string

contentSourcePath

Optional

Content source path

string As date-time As date-time

contentSourceSyncAt

Optional

Content source last sync time

array of string

contentSourceSyncMessages

Optional

Content source last sync messages

string

contentSourceSyncStatus

Optional

Content source last sync status

Possible values are : SUCCESSFUL, FAILED,

string

contentSourceType

Optional

Content source type

string As date-time As date-time

createdAt

Optional

Created time

string

createdBy

Optional

Created by

string

description

Optional

Blueprint description

string

formId

Optional

Custom form ID.

string As uuid As uuid

iconId

Optional

Icon ID

string

Optional

Object ID

string

name

Optional

Blueprint name

string

orgId

Optional

Org ID

array of object

organizationSharings

Optional

List of organizations with whom the given blueprint is either shared with or needs to be shared with. If share with all the organizations, there should be one organizationSharing in the array with orgId as 'ALL'.

string

projectId

Optional

Project ID

string

projectName

Optional

Project Name

boolean

requestScopeOrg

Optional

Flag to indicate blueprint can be requested from any project in org

string

selfLink

Optional

Blueprint self link

string

status

Optional

Blueprint status

Possible values are : DRAFT, VERSIONED, RELEASED,

integer As int32 As int32

totalReleasedVersions

Optional

Total released versions

integer As int32 As int32

totalVersions

Optional

Total versions

string As date-time As date-time

updatedAt

Optional

Updated time

string

updatedBy

Optional

Updated by

boolean

valid

Optional

Validation result on update

array of object

validationMessages

Optional

Validation messages

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Returns Blueprint of type(s) application/json

"Blueprint Object"

string

content

Optional

Blueprint YAML content

string

contentSourceId

Optional

Content source id

string

contentSourcePath

Optional

Content source path

string As date-time As date-time

contentSourceSyncAt

Optional

Content source last sync time

array of string

contentSourceSyncMessages

Optional

Content source last sync messages

string

contentSourceSyncStatus

Optional

Content source last sync status

Possible values are : SUCCESSFUL, FAILED,

string

contentSourceType

Optional

Content source type

string As date-time As date-time

createdAt

Optional

Created time

string

createdBy

Optional

Created by

string

description

Optional

Blueprint description

string

formId

Optional

Custom form ID.

string As uuid As uuid

iconId

Optional

Icon ID

string

Optional

Object ID

string

name

Optional

Blueprint name

string

orgId

Optional

Org ID

array of object

organizationSharings

Optional

string

projectId

Optional

Project ID

string

projectName

Optional

Project Name

boolean

requestScopeOrg

Optional

Flag to indicate blueprint can be requested from any project in org

string

selfLink

Optional

Blueprint self link

string

status

Optional

Blueprint status

Possible values are : DRAFT, VERSIONED, RELEASED,

integer As int32 As int32

totalReleasedVersions

Optional

Total released versions

integer As int32 As int32

totalVersions

Optional

Total versions

string As date-time As date-time

updatedAt

Optional

Updated time

string

updatedBy

Optional

Updated by

boolean

valid

Optional

Validation result on update

array of object

validationMessages

Optional

Validation messages

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/blueprint/api/blueprints/{blueprintId}

On This Page

Description

Request

Path Parameters

Query Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Blueprint Operations

GET