Parameter name | Value | Description |
---|---|---|
id |
string |
Identifier of the form's company. |
author |
string |
Author of the form. |
name |
string |
Name of the form. |
fields[] |
string |
Fields of the form. |
fields[].id |
string |
Id of the fields. |
fields[].type |
string |
Type of the field. Values:
|
fields[].label |
string |
Label of the field. |
fields[].help |
string |
Help text of the field. |
fields[].mandatory |
boolean |
If the field is mandatory. |
fields[].order |
integer |
Order number of the fields. First field of the form has order number 1. |
fields[].values |
string |
Values list of the field. |
fields[].visible |
boolean |
If the field is visible by client. |
Authentication is required to execute this request. Please refer to Authentication for more.
{companyId}
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
companyId |
string |
Company identifier. |
Do not supply a request body with this method.
If successful, this method returns a Form resource in the response body.
Authentication is required to execute this request. Please refer to Authentication for more.
Do not supply a request body with this method.
If successful, this method returns a response body with the following structure: