All the endpoints that can be called on the Formfield controller.
Each endpoint requires the FORM_CUD
permission, except for GET
index, which requires the FORM_READ
permission.
Returns all form fields with optional filters such as search queries, views and result limits.
""
Pattern: ^[0-9a-zA-Z ]+$
0
15
GET /api/v2/formfield HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*
No content
Creates a new form field.
If you want to add multiple required statuses, simply send an array of the statuses needed.
POST /api/v2/formfield HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 93
{
"form_id": 1,
"title": "text",
"input_type": "text",
"field_order": 1,
"required_statuses": [
"open"
]
}
No content
Updates this form field.
Identical to POST
index, except this one also has an external code parameter.
If you want to add multiple required statuses, simply send an array of the statuses needed.
PUT /api/v2/formfield/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 116
"form_id=1&title='text'&input_type='text'&field_order=1&external_code='text'&required_statuses=['open']"
No content
Permanently deletes this form field.
Optional parameter if you want to send a description for deletion.
DELETE /api/v2/formfield/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 22
"description='text'"
No content