Get Json Object Schema

Generate a ProviderSchemaImpl for the provided RunnableItem. The schema can be used to create a custom resource type.

Request

URI

POST

https://vra-interop-222-139.lvn.broadcom.net/form-service/api/custom/schema-generation/json

COPY

Query Parameters

string

externalType

Optional

External type

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

Required

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.

Authorization

Responses

200

'Success' with generated ProviderSchemaImpl

Returns ProviderSchemaImpl of type(s) */*

"ProviderSchemaImpl Object"

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 ProviderSchemaImpl

anyOf

Optional

anyOf

array of ProviderSchemaImpl

oneOf

Optional

oneOf

ProviderSchemaImpl

not

Optional

not

ObjectOrListProviderSchemaImpl

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

boolean

computed

Optional

computed

boolean

recreateOnUpdate

Optional

recreateOnUpdate

boolean

ignoreOnUpdate

Optional

ignoreOnUpdate

boolean

ignoreCaseOnDiff

Optional

ignoreCaseOnDiff

object

dependencies

Optional

dependencies

array of object

enum

Optional

enum

object

const

Optional

const

object

default

Optional

default

string

$data

Optional

$data

string

$dynamicDefault

Optional

$dynamicDefault

400

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

Returns ProviderSchemaImpl of type(s) */*

"ProviderSchemaImpl Object"

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 ProviderSchemaImpl

anyOf

Optional

anyOf

array of ProviderSchemaImpl

oneOf

Optional

oneOf

ProviderSchemaImpl

not

Optional

not

ObjectOrListProviderSchemaImpl

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

boolean

computed

Optional

computed

boolean

recreateOnUpdate

Optional

recreateOnUpdate

boolean

ignoreOnUpdate

Optional

ignoreOnUpdate

boolean

ignoreCaseOnDiff

Optional

ignoreCaseOnDiff

object

dependencies

Optional

dependencies

array of object

enum

Optional

enum

object

const

Optional

const

object

default

Optional

default

string

$data

Optional

$data

string

$dynamicDefault

Optional

$dynamicDefault

403

'Forbidden' no forms viewer access rights

Returns ProviderSchemaImpl of type(s) */*

"ProviderSchemaImpl Object"

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 ProviderSchemaImpl

anyOf

Optional

anyOf

array of ProviderSchemaImpl

oneOf

Optional

oneOf

ProviderSchemaImpl

not

Optional

not

ObjectOrListProviderSchemaImpl

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

boolean

computed

Optional

computed

boolean

recreateOnUpdate

Optional

recreateOnUpdate

boolean

ignoreOnUpdate

Optional

ignoreOnUpdate

boolean

ignoreCaseOnDiff

Optional

ignoreCaseOnDiff

object

dependencies

Optional

dependencies

array of object

enum

Optional

enum

object

const

Optional

const

object

default

Optional

default

string

$data

Optional

$data

string

$dynamicDefault

Optional

$dynamicDefault

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/json

On This Page

Description

Request

Query Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Schema Generation Services Operations

POST

Generate