Fetch Customized Form

Fetch Customized Form
Fetch request form or generate one for a given library schema.

This API is deprecated since 9.1. Alternatives: /blueprint/api/blueprints/form/request

Request
URI
POST
https://vcf-stls-wcp-pod13-137.lvn.broadcom.net/form-service/api/forms/designer/request
COPY
Query Parameters
string
sourceType
Optional

The request source type

string
sourceId
Optional

The request source id

string
formType
Optional

The form type

string
formId
Optional

The request form id, used to find a form from a provider

Request Body
JsonSchemaImpl of type(s) application/json
Required 
{
    "type": "string",
    "encrypted": false,
    "additionalProperties": false,
    "title": "string",
    "description": "string",
    "writeOnly": false,
    "readOnly": false,
    "allOf": [
        {
            "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": {
                "value": "JsonSchemaImpl Object",
                "singleton": false
            },
            "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"
        }
    ],
    "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

Authentication
This operation uses the following authentication methods.
Responses
200

'Success' with the cusotmized form definition matching the query parameters

Returns FormDefinitionWithExternalSchema of type(s) application/json 
{
    "tenant": "string",
    "id": "string",
    "name": "string",
    "form": "string",
    "styles": "string",
    "sourceType": "string",
    "sourceId": "string",
    "type": "string",
    "status": "string",
    "createdDate": "string",
    "modifiedDate": "string",
    "formFormat": "string",
    "providerRef": "string",
    "externalSourceFormSchemas": [
        {
            "externalSourceId": "string",
            "parentId": "string",
            "elementId": "string",
            "elementType": "string",
            "facet": "string",
            "parameters": [
                {
                    "validatable": false,
                    "name": "string",
                    "isValidatable": false
                }
            ]
        }
    ]
}
string
tenant
Optional

tenant

string As uuid As uuid
id
Optional

id

string
name
Required

name

string
form
Optional

form

string
styles
Optional

styles

string
sourceType
Optional

sourceType

string
sourceId
Optional

sourceId

string
type
Optional

type

string
status
Required

status

Possible values are : off, on, invalid, generated,
string As date-time As date-time
createdDate
Optional

createdDate

string As date-time As date-time
modifiedDate
Optional

modifiedDate

string
formFormat
Optional

formFormat

Possible values are : YAML, JSON,
string
providerRef
Optional

providerRef

array of object
externalSourceFormSchemas
Optional

externalSourceFormSchemas


400

'Bad Request' if provided JsonSchemaImpl is in invalid format

Operation doesn't return any data structure

403

'Forbidden' no forms viewer access rights

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}/form-service/api/forms/designer/request
Deprecated
On This Page
Form Designer Operations
POST
Generate Elements Runnable Item
Deprecated
POST
Fetch Customized Form
Deprecated
POST
Generate Json Schema
Deprecated
POST
Get External Value
Deprecated
POST
Generate Elements