Forms Service API Data Structures
ActionParameter
JSON Example
{
"$type": {
"dataType": "string",
"referenceType": "string",
"fields": [
"ComplexTypeField_1 Object"
],
"isMultiple": "boolean"
}
}
ComplexTypeField
JSON Example
{
"description": "string",
"id": "string",
"label": "string",
"placeholder": "string",
"refresh": {
"type": "string"
},
"shortValueName": [
"string"
],
"signpost": "string",
"step": "number",
"type": "FormSchemaFieldType Object"
}object
default
Optional
default
string
description
Optional
description
string
id
Optional
id
string
label
Optional
label
string
placeholder
Optional
placeholder
array of string
shortValueName
Optional
shortValueName
string
signpost
Optional
signpost
number As float As float
step
Optional
step
object
valueList
Optional
valueList
object
valueTree
Optional
valueTree
ComplexTypeField_1
JSON Example
{
"constraints": {
"matchConstraint": {},
"patternConstraint": {}
},
"description": "string",
"id": "string",
"label": "string",
"placeholder": "string",
"refresh": {
"type": "string"
},
"shortValueName": [
"string"
],
"signpost": "string",
"step": "number",
"type": "FormSchemaFieldType_1 Object",
"valueTree": [
{
"label": "string",
"isValidSelection": "boolean",
"children": [
"ValueTreeItem Object"
]
}
]
}object
default
Optional
default
string
description
Optional
description
string
id
Optional
id
string
label
Optional
label
string
placeholder
Optional
placeholder
array of string
shortValueName
Optional
shortValueName
string
signpost
Optional
signpost
number As float As float
step
Optional
step
object
valueList
Optional
valueList
Constraints
This data structure has no properties.
Constraints_1
JSON Example
{
"matchConstraint": {},
"patternConstraint": {}
}
DynamicValueDefinition
JSON Example
{
"authentication_type": "string",
"endpoint": {
"variableNames": [
"string"
]
},
"http_method": "string",
"id": "string",
"input_parameters": [
{
"dataType": "string",
"id": "string",
"isArray": "boolean",
"name": "string",
"parameterType": "string",
"propertyJsonPointer": "string",
"responseJsonPointer": "string"
}
],
"name": "string",
"output_parameters": [
{
"dataType": "string",
"id": "string",
"isArray": "boolean",
"name": "string",
"parameterType": "string",
"propertyJsonPointer": "string",
"responseJsonPointer": "string"
}
],
"password": "string",
"shared": "boolean",
"tenant": "string",
"username": "string",
"version": "string"
}string
authentication_type
Required
authentication_type
string
http_method
Optional
http_method
string As uuid As uuid
id
Optional
id
string
name
Optional
name
string
password
Optional
password
boolean
shared
Optional
shared
string
tenant
Optional
tenant
string
username
Optional
username
string
version
Optional
version
DynamicValueDefinitionParameter
JSON Example
{
"dataType": "string",
"id": "string",
"isArray": "boolean",
"name": "string",
"parameterType": "string",
"propertyJsonPointer": "string",
"responseJsonPointer": "string"
}string
dataType
Optional
dataType
string As uuid As uuid
id
Optional
id
boolean
isArray
Optional
isArray
string
name
Optional
name
string
parameterType
Optional
parameterType
string
propertyJsonPointer
Optional
propertyJsonPointer
string
responseJsonPointer
Optional
responseJsonPointer
ExternalValidationContext
JSON Example
{
"externalValidations": [
{
"label": "string",
"source": {
"id": "string",
"type": "string",
"parameters": [
{
"$type": {
"dataType": "string",
"referenceType": "string",
"fields": [
"ComplexTypeField_1 Object"
],
"isMultiple": "boolean"
}
}
]
},
"target": [
"string"
]
}
]
}object
context
Optional
context
ExternalValidationElement
JSON Example
{
"label": "string",
"source": {
"id": "string",
"type": "string",
"parameters": [
{
"$type": {
"dataType": "string",
"referenceType": "string",
"fields": [
"ComplexTypeField_1 Object"
],
"isMultiple": "boolean"
}
}
]
},
"target": [
"string"
]
}string
label
Optional
label
array of string
target
Optional
target
ExternalValueSource
JSON Example
{
"id": "string",
"type": "string",
"parameters": [
{
"$type": {
"dataType": "string",
"referenceType": "string",
"fields": [
"ComplexTypeField_1 Object"
],
"isMultiple": "boolean"
}
}
]
}string
id
Optional
id
string
type
Optional
type
FormDefinition
JSON Example
{
"createdDate": "string",
"form": "string",
"id": "string",
"modifiedDate": "string",
"name": "string",
"sourceId": "string",
"sourceType": "string",
"status": "string",
"styles": "string",
"tenant": "string",
"type": "string"
}string As date-time As date-time
createdDate
Optional
createdDate
string
form
Optional
form
string As uuid As uuid
id
Optional
id
string As date-time As date-time
modifiedDate
Optional
modifiedDate
string
name
Optional
name
string
sourceId
Optional
sourceId
string
sourceType
Optional
sourceType
string
status
Optional
status
string
styles
Optional
styles
string
tenant
Optional
tenant
string
type
Optional
type
FormExtSourceParamSpec
JSON Example
{
"paramName": "string",
"paramType": {
"dataType": "string",
"fields": [
"ComplexTypeField Object"
],
"isMultiple": "boolean",
"referenceType": "string"
}
}string
paramName
Optional
paramName
FormExtValueSourceSearchRequest
JSON Example
{
"externalSource": "string",
"filter": "string",
"resultSize": "integer",
"valueType": {
"dataType": "string",
"referenceType": "string",
"fields": [
"ComplexTypeField_1 Object"
],
"isMultiple": "boolean"
}
}string
externalSource
Optional
externalSource
string
filter
Optional
filter
integer As int32 As int32
resultSize
Optional
resultSize
FormExtValueSourceSpec
JSON Example
{
"category": "string",
"description": "string",
"fqn": "string",
"inputParameters": [
{
"paramName": "string",
"paramType": {
"dataType": "string",
"fields": [
"ComplexTypeField Object"
],
"isMultiple": "boolean",
"referenceType": "string"
}
}
],
"name": "string",
"resultType": {
"dataType": "string",
"fields": [
"ComplexTypeField Object"
],
"isMultiple": "boolean",
"referenceType": "string"
}
}string
category
Optional
category
string
description
Optional
description
string
fqn
Optional
fqn
string
name
Optional
name
FormExternalDataError
JSON Example
{
"detailsMessage": "string",
"summaryMessage": "string"
}string
detailsMessage
Optional
detailsMessage
string
summaryMessage
Optional
summaryMessage
FormExternalDataParameter
JSON Example
{
"name": "string",
"useResultFromRequestId": "integer",
"value": "string"
}string
name
Optional
name
integer As int32 As int32
useResultFromRequestId
Optional
useResultFromRequestId
string
value
Optional
value
FormExternalDataRequest
JSON Example
{
"dataSource": "string",
"parameters": [
{
"name": "string",
"useResultFromRequestId": "integer",
"value": "string"
}
],
"requestId": "integer",
"uri": "string"
}object
contextParameters
Optional
contextParameters
string
dataSource
Optional
dataSource
integer As int32 As int32
requestId
Optional
requestId
string
uri
Optional
uri
FormSchemaFieldType
JSON Example
{
"dataType": "string",
"fields": [
"ComplexTypeField Object"
],
"isMultiple": "boolean",
"referenceType": "string"
}string
dataType
Optional
dataType
boolean
isMultiple
Optional
isMultiple
string
referenceType
Optional
referenceType
FormSchemaFieldType_1
JSON Example
{
"dataType": "string",
"referenceType": "string",
"fields": [
"ComplexTypeField_1 Object"
],
"isMultiple": "boolean"
}string
dataType
Optional
dataType
string
referenceType
Optional
referenceType
boolean
isMultiple
Optional
isMultiple
MatchConstraint
This data structure has no properties.
object
match
Optional
match
Mono_DynamicValueDefinition_
This data structure has no properties.
Mono_FormDefinition_
This data structure has no properties.
Mono_FormExtValueSourceSearchResponse_
This data structure has no properties.
Mono_FormExternalDataResponse_
This data structure has no properties.
Mono_List_FormValidationMessage_
This data structure has no properties.
Mono_Page_DynamicValueDefinition_
This data structure has no properties.
Mono_RendererModelResponse_
This data structure has no properties.
Mono_ResponseEntity_object_
This data structure has no properties.
Mono_Void_
This data structure has no properties.
Mono_string_
This data structure has no properties.
Pageable
JSON Example
{
"offset": "integer",
"pageNumber": "integer",
"pageSize": "integer",
"paged": "boolean",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"unpaged": "boolean"
}integer As int64 As int64
offset
Optional
offset
integer As int32 As int32
pageNumber
Optional
pageNumber
integer As int32 As int32
pageSize
Optional
pageSize
boolean
paged
Optional
paged
boolean
unpaged
Optional
unpaged
PatternConstraint
This data structure has no properties.
object
pattern
Optional
pattern
Refresh
JSON Example
{
"type": "string"
}string
type
Optional
type
Sort
JSON Example
{
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
}boolean
empty
Optional
empty
boolean
sorted
Optional
sorted
boolean
unsorted
Optional
unsorted
UriTemplate
JSON Example
{
"variableNames": [
"string"
]
}array of string
variableNames
Optional
variableNames
ValueTreeItem
JSON Example
{
"label": "string",
"isValidSelection": "boolean",
"children": [
"ValueTreeItem Object"
]
}object
value
Optional
value
string
label
Optional
label
boolean
isValidSelection
Optional
isValidSelection
Node: apidepo-liferay-dxp-v1-be-w-1:8080: