Ticketing_Field
Field of ticket.
Ticketing_Fields
- Ticketing_Fields Manage
GET ticketing/fields
GET ticketing/fields/{id}
POST ticketing/fields
PUT ticketing/fields/{id}
DELETE ticketing/fields/{id}
Model
Ticketing_Field JSON Format
Ticketing_Field is represented as simple flat JSON objects with the following keys:
| Name | Type | Description |
|---|---|---|
isSystem |
bool | Whether the field is a system field or not. |
isRequired |
bool | Whether the field value is required or not. |
type |
string | Type of the field. Allowed values are "text", "textArea", "email", "url", "date", "integer", "float", "agent", "radioButton", "checkBox", "dropdownList", "checkboxList", "link", "department", "phone", "channelAccount", "channel", "tag". |
name |
string | Name of the field. |
systemName |
string | Field name for system. |
length |
integer | Field length. |
helpText |
string | Description of the field. |
defaultValue |
string | Default value of the field. |
linkURL |
string | URL of the field. Only the field with link type will have such value. |
id |
guid | Id of the field. |
order |
integer | |
fieldOptions |
fieldOptions[] | Reference to Field Option. |
Field Option JSON Format:
| Name | Type | Description |
|---|---|---|
id |
guid | Id of the field option. |
fieldId |
guid | Id of the field which the option belongs to. |
value |
string | Value of the option. |
order |
integer | Order of the option. |
displayText |
string | Display text of the option. |
Endpoint
Get the list of Ticketing_Fields
GET ticketing/fields
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
keywords |
string | query | no | Filter by field name. |
include |
string | query | no | Allowed values are "ticketingFieldOption", "ticketingFieldMapping". |
Response:
An array of Ticketing_Field
Example
Sample Request:
curl https://api15.comm100.io/v4/ticketing/fields \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Get a single Ticketing_Field
GET ticketing/fields/{id}
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
include |
string | query | no | Allowed values are "ticketingFieldOption", "ticketingFieldMapping". |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/ticketing/fields/110499d0-5a3e-469f-b8de-9a34e99092b0 \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Create a new Ticketing_Field
POST ticketing/fields
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
isSystem |
bool | body | no | Whether the field is a system field or not. |
isRequired |
bool | body | no | Whether the field value is required or not. |
type |
string | body | no | Type of the field. Allowed values are "text", "textArea", "email", "url", "date", "integer", "float", "agent", "radioButton", "checkBox", "dropdownList", "checkboxList", "link", "department", "phone", "channelAccount", "channel", "tag". |
name |
string | body | yes | Name of the field. |
systemName |
string | body | no | Field name for system. |
length |
integer | body | no | Field length. |
helpText |
string | body | no | Description of the field. |
defaultValue |
string | body | no | Default value of the field. |
linkURL |
string | body | yes | URL of the field. Only the field with link type will have such value. |
order |
integer | body | no | |
fieldOptions |
fieldOptions[] | body | no | Option in ticket field. |
fieldMapping |
fieldMapping | body | no | Mapping in ticket field mapping. |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/ticketing/fields \
-X
'POST'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"isSystem":false,"isRequired":false,"type":"dropdownList","name":"My Select","systemName":"","length":256,"helpText":"My custom select.","defaultValue":"op1","linkURL":"","order":1,"fieldOptions":[{"value":"op1","order":1,"displayText":"op1"}],"fieldMapping":{"mappedChatField":"{!Visitor.Current Page URL}","mappedOfflineMessageField":"{!Visitor.Email}"}}'
Response:
HTTP/1.1 201 Created
Update the Ticketing_Field
PUT ticketing/fields/{id}
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
isSystem |
bool | body | no | Whether the field is a system field or not. |
isRequired |
bool | body | no | Whether the field value is required or not. |
type |
string | body | no | Type of the field. Allowed values are "text", "textArea", "email", "url", "date", "integer", "float", "agent", "radioButton", "checkBox", "dropdownList", "checkboxList", "link", "department", "phone", "channelAccount", "channel", "tag". |
name |
string | body | yes | Name of the field. |
systemName |
string | body | no | Field name for system. |
length |
integer | body | no | Field length. |
helpText |
string | body | no | Description of the field. |
defaultValue |
string | body | no | Default value of the field. |
linkURL |
string | body | yes | URL of the field. Only the field with link type will have such value. |
order |
integer | body | no | |
fieldOptions |
fieldOptions[] | body | no | Option in ticket field. |
fieldMapping |
fieldMapping | body | no | Mapping in ticket field mapping. |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/ticketing/fields/110499d0-5a3e-469f-b8de-9a34e99092b0 \
-X
'PUT'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"isSystem":false,"isRequired":false,"type":"dropdownList","name":"My Select","systemName":"","length":256,"helpText":"My custom select.","defaultValue":"op1","linkURL":"","order":1,"fieldOptions":[{"value":"op1","order":1,"displayText":"op1"}],"fieldMapping":{"mappedChatField":"{!Visitor.Current Page URL}","mappedOfflineMessageField":"{!Visitor.Email}"}}'
Response:
HTTP/1.1 200 OK
Remove the Ticketing_Field
DELETE ticketing/fields/{id}
Parameters:
No Parameters
Response:
No Content
Example
Sample Request:
curl https://api15.comm100.io/v4/ticketing/fields/110499d0-5a3e-469f-b8de-9a34e99092b0 \
-X
'DELETE'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 204 No Content