discussion_forums_by_id: Freshdesk Discussion Category Forums |
Catalog: Freshdesk
Schema: Freshdesk
Primary Keys: id
Label: Discussion Category Forums
This is a read-only table function. The Freshdesk API may not support changing the data or the Invantive UniversalSQL driver for Freshdesk does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Freshdesk API.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function discussion_forums_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 evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `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 |
|
☑ |
|
|
Columns of Table Function
The columns of the table function discussion_forums_by_id are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
comments_count |
int64 |
Comments Count |
☐ |
|
description |
varchar2 |
Description |
☐ |
Description. |
forum_category_id |
int64 |
Forum Category ID |
☐ |
The ID of the category of this forum. |
forum_type |
int64 |
Forum Type |
☐ |
The type of the forum. See ForumTypes. |
forum_visibility |
int64 |
Forum Visibility |
☐ |
The visibility of the forum. See ForumVisibilities. |
id |
int64 |
ID |
☐ |
Unique ID. |
name |
varchar2 |
Name |
☐ |
Name. |
position |
int64 |
Position |
☐ |
The rank of the forum in the forum listing. |
posts_count |
int64 |
Posts Count |
☐ |
The number of comments on the forum. |
topics_count |
int64 |
Topics Count |
☐ |
The number of topics in the forum. |