Get Form Layout Schema

Get Form Layout Schema

Get the layout schema for the provided runnable item, given that it exists on the specified endpoint

Request
URI
POST
https://vra-interop-222-139.lvn.broadcom.net/form-service/api/custom/schema-generation/form
COPY
Request Body
RunnableItem of type(s) application/json
Required

Show optional properties

{
    "id": "string",
    "type": "string"
}
{
    "id": "string",
    "name": "string",
    "description": "string",
    "projectId": "string",
    "type": "string",
    "inputParameters": [
        {
            "type": "string",
            "name": "string",
            "description": "string"
        }
    ],
    "outputParameters": [
        {
            "type": "string",
            "name": "string",
            "description": "string"
        }
    ],
    "endpointLink": "string",
    "inputBindings": [
        {
            "inputKey": "string",
            "value": "string",
            "type": {
                "dataType": "string",
                "referenceType": "string",
                "fields": [
                    "ComplexTypeField Object"
                ],
                "isMultiple": false
            },
            "bindingAction": "BindingAction Object"
        }
    ]
}
string
id
Required

id

string
name
Optional

name

string
description
Optional

description

string
projectId
Optional

projectId

string
type
Required

type

array of object
inputParameters
Optional

inputParameters

array of object
outputParameters
Optional

outputParameters

string
endpointLink
Optional

endpointLink

array of object
inputBindings
Optional

inputBindings

Authentication
This operation uses the following authentication methods.
Responses
200

'Success' with the form layout schema

Returns FormLayoutSchema of type(s) */* 
"FormLayoutSchema Object"
object
layout
Optional

layout

object
schema
Optional

schema

array of object
messages
Optional

messages

object
options
Optional

options


400

'Bad Request' if the RunnableItem is not in specified format

Returns FormLayoutSchema of type(s) */* 
"FormLayoutSchema Object"
object
layout
Optional

layout

object
schema
Optional

schema

array of object
messages
Optional

messages

object
options
Optional

options


403

'Forbidden' no forms viewer access rights

Returns FormLayoutSchema of type(s) */* 
"FormLayoutSchema Object"
object
layout
Optional

layout

object
schema
Optional

schema

array of object
messages
Optional

messages

object
options
Optional

options


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"id:"string","type:"string"}' https://{api_host}/form-service/api/custom/schema-generation/form
On This Page
Schema Generation Services Operations
POST
Generate
Deprecated
POST
Get Json Object Schema
POST
Get Form Layout Schema