Update a single category
Catalog: Discourse
Schema: Categories
This is a read-only table function. The Discourse API may not support changing the data or the Invantive SQL driver for Discourse does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Discourse API.
Select Discourse API URL: /categories/{id}
Insert Discourse API URL: /categories/{id}
Update Discourse API URL: /categories/{id}
Delete Discourse API URL: /categories/{id}
Field Selection Method: NotRequired
Select Discourse API Operation: put /categories/{id}
The following parameters can be used to control the behaviour of the table function putCategoriesById. 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 |
---|---|---|---|---|
body |
string |
☑ |
|
|
The columns of the table function putCategoriesById are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
category_allow_badges |
boolean |
Category Allow Badges |
☐ |
|
category_auto_close_based_on_last_post |
boolean |
Category Auto Close Based On Last Post |
☐ |
|
category_background_url |
string |
Category Background URL |
☐ |
|
category_can_delete |
boolean |
Category Can Delete |
☐ |
|
category_can_edit |
boolean |
Category Can Edit |
☐ |
|
category_color |
string |
Category Color |
☐ |
|
category_email_in_allow_strangers |
boolean |
Category Email in Allow Strangers |
☐ |
|
category_id |
decimal |
Category ID |
☐ |
|
category_logo_url |
string |
Category Logo URL |
☐ |
|
category_name |
string |
Category Name |
☐ |
|
category_position |
decimal |
Category Position |
☐ |
|
category_post_count |
decimal |
Category Post Count |
☐ |
|
category_read_restricted |
boolean |
Category Read Restricted |
☐ |
|
category_slug |
string |
Category Slug |
☐ |
|
category_suppress_from_homepage |
boolean |
Category Suppress From Homepage |
☐ |
|
category_text_color |
string |
Category Text Color |
☐ |
|
category_topic_count |
decimal |
Category Topic Count |
☐ |
|
category_topic_template |
string |
Category Topic Template |
☐ |
|
category_topic_url |
string |
Category Topic URL |
☐ |
|
success |
string |
Success |
☐ |
|
12-12-2020 18:47 Version 20.1.301-BETA+3023