Fetch Form

Fetch Form
Generate request form for a given library schema.

Generate request form for a given library schema.

Request
URI
POST
https://{api_host}/blueprint/api/blueprints/form/request
COPY
Query Parameters
string
sourceType
Optional

The request source type

string
sourceId
Optional

The request source id

string
formType
Optional

The form type

Request Body
JsonSchemaImpl of type(s) application/json
Required 
{
    "$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 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

Authentication
This operation uses the following authentication methods.
Responses
200

'Success' with retrieved or generated custom form

Returns string of type(s) application/json
Operation doesn't return any data structure

400

'Bad Request' if JsonSchema is not in specified format

Returns string of type(s) application/json
Operation doesn't return any data structure

403

'Forbidden' no blueprint view access rights

Returns string of type(s) application/json
Operation doesn't return any data structure

404

Not Found

Returns string of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/blueprint/api/blueprints/form/request
On This Page
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