Search Form Definitions
Search for form definitions and form versions with the specified term.
Request
URI
GET
https://vra-interop-222-139.lvn.broadcom.net/form-service/api/forms/search
COPY
Query Parameters
string
term
Optional
Search term
integer
page
Optional
Constraints:
default: 0
Zero-based page index (0..N)
integer
size
Optional
Constraints:
default: 20
The size of the page to be returned
string of
array
sort
Optional
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
Responses
200
'Success'
Returns
PageFormAndVersionSearchResult
of type(s)
application/json
{
"totalElements": 0,
"totalPages": 0,
"size": 0,
"content": [
{
"formId": "string",
"formName": "string",
"sourceType": "string",
"imported": false,
"versionId": "string",
"versionName": "string",
"displayName": "string",
"form": {
"layout": {
"pages": [
{
"id": "string",
"title": "string",
"sections": [
{
"id": "string",
"fields": [
{
"id": "string",
"display": "string",
"nestedFields": [
{
"id": "string",
"display": "string",
"styles": "string",
"state": {
"readonlyState": {
"read-only": {}
},
"visibilityState": {
"visible": {}
}
},
"size": 0,
"submit": false,
"signpostPosition": "string"
}
],
"styles": "string",
"state": {
"readonlyState": {
"read-only": {}
},
"visibilityState": {
"visible": {}
}
},
"size": 0,
"submit": false,
"signpostPosition": "string"
}
],
"state": {
"readonlyState": {
"read-only": {}
},
"visibilityState": {
"visible": {}
}
}
}
],
"state": {
"readonlyState": {
"read-only": {}
},
"visibilityState": {
"visible": {}
}
}
}
]
},
"schema": {},
"messages": [
{
"fieldId": "string",
"severity": "string",
"validationType": "string",
"message": "string"
}
],
"options": {
"externalValidations": [
{
"label": "string",
"source": {
"id": "string",
"type": "string",
"parameters": [
{
"$type": {
"dataType": "string",
"referenceType": "string",
"fields": [
"ComplexTypeField Object"
],
"isMultiple": false
}
}
],
"isPageable": false,
"externalSourceProviderType": "string"
},
"target": [
"string"
]
}
]
}
},
"styles": "string"
}
],
"number": 0,
"sort": [
{
"direction": "string",
"nullHandling": "string",
"ascending": false,
"property": "string",
"ignoreCase": false
}
],
"numberOfElements": 0,
"pageable": {
"offset": 0,
"sort": [
{
"direction": "string",
"nullHandling": "string",
"ascending": false,
"property": "string",
"ignoreCase": false
}
],
"paged": false,
"pageNumber": 0,
"pageSize": 0,
"unpaged": false
},
"first": false,
"last": false,
"empty": false
}
integer As int64
As int64
totalElements
Optional
totalElements
integer As int32
As int32
totalPages
Optional
totalPages
integer As int32
As int32
size
Optional
size
array of
object
content
Optional
content
integer As int32
As int32
number
Optional
number
array of
object
sort
Optional
sort
integer As int32
As int32
numberOfElements
Optional
numberOfElements
object
pageable
Optional
pageable
boolean
first
Optional
first
boolean
last
Optional
last
boolean
empty
Optional
empty
400
'Bad Request'
Operation doesn't return any data structure
403
'Forbidden' when the user has no admin access rights.
Operation doesn't return any data structure
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/form-service/api/forms/search