Generate Json Schema

• Blueprint Form

Generates json schema based on the provided form layout schema

Generates json schema based on the provided form layout schema

Request

URI

POST

https://{api_host}/blueprint/api/blueprints/form/generate-form-json-schema

COPY

Request Body

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Hide Details

'Success' with generated json schema

Returns JsonSchemaImpl of type(s) application/json

{
    "$data": "string",
    "$dynamicDefault": "string",
    "$ref": "string",
    "additionalProperties": false,
    "allOf": [
        {
            "$data": "string",
            "$dynamicDefault": "string",
            "$ref": "string",
            "additionalProperties": false,
            "allOf": [
                "JsonSchemaImpl Object"
            ],
            "anyOf": [
                "JsonSchemaImpl Object"
            ],
            "const": {},
            "default": {},
            "description": "string",
            "encrypted": false,
            "enum": [
                {}
            ],
            "format": "string",
            "formatMaximum": "string",
            "formatMinimum": "string",
            "items": {
                "singleton": false,
                "value": "JsonSchemaImpl Object"
            },
            "maxItems": 0,
            "maxLength": 0,
            "maxProperties": 0,
            "maximum": "number",
            "minItems": 0,
            "minLength": 0,
            "minProperties": 0,
            "minimum": "number",
            "not": "JsonSchemaImpl Object",
            "oneOf": [
                "JsonSchemaImpl Object"
            ],
            "pattern": "string",
            "patternProperties": {
                "patternProperties": "JsonSchemaImpl Object"
            },
            "properties": {
                "properties": "JsonSchemaImpl Object"
            },
            "readOnly": false,
            "required": [
                "string"
            ],
            "title": "string",
            "type": "string",
            "uniqueItems": false,
            "writeOnly": false
        }
    ],
    "anyOf": [
        "JsonSchemaImpl Object"
    ],
    "const": {},
    "default": {},
    "description": "string",
    "encrypted": false,
    "enum": [
        {}
    ],
    "format": "string",
    "formatMaximum": "string",
    "formatMinimum": "string",
    "items": "ObjectOrListJsonSchemaImpl Object",
    "maxItems": 0,
    "maxLength": 0,
    "maxProperties": 0,
    "maximum": "number",
    "minItems": 0,
    "minLength": 0,
    "minProperties": 0,
    "minimum": "number",
    "not": "JsonSchemaImpl Object",
    "oneOf": [
        "JsonSchemaImpl Object"
    ],
    "pattern": "string",
    "patternProperties": {
        "patternProperties": "JsonSchemaImpl Object"
    },
    "properties": {
        "properties": "JsonSchemaImpl Object"
    },
    "readOnly": 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 object

allOf

Optional

allOf

array of JsonSchemaImpl

anyOf

Optional

anyOf

object

const

Optional

const

object

default

Optional

default

string

description

Optional

description

boolean

encrypted

Optional

encrypted

array of object

enum

Optional

enum

string

format

Optional

format

string

formatMaximum

Optional

formatMaximum

string

formatMinimum

Optional

formatMinimum

ObjectOrListJsonSchemaImpl

items

Optional

items

integer As int32 As int32

maxItems

Optional

maxItems

integer As int64 As int64

maxLength

Optional

maxLength

integer As int32 As int32

maxProperties

Optional

maxProperties

number

maximum

Optional

maximum

integer As int32 As int32

minItems

Optional

minItems

integer As int64 As int64

minLength

Optional

minLength

integer As int32 As int32

minProperties

Optional

minProperties

number

minimum

Optional

minimum

JsonSchemaImpl

not

Optional

not

array of JsonSchemaImpl

oneOf

Optional

oneOf

string

pattern

Optional

pattern

object

patternProperties

Optional

patternProperties

object

properties

Optional

properties

boolean

readOnly

Optional

readOnly

array of string

required

Optional

required

string

title

Optional

title

string

type

Optional

type

Possible values are : string, integer, number, boolean, object, array, null,

boolean

uniqueItems

Optional

uniqueItems

boolean

writeOnly

Optional

writeOnly

400

Hide Details

'Bad Request' if formLayoutSchema is in invalid format

Returns JsonSchemaImpl of type(s) application/json

"JsonSchemaImpl Object"

string

$data

Optional

$data

string

$dynamicDefault

Optional

$dynamicDefault

string

$ref

Optional

$ref

boolean

additionalProperties

Optional

additionalProperties

array of JsonSchemaImpl

allOf

Optional

allOf

array of JsonSchemaImpl

anyOf

Optional

anyOf

object

const

Optional

const

object

default

Optional

default

string

description

Optional

description

boolean

encrypted

Optional

encrypted

array of object

enum

Optional

enum

string

format

Optional

format

string

formatMaximum

Optional

formatMaximum

string

formatMinimum

Optional

formatMinimum

ObjectOrListJsonSchemaImpl

items

Optional

items

integer As int32 As int32

maxItems

Optional

maxItems

integer As int64 As int64

maxLength

Optional

maxLength

integer As int32 As int32

maxProperties

Optional

maxProperties

number

maximum

Optional

maximum

integer As int32 As int32

minItems

Optional

minItems

integer As int64 As int64

minLength

Optional

minLength

integer As int32 As int32

minProperties

Optional

minProperties

number

minimum

Optional

minimum

JsonSchemaImpl

not

Optional

not

array of JsonSchemaImpl

oneOf

Optional

oneOf

string

pattern

Optional

pattern

object

patternProperties

Optional

patternProperties

object

properties

Optional

properties

boolean

readOnly

Optional

readOnly

array of string

required

Optional

required

string

title

Optional

title

string

type

Optional

type

Possible values are : string, integer, number, boolean, object, array, null,

boolean

uniqueItems

Optional

uniqueItems

boolean

writeOnly

Optional

writeOnly

403

Hide Details

'Forbidden' no blueprint manage access rights

Returns JsonSchemaImpl of type(s) application/json

"JsonSchemaImpl Object"

string

$data

Optional

$data

string

$dynamicDefault

Optional

$dynamicDefault

string

$ref

Optional

$ref

boolean

additionalProperties

Optional

additionalProperties

array of JsonSchemaImpl

allOf

Optional

allOf

array of JsonSchemaImpl

anyOf

Optional

anyOf

object

const

Optional

const

object

default

Optional

default

string

description

Optional

description

boolean

encrypted

Optional

encrypted

array of object

enum

Optional

enum

string

format

Optional

format

string

formatMaximum

Optional

formatMaximum

string

formatMinimum

Optional

formatMinimum

ObjectOrListJsonSchemaImpl

items

Optional

items

integer As int32 As int32

maxItems

Optional

maxItems

integer As int64 As int64

maxLength

Optional

maxLength

integer As int32 As int32

maxProperties

Optional

maxProperties

number

maximum

Optional

maximum

integer As int32 As int32

minItems

Optional

minItems

integer As int64 As int64

minLength

Optional

minLength

integer As int32 As int32

minProperties

Optional

minProperties

number

minimum

Optional

minimum

JsonSchemaImpl

not

Optional

not

array of JsonSchemaImpl

oneOf

Optional

oneOf

string

pattern

Optional

pattern

object

patternProperties

Optional

patternProperties

object

properties

Optional

properties

boolean

readOnly

Optional

readOnly

array of string

required

Optional

required

string

title

Optional

title

string

type

Optional

type

Possible values are : string, integer, number, boolean, object, array, null,

boolean

uniqueItems

Optional

uniqueItems

boolean

writeOnly

Optional

writeOnly

404

Hide Details

Not Found

Returns JsonSchemaImpl of type(s) application/json

"JsonSchemaImpl Object"

string

$data

Optional

$data

string

$dynamicDefault

Optional

$dynamicDefault

string

$ref

Optional

$ref

boolean

additionalProperties

Optional

additionalProperties

array of JsonSchemaImpl

allOf

Optional

allOf

array of JsonSchemaImpl

anyOf

Optional

anyOf

object

const

Optional

const

object

default

Optional

default

string

description

Optional

description

boolean

encrypted

Optional

encrypted

array of object

enum

Optional

enum

string

format

Optional

format

string

formatMaximum

Optional

formatMaximum

string

formatMinimum

Optional

formatMinimum

ObjectOrListJsonSchemaImpl

items

Optional

items

integer As int32 As int32

maxItems

Optional

maxItems

integer As int64 As int64

maxLength

Optional

maxLength

integer As int32 As int32

maxProperties

Optional

maxProperties

number

maximum

Optional

maximum

integer As int32 As int32

minItems

Optional

minItems

integer As int64 As int64

minLength

Optional

minLength

integer As int32 As int32

minProperties

Optional

minProperties

number

minimum

Optional

minimum

JsonSchemaImpl

not

Optional

not

array of JsonSchemaImpl

oneOf

Optional

oneOf

string

pattern

Optional

pattern

object

patternProperties

Optional

patternProperties

object

properties

Optional

properties

boolean

readOnly

Optional

readOnly

array of string

required

Optional

required

string

title

Optional

title

string

type

Optional

type

Possible values are : string, integer, number, boolean, object, array, null,

boolean

uniqueItems

Optional

uniqueItems

boolean

writeOnly

Optional

writeOnly

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: text/plain' -d '[{}]' https://{api_host}/blueprint/api/blueprints/form/generate-form-json-schema
                

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Blueprint Form Operations

POST

Lookup External Resources

POST

Perform External Validation

POST

List External Values

POST

Get External Value

POST

Generate Json Schema

POST

Fetch Form