Formfield

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.

index

get

Returns all form fields with optional filters such as search queries, views and result limits.

Authorizations

apikeyAuth

HTTPRequired

Responses

200

Successful response

application/json

get

/api/v2/formfield

HTTPcURLJavaScriptPython

GET /api/v2/formfield HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

index

post

Creates a new form field.

If you want to add multiple required statuses, multiply the required_statuses key and give the empty brackets indices.

Authorizations

apikeyAuth

HTTPRequired

Body

multipart/form-data

form_idstringOptional

type: number

titlestringOptional

type: string

input_typestringOptional

type: ^(text(area|readonly|hidden)?|select(readonly|hidden)?)$

field_orderstringOptional

type: number = null

required_statuses[]stringOptional

type: ^(open|pending|holding|solved)$ = null

Responses

200

Successful response

application/json

post

/api/v2/formfield

HTTPcURLJavaScriptPython

POST /api/v2/formfield HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 103

{
  "form_id": "text",
  "title": "text",
  "input_type": "text",
  "field_order": "text",
  "required_statuses[]": "text"
}

200

Successful response

item

get

Returns this specific form field by ID.

Authorizations

apikeyAuth

HTTPRequired

Path parameters

idstringRequired

Responses

200

Successful response

application/json

get

/api/v2/formfield/{id}

HTTPcURLJavaScriptPython

GET /api/v2/formfield/{id} HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

item

put

Updates this form field.

Identical to POST index, except this one also has an external code parameter.

If you want to update multiple required statuses, multiply the required_statuses key and give the empty brackets indices.

Authorizations

apikeyAuth

HTTPRequired

Path parameters

idstringRequired

Body

application/x-www-form-urlencoded

form_idstringOptional

type: number

titlestringOptional

type: string

input_typestringOptional

type: ^[a-z]+$

field_orderstringOptional

type: number = null

external_codestringOptional

type: string = null

required_statuses[]stringOptional

type: ^(open|pending|holding|solved)$ = null

Responses

200

Successful response

application/json

put

/api/v2/formfield/{id}

HTTPcURLJavaScriptPython

PUT /api/v2/formfield/{id} HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 126

"form_id='text'&title='text'&input_type='text'&field_order='text'&external_code='text'&required_statuses[]='text'"

200

Successful response

item

delete

Permanently deletes this form field.

Authorizations

apikeyAuth

HTTPRequired

Path parameters

idstringRequired

Responses

200

Successful response

application/json

delete

/api/v2/formfield/{id}

HTTPcURLJavaScriptPython

DELETE /api/v2/formfield/{id} HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response