Categories: Discourse Categories
read only REST
- Catalog:
Discourse - Schema:
Categories - Label: Categories
Get a list of categories The Categories endpoint returns a list of all the categories for your discourse site that you have access to.
Can only retrieve data.
Summary
The Categories endpoint returns a list of all the categories for your discourse site that you have access to.
API Source
- Endpoint:
/categories.json - Operation:
get /categories.json
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 243 |
| Write rows per minute | 219 |
The result can be cached on the client.
Table Columns
The columns of the table Categories are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.
| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
background_ |
varchar2 |
Background URL | writable, background_ |
||
can_ |
char |
Can Create Category | filters on the platform, writable, ::ancestor. |
||
can_ |
char |
Can Create Topic | filters on the platform, writable, ::ancestor. |
||
can_ |
char |
Can Edit | writable, can_ |
||
can_ |
char |
Can Vote | filters on the platform, writable, can_ |
||
color |
varchar2 |
Colour | writable, color |
||
default_ |
varchar2 |
Default List Filter | filters on the platform, writable, default_ |
||
default_ |
varchar2 |
Default Top Period | filters on the platform, writable, default_ |
||
default_ |
varchar2 |
Default View | filters on the platform, writable, default_ |
||
description |
varchar2 |
Description | writable, description |
||
description_ |
varchar2 |
Description Excerpt | writable, description_ |
||
description_ |
varchar2 |
Description Text | writable, description_ |
||
draft |
char |
Draft | filters on the platform, writable, ::ancestor. |
||
draft_ |
varchar2 |
Draft Key | filters on the platform, writable, ::ancestor. |
||
draft_ |
int64 |
Draft Sequence | filters on the platform, writable, ::ancestor. |
||
has_ |
char |
Has Children | writable, has_ |
||
id |
int64 |
ID | writable, id |
||
is_ |
char |
Is Uncategorized | filters on the platform, writable, is_ |
||
logo_ |
varchar2 |
Logo URL | writable, logo_ |
||
minimum_ |
int32 |
Minimum Required Tags | filters on the platform, writable, minimum_ |
||
name |
varchar2 |
Name | writable, name |
||
navigate_ |
char |
Navigate to First Post After Read | filters on the platform, writable, navigate_ |
||
notification_ |
varchar2 |
Notification Level | writable, notification_ |
||
num_ |
int32 |
Num Featured Topics | filters on the platform, writable, num_ |
||
permission |
int64 |
Permission | writable, permission |
||
position |
int64 |
Position | writable, position |
||
post_ |
int64 |
#Posts | writable, post_ |
||
read_ |
char |
Read Restricted | writable, read_ |
||
show_ |
char |
Show Subcategory List | filters on the platform, writable, show_ |
||
slug |
varchar2 |
Slug | writable, slug |
||
sort_ |
varchar2 |
Sort Order | filters on the platform, writable, sort_ |
||
subcategory_ |
varchar2 |
Subcategory List Style | filters on the platform, writable, subcategory_ |
||
text_ |
varchar2 |
Text Colour | writable, text_ |
||
topic_ |
int64 |
#Topics | writable, topic_ |
||
topic_ |
varchar2 |
Topic Template | writable, topic_ |
||
topic_ |
varchar2 |
Topic URL | writable, topic_ |
||
topics_ |
int64 |
Topics All Time | writable, topics_ |
||
topics_ |
int64 |
Topics Day | writable, topics_ |
||
topics_ |
int64 |
Topics Month | writable, topics_ |
||
topics_ |
int64 |
Topics Week | writable, topics_ |
||
topics_ |
int64 |
Topics Year | writable, topics_ |
||
uploaded_ |
int32 |
Uploaded Logo Height | filters on the platform, writable, uploaded_ |
||
uploaded_ |
int32 |
Uploaded Logo ID | filters on the platform, writable, uploaded_ |
||
uploaded_ |
varchar2 |
Uploaded Logo URL | filters on the platform, writable, uploaded_ |
||
uploaded_ |
int32 |
Uploaded Logo Width | filters on the platform, writable, uploaded_ |
Referenced By
- Posts
category_id(Candidate) - Posts_Latest_postsActions_summary
category_id(Candidate) - Top_Topic_listTopics
category_id(Candidate) - Top_Topic_listTopicsPosters
category_id(Candidate)
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver:
Changes of This Table, 26.0 to 27.0
Discourse.Categories.Categories: type changes
Type of Discourse.Categories.Categories changes from table to tablefunction.
What to Do
Check statements, views and scripts that use it before the upgrade.
- can break a statement
table→tablefunction- importance 3
-background_url-draft-draft_key-draft_sequence-logo_url~minimum_required_tags(database_data_type:int32→int64)~minimum_required_tags(dotnet_data_type:int32→int64)~notification_level(database_data_type:varchar2→int64)~notification_level(dotnet_data_type:string→int64)~num_featured_topics(database_data_type:int32→int64)~num_featured_topics(dotnet_data_type:int32→int64)+emoji(varchar2)+icon(varchar2)+sort_ascending(varchar2)
8 more changes
Parameter include_subcategories is added to Discourse.Categories.Categories
Optional.
- importance 2
+style_type(varchar2)+subcategory_count(int64)+topic_title_placeholder(varchar2)+uploaded_background(varchar2)+uploaded_background_dark(varchar2)+uploaded_logo(varchar2)+uploaded_logo_dark(varchar2)