All the endpoints that can be called on the Form controller.
Endpoints that require the FORM_READ permission:
GET index
GET item
GET getFormForTicket
Endpoints that require the FORM_CUD permission:
POST index
PUT item
DELETE item
Additionally, PUT saveFormFields requires the FORM_SAVE permission.
Returns all of the existing forms.
""Pattern: ^[0-9a-zA-Z ]+$015GET /api/v2/form HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*
No content
Returns this form by its ID.
Optionally, you can send a ticket ID with it to get the form values for that ticket.
GET /api/v2/form/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*
No content
Creates a new form for this brand.
^[a-zA-Z0-9 ]+$POST /api/v2/form HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 29
{
"brand_id": 1,
"title": "text"
}No content
Updates this form by its ID.
^[a-zA-Z0-9 ]+$PUT /api/v2/form/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 29
"brand_id=1&title='text'"No content
Permanently deletes this form by its ID.
Optional parameter if you want to send a description for deletion.
DELETE /api/v2/form/{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
Saves the values of the form fields of this ticket.
PUT /api/v2/form/saveFormFields HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 72
"ticketID=1&fields=[{'formFieldID':'text','formFieldValue':'text'}]"No content