Generate Json Schema

Generate Json Schema

Generates json schema based on the provided form layout schema

Request
URI
POST
https://vra-interop-222-139.lvn.broadcom.net/form-service/api/forms/designer/generate-form-json-schema
COPY
Request Body
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns JsonSchemaImpl of type(s) application/json 
{
    "type": "string",
    "encrypted": false,
    "additionalProperties": false,
    "title": "string",
    "description": "string",
    "writeOnly": false,
    "readOnly": false,
    "allOf": [
        "JsonSchemaImpl Object"
    ],
    "anyOf": [
        "JsonSchemaImpl Object"
    ],
    "oneOf": [
        "JsonSchemaImpl Object"
    ],
    "not": "JsonSchemaImpl Object",
    "items": "ObjectOrListJsonSchemaImpl Object",
    "uniqueItems": false,
    "maxItems": 0,
    "minItems": 0,
    "maximum": "number",
    "minimum": "number",
    "properties": {
        "properties": "JsonSchemaImpl Object"
    },
    "required": [
        "string"
    ],
    "maxProperties": 0,
    "minProperties": 0,
    "patternProperties": {
        "patternProperties": "JsonSchemaImpl Object"
    },
    "maxLength": 0,
    "minLength": 0,
    "pattern": "string",
    "format": "string",
    "formatMinimum": "string",
    "formatMaximum": "string",
    "enum": [
        {}
    ],
    "const": {},
    "default": {},
    "$ref": "string",
    "$data": "string",
    "$dynamicDefault": "string"
}
string
type
Optional

type

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

encrypted

boolean
additionalProperties
Optional

additionalProperties

string
title
Optional

title

string
description
Optional

description

boolean
writeOnly
Optional

writeOnly

boolean
readOnly
Optional

readOnly

array of JsonSchemaImpl
allOf
Optional

allOf

array of JsonSchemaImpl
anyOf
Optional

anyOf

array of JsonSchemaImpl
oneOf
Optional

oneOf

JsonSchemaImpl
not
Optional

not

ObjectOrListJsonSchemaImpl
items
Optional

items

boolean
uniqueItems
Optional

uniqueItems

integer As int32 As int32
maxItems
Optional

maxItems

integer As int32 As int32
minItems
Optional

minItems

number
maximum
Optional

maximum

number
minimum
Optional

minimum

object
properties
Optional

properties

array of string
required
Optional

required

integer As int32 As int32
maxProperties
Optional

maxProperties

integer As int32 As int32
minProperties
Optional

minProperties

object
patternProperties
Optional

patternProperties

integer As int64 As int64
maxLength
Optional

maxLength

integer As int64 As int64
minLength
Optional

minLength

string
pattern
Optional

pattern

string
format
Optional

format

string
formatMinimum
Optional

formatMinimum

string
formatMaximum
Optional

formatMaximum

array of object
enum
Optional

enum

object
const
Optional

const

object
default
Optional

default

string
$ref
Optional

$ref

string
$data
Optional

$data

string
$dynamicDefault
Optional

$dynamicDefault


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: text/plain' -d '[{}]' https://{api_host}/form-service/api/forms/designer/generate-form-json-schema
On This Page
Form Designer Operations
POST
Generate Elements Runnable Item
POST
Fetch Customized Form
POST
Generate Json Schema
POST
Get External Value
POST
Generate Elements