Get Json Object Schema
Get json object schema for runnable item.
Generate a ProviderSchemaImpl for the provided RunnableItem. The schema can be used to create a custom resource type.
Request
URI
POST
https://vcfa-10-162-161-9.vcfd.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": [
{
"label": "string",
"description": "string",
"signpost": "string",
"type": "FormSchemaFieldType Object",
"step": "number",
"default": {},
"valueList": {},
"placeholder": "string",
"constraints": {
"matchConstraint": {
"match": {}
},
"constraints": {
"constraints": {}
}
},
"refresh": {
"type": "string"
},
"shortValueName": [
"string"
],
"id": "string",
"valueTree": {}
}
],
"isMultiple": false
},
"bindingAction": {
"actionName": "string",
"actionInputs": [
"Binding 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
Responses
200
'Success' with generated ProviderSchemaImpl
Returns
ProviderSchemaImpl
of type(s)
*/*
{
"type": "string",
"encrypted": false,
"additionalProperties": false,
"title": "string",
"description": "string",
"writeOnly": false,
"readOnly": false,
"anyOf": [
{
"type": "string",
"encrypted": false,
"additionalProperties": false,
"title": "string",
"description": "string",
"writeOnly": false,
"readOnly": false,
"anyOf": [
"ProviderSchemaImpl Object"
],
"oneOf": [
"ProviderSchemaImpl Object"
],
"not": "ProviderSchemaImpl Object",
"items": {
"value": "ProviderSchemaImpl Object",
"singleton": false,
"values": [
"ProviderSchemaImpl Object"
]
},
"uniqueItems": false,
"maxItems": 0,
"minItems": 0,
"maximum": "number",
"minimum": "number",
"properties": {
"properties": "ProviderSchemaImpl Object"
},
"required": [
"string"
],
"maxProperties": 0,
"minProperties": 0,
"patternProperties": {
"patternProperties": "ProviderSchemaImpl Object"
},
"maxLength": 0,
"minLength": 0,
"pattern": "string",
"format": "string",
"formatMinimum": "string",
"formatMaximum": "string",
"computed": false,
"recreateOnUpdate": false,
"ignoreOnUpdate": false,
"ignoreCaseOnDiff": false,
"dependencies": {
"dependencies": [
"string"
]
},
"enum": [
{}
],
"const": {},
"default": {},
"$data": "string",
"$dynamicDefault": "string",
"metadata": {
"metadata": {}
}
}
],
"oneOf": [
"ProviderSchemaImpl Object"
],
"not": "ProviderSchemaImpl Object",
"items": "ObjectOrListProviderSchemaImpl Object",
"uniqueItems": false,
"maxItems": 0,
"minItems": 0,
"maximum": "number",
"minimum": "number",
"properties": {
"properties": "ProviderSchemaImpl Object"
},
"required": [
"string"
],
"maxProperties": 0,
"minProperties": 0,
"patternProperties": {
"patternProperties": "ProviderSchemaImpl Object"
},
"maxLength": 0,
"minLength": 0,
"pattern": "string",
"format": "string",
"formatMinimum": "string",
"formatMaximum": "string",
"computed": false,
"recreateOnUpdate": false,
"ignoreOnUpdate": false,
"ignoreCaseOnDiff": false,
"dependencies": {
"dependencies": [
"string"
]
},
"enum": [
{}
],
"const": {},
"default": {},
"$data": "string",
"$dynamicDefault": "string",
"metadata": {
"metadata": {}
}
}
400
'Bad Request' if the RunnableItem is not in specified 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 '{"id":"string","type":"string"}' https://{api_host}/form-service/api/custom/schema-generation/json
On This Page
Schema Generation Services Operations
POST
Generate
Deprecated
POST
Get Json Object Schema
POST
Get Form Layout Schema