Create Form

Create Form

Create form definition.

Request
URI
POST
https://vra-interop-222-139.lvn.broadcom.net/form-service/api/forms
COPY
Query Parameters
boolean
generateUnvalidatableExternalValuesSchema
Optional

generateUnvalidatableExternalValuesSchema

boolean
lockForm
Optional

Locks the content of the form (layout, schema) making it immutable if set to true, but still allows updates to the form's status

Request Body
FormDefinition of type(s) application/json
Required

Show optional properties

{
    "name": "string",
    "status": "string"
}
{
    "tenant": "string",
    "id": "string",
    "name": "string",
    "form": "string",
    "styles": "string",
    "sourceType": "string",
    "sourceId": "string",
    "type": "string",
    "status": "string",
    "createdDate": "string",
    "modifiedDate": "string",
    "formFormat": "string",
    "providerRef": "string"
}
string
tenant
Optional

tenant

string As uuid As uuid
id
Optional

id

string
name
Required

name

string
form
Optional

form

string
styles
Optional

styles

string
sourceType
Optional

sourceType

string
sourceId
Optional

sourceId

string
type
Optional

type

string
status
Required

status

Possible values are : off, on, invalid, generated,
string As date-time As date-time
createdDate
Optional

createdDate

string As date-time As date-time
modifiedDate
Optional

modifiedDate

string
formFormat
Optional

formFormat

Possible values are : YAML, JSON,
string
providerRef
Optional

providerRef

Authentication
This operation uses the following authentication methods.
Responses
201

'Created'

Operation doesn't return any data structure

400

'Bad Request' if called with service token with no org.

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 -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","status:"string"}' https://{api_host}/form-service/api/forms
On This Page
Form Definition Operations
POST
Search Form Status
POST
Create Form
GET
Get Form
DELETE
Delete Form
GET
Search By Source And Type
DELETE
Delete Form 1