Get Blueprint Inputs Schema Using GET

Get Blueprint Inputs Schema Using GET

Returns blueprint inputs schema

Request
URI
GET
https://{api_host}/blueprint/api/blueprints/{blueprintId}/inputs-schema
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

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PropertyDefinition of type(s) application/json 
{
    "$data": "string",
    "$dynamicDefault": "string",
    "$ref": "string",
    "additionalProperties": false,
    "allOf": [
        "PropertyDefinition Object"
    ],
    "anyOf": [
        "PropertyDefinition Object"
    ],
    "computed": false,
    "const": {},
    "default": {},
    "dependencies": {
        "dependencies": [
            "string"
        ]
    },
    "description": "string",
    "encrypted": false,
    "enum": [
        {}
    ],
    "format": "string",
    "ignoreCaseOnDiff": false,
    "ignoreOnUpdate": false,
    "items": "PropertyDefinition Object",
    "maxItems": 0,
    "maxLength": 0,
    "maxProperties": 0,
    "maximum": 0,
    "metadata": {
        "metadata": {}
    },
    "minItems": 0,
    "minLength": 0,
    "minProperties": 0,
    "minimum": 0,
    "not": "PropertyDefinition Object",
    "oneOf": [
        "PropertyDefinition Object"
    ],
    "pattern": "string",
    "properties": {
        "properties": "PropertyDefinition Object"
    },
    "recreateOnUpdate": false,
    "required": [
        "string"
    ],
    "title": "string",
    "type": "string",
    "uniqueItems": false,
    "writeOnly": false
}
string
$data
Optional

$data

string
$dynamicDefault
Optional

$dynamicDefault

string
$ref
Optional

$ref

boolean
additionalProperties
Optional

additionalProperties

array of PropertyDefinition
allOf
Optional

allOf

array of PropertyDefinition
anyOf
Optional

anyOf

boolean
computed
Optional

computed

object
const
Optional

const

object
default
Optional

default

object
dependencies
Optional

dependencies

string
description
Optional

description

boolean
encrypted
Optional

encrypted

array of object
enum
Optional

enum

string
format
Optional

format

boolean
ignoreCaseOnDiff
Optional

ignoreCaseOnDiff

boolean
ignoreOnUpdate
Optional

ignoreOnUpdate

PropertyDefinition
items
Optional

items

integer As int64 As int64
maxItems
Optional

maxItems

integer As int32 As int32
maxLength
Optional

maxLength

integer As int32 As int32
maxProperties
Optional

maxProperties

integer As int64 As int64
maximum
Optional

maximum

object
metadata
Optional

metadata

integer As int64 As int64
minItems
Optional

minItems

integer As int32 As int32
minLength
Optional

minLength

integer As int32 As int32
minProperties
Optional

minProperties

integer As int64 As int64
minimum
Optional

minimum

PropertyDefinition
not
Optional

not

array of PropertyDefinition
oneOf
Optional

oneOf

string
pattern
Optional

pattern

object
properties
Optional

properties

boolean
recreateOnUpdate
Optional

recreateOnUpdate

array of string
required
Optional

required

string
title
Optional

title

string
type
Optional

type

boolean
uniqueItems
Optional

uniqueItems

boolean
writeOnly
Optional

writeOnly


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 -H 'Authorization: <value>' https://{api_host}/blueprint/api/blueprints/{blueprintId}/inputs-schema
On This Page
Blueprint Operations
GET
List Blueprints Using GET
POST
Create Blueprint Using POST
DELETE
Delete Blueprint Using DELETE
GET
Get Blueprint Using GET
PUT
Update Blueprint Using PUT
GET
Get Blueprint Inputs Schema Using GET
GET
List Blueprint Versions Using GET
POST
Create Blueprint Version Using POST
GET
Get Blueprint Version Using GET
POST
Release Blueprint Version Using POST
POST
Restore Blueprint Version Using POST
POST
Un Release Blueprint Version Using POST
GET
Get Blueprint Version Inputs Schema Using GET