Forms Service API Data Structures
{
"signpost": "string",
"description": "string",
"refresh": {
"type": "string"
},
"step": "number",
"label": "string",
"placeholder": "string",
"id": "string",
"type": "FormSchemaFieldType Object",
"shortValueName": [
"string"
]
}
default
signpost
valueList
description
step
label
placeholder
id
shortValueName
{
"typeId": "string"
}
typeId
{
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"designerHidden": "boolean",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
}
{
"size": "integer"
}
size
{
"size": "integer",
"labelDisplaySize": "integer",
"extensionRendererContext": {
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"extensionId": "string"
},
"columns": [
"DesignerLayoutField Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"label": "string",
"permissibleValuesContext": {
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"providerEntityId": "string"
},
"customField": "boolean",
"staticField": "boolean",
"permissibleValues": {
"customAllowed": "boolean"
},
"initialStaticState": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"displayAdvice": "string",
"orderIndex": "integer",
"id": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"refreshOnChange": "boolean",
"errors": [
"string"
]
}
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"designerHidden": "boolean",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
id
label
{
"items": [
{
"size": "integer"
}
]
}
{
"designerHidden": "boolean",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
designerHidden
id
label
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"providerEntityId": "string"
}
providerEntityId
{
"dependencies": [
"string"
],
"facets": [
{}
]
}
dependencies
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"extensionId": "string"
}
extensionId
{
"externalValidations": [
{
"label": "string",
"source": {
"id": "string",
"type": "string",
"parameters": [
{}
]
},
"target": [
"string"
]
}
]
}
context
{
"label": "string",
"source": {
"id": "string",
"type": "string",
"parameters": [
{}
]
},
"target": [
"string"
]
}
label
target
{
"id": "string",
"type": "string",
"parameters": [
{}
]
}
id
type
parameters
{
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"columns": [
"Field Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"orderIndex": "integer",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}
displayAdvice
isMultiValued
description
orderIndex
id
label
{
"dataType": "string",
"value": "string"
}
dataType
value
{
"filter": "string",
"valueType": {
"dataType": "string",
"referenceType": "string",
"isMultiple": "boolean",
"fields": [
"ComplexTypeField Object"
]
},
"valueSource": {
"id": "string",
"type": "string",
"parameters": [
{}
]
}
}
filter
context
{
"filter": "string",
"valueType": {
"dataType": "string",
"referenceType": "string",
"isMultiple": "boolean",
"fields": [
"ComplexTypeField Object"
]
},
"resultSize": "integer"
}
filter
resultSize
{
"name": "string",
"useResultFromRequestId": "integer",
"value": "string"
}
name
useResultFromRequestId
value
{
"requestId": "integer",
"uri": "string",
"dataSource": "string",
"parameters": [
{
"name": "string",
"useResultFromRequestId": "integer",
"value": "string"
}
]
}
contextParameters
requestId
uri
dataSource
{
"dataType": "string",
"referenceType": "string",
"isMultiple": "boolean",
"fields": [
"ComplexTypeField Object"
]
}
dataType
referenceType
isMultiple
{
"formData": "string",
"type": "string"
}
formData
type
{
"blueprintSchema": {
"fields": [
{
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"columns": [
"Field Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"orderIndex": "integer",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}
]
},
"formDefinition": "string"
}
formDefinition
labelDisplaySize
isMultiValued
description
label
customField
staticField
displayAdvice
orderIndex
id
refreshOnChange
errors
{
"key": "string"
}
key
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{}
],
"first": "boolean",
"totalElements": "integer"
}
number
size
last
numberOfElements
totalPages
content
first
totalElements
{
"key": "string"
}
key
{
"params": [
{
"key": "string"
}
]
}
{
"customAllowed": "boolean"
}
customAllowed
{
"type": "string"
}
type
{
"setLocation": "boolean",
"httpStatus": "string"
}
setLocation
httpStatus
httpHeaders
body
{
"fields": [
{
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"columns": [
"Field Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"orderIndex": "integer",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}
]
}
{
"designerLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"designerHidden": "boolean",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"name": "string"
}
name
Wraps a boolean value.
{
"value": "boolean"
}
The boolean value.
{
"parent": "string",
"form": {
"designerLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"designerHidden": "boolean",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"name": "string"
},
"formTypeData": {
"formData": "string",
"type": "string"
},
"name": "string",
"formData": "string",
"styles": "string",
"id": "string",
"type": "string",
"tenant": "string"
}
parent
name
formData
styles
id
type
tenant
Wraps a value such that values of different types can be treated generically.
Equivalent of java.util.Map
{
"entries": [
{
"key": "string"
}
]
}
A literal defining period of time. This period is represented some integral number of a specified timeUnit.e.g. 6 days.
{
"unit": "string",
"amount": "integer"
}
The unit of measure for the time span. e.g: days.
The amount for the time span.
{
"label": "string"
}
label