Fetch Model
Generate request form model for a given library schema.
Request
URI
POST
https://vra-interop-222-139.lvn.broadcom.net/form-service/api/forms/renderer/model
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
string
resourceId
Optional
Resource id
string
deploymentId
Optional
Deployment id
Request Body
JsonSchemaImpl
of type(s)
application/json
Required
{
"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
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
Responses
200
'Success' with retrieved or generated form model
Returns
RendererModelResponse
of type(s)
application/json
"RendererModelResponse Object"
string
model
Optional
model
string
styles
Optional
styles
string
formStatus
Optional
formStatus
Possible values are :
off,
on,
invalid,
generated,
string
executionItemId
Optional
executionItemId
400
'Bad Request' if JsonSchema is not in specified format
Returns
RendererModelResponse
of type(s)
application/json
"RendererModelResponse Object"
string
model
Optional
model
string
styles
Optional
styles
string
formStatus
Optional
formStatus
Possible values are :
off,
on,
invalid,
generated,
string
executionItemId
Optional
executionItemId
403
'Forbidden' no forms viewer access rights
Returns
RendererModelResponse
of type(s)
application/json
"RendererModelResponse Object"
string
model
Optional
model
string
styles
Optional
styles
string
formStatus
Optional
formStatus
Possible values are :
off,
on,
invalid,
generated,
string
executionItemId
Optional
executionItemId
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/form-service/api/forms/renderer/model