-
createFormGroupEntry
Add Group to Form
POST /formbuilder/forms/:name/groupsAdd a group to the list of groups for a Form
-
deleteForm
Delete a Form by ID
POST /formbuilder/deleteForm/:idDelete a form from the database by its ID
-
deleteFormGroups
Remove all authorization restriction for a Form
DELETE /formbuilder/forms/:name/groupsClear all groups that can access a form, making it accessible to everyone
-
exportForm
Export Form
POST /formbuilder/forms/exportExport a single Form
-
fetchData
Get Service Instance Data
POST /formbuilder/fetchDataReturns service related data
-
getElementDefinition
Gets an Element Definition.
GET /formbuilder/getElementDefinition/:type/:idGet the details about a particular element to be used in a form
-
getForm
Get Details of Form by ID
GET /formbuilder/getForm/:form_idGet details for a specific form from by ID
-
getFormByName
Get Details of Form by Name
GET /formbuilder/getFormByName/:form_nameGet details for a specific form by name
-
importForm
Import Form
POST /formbuilder/forms/importImport a single Form
-
listElements
Lists all Elements Usable in Forms
GET /formbuilder/listElementsFind all elements allowed to be added to a form
-
listFormGroups
List Groups for a Form
GET /formbuilder/forms/:name/groupsList the groups that have access to a Form
-
listForms
List All Form Names
GET /formbuilder/listFormsList the names of all available forms
-
preserveFormData
Preserve incoming form data format
POST /formbuilder/preserveFormDataFind and revert containers object/array mutation
-
ProviderForm
Show Form and Set Dropdown List Values (manual workflow task)
/formbuilder/task/ProviderFormDisplay any form created with the Form Builder IAP application. Form dropdown lists display a fixed set of choices. Static dropdown choices can be configured in Form Builder as properties for the control. This task will dynamically set dropdown lists' choices or replace static dropdown lists' choices when the dropdown list is not located in a form table.
-
removeFormGroup
Remove a Group from a Form
DELETE /formbuilder/forms/:name/groups/:groupRemove a group from the list of authorized groups for a Form
-
replaceFormGroups
Overwrite Groups for a Form
PUT /formbuilder/forms/:name/groupsOverwrite the list of groups that have access to a Form
-
saveForm
Save a Generated Form
POST /formbuilder/saveFormSave a generated form with its data.
-
searchForms
Search Forms
POST /formbuilder/forms/searchSearch forms with options
-
ShowFormByName
Show Form by Name (manual workflow task)
/formbuilder/task/ShowFormByNameDisplay any form created with the Form Builder IAP application.
-
ShowFormPreserveData
Show Form and Pop Yang Containers (manual workflow task)
/formbuilder/task/ShowFormPreserveDataDisplay any form created with the Form Builder IAP application. Optionally instruct form how to return YANG container data in a YANG service instance. YANG container data can be returned unmodified or as an element in a single-element array.
2021.2 (latest)
- API REFERENCE
- USER
- ADMIN
- DEVELOPER
- PRODUCT NOTICES