Please enable JavaScript to view this site.

Error itgendoc001X

xMsg javascript has not been loaded.

Freshdesk API Data Model

Navigation: Schema: Freshdesk > Tables

ticket_by_id: Freshdesk Ticket

Contents Previous Home Next More

Catalog: Freshdesk

Schema: Freshdesk

Primary Keys: id

Label: Ticket

This is a read-only table function. The Freshdesk API may not support changing the data or the Invantive SQL driver for Freshdesk does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Freshdesk API.

Select Freshdesk API URL: /tickets/{id}?include=requester,stats,company

Insert Freshdesk API URL: /tickets/{id}?include=requester,stats,company

Update Freshdesk API URL: /tickets/{id}?include=requester,stats,company

Delete Freshdesk API URL: /tickets/{id}?include=requester,stats,company

Field Selection Method: NotRequired

Table Function Parameters

The following parameters can be used to control the behaviour of the table function ticket_by_id. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

id

decimal

 

 

 

Table Function Columns

The columns of the table function ticket_by_id are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

closed_at

datetime

Closed at

 

company_id

int64

Company ID

 

company_name

string

Company Name

 

created_at

datetime

Created at

 

description

string

Description

 

description_text

string

Description

 

due_by

datetime

Due by

 

email_config_id

int64

Email Configuration ID

 

first_responded_at

datetime

First Responded at

 

fr_due_by

datetime

From Due by

 

fr_escalated

boolean

From Escalated

 

group_id

int64

Group ID

 

id

int64

ID

 

is_escalated

boolean

Is Escalated

 

priority

int64

Priority

 

product_id

int64

Product ID

 

requester_email

string

Requester Email

 

requester_id

int64

Requester ID

 

requester_name

string

Requester Name

 

requester_phone

string

Requester Phone

 

resolved_at

datetime

Resolved at

 

responder_id

int64

Responder ID

 

source

int64

Source

 

spam

boolean

Spam

 

status

int64

Status

 

subject

string

Subject

 

type

string

Type

 

updated_at

datetime

Updated at

 

 

12-12-2020 13:14 Version 20.1.301-BETA+3023