invantive documentation
Invantive Support ForumsLog In / Sign Up

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_url varchar2 Background URL writable, background_url
can_create_category char Can Create Category filters on the platform, writable, ::ancestor.can_create_category
can_create_topic char Can Create Topic filters on the platform, writable, ::ancestor.can_create_topic
can_edit char Can Edit writable, can_edit
can_vote char Can Vote filters on the platform, writable, can_vote
color varchar2 Colour writable, color
default_list_filter varchar2 Default List Filter filters on the platform, writable, default_list_filter
default_top_period varchar2 Default Top Period filters on the platform, writable, default_top_period
default_view varchar2 Default View filters on the platform, writable, default_view
description varchar2 Description writable, description
description_excerpt varchar2 Description Excerpt writable, description_excerpt
description_text varchar2 Description Text writable, description_text
draft char Draft filters on the platform, writable, ::ancestor.draft
draft_key varchar2 Draft Key filters on the platform, writable, ::ancestor.draft_key
draft_sequence int64 Draft Sequence filters on the platform, writable, ::ancestor.draft_sequence
has_children char Has Children writable, has_children
id int64 ID writable, id
is_uncategorized char Is Uncategorized filters on the platform, writable, is_uncategorized
logo_url varchar2 Logo URL writable, logo_url
minimum_required_tags int32 Minimum Required Tags filters on the platform, writable, minimum_required_tags
name varchar2 Name writable, name
navigate_to_first_post_after_read char Navigate to First Post After Read filters on the platform, writable, navigate_to_first_post_after_read
notification_level varchar2 Notification Level writable, notification_level
num_featured_topics int32 Num Featured Topics filters on the platform, writable, num_featured_topics
permission int64 Permission writable, permission
position int64 Position writable, position
post_count int64 #Posts writable, post_count
read_restricted char Read Restricted writable, read_restricted
show_subcategory_list char Show Subcategory List filters on the platform, writable, show_subcategory_list
slug varchar2 Slug writable, slug
sort_order varchar2 Sort Order filters on the platform, writable, sort_order
subcategory_list_style varchar2 Subcategory List Style filters on the platform, writable, subcategory_list_style
text_color varchar2 Text Colour writable, text_color
topic_count int64 #Topics writable, topic_count
topic_template varchar2 Topic Template writable, topic_template
topic_url varchar2 Topic URL writable, topic_url
topics_all_time int64 Topics All Time writable, topics_all_time
topics_day int64 Topics Day writable, topics_day
topics_month int64 Topics Month writable, topics_month
topics_week int64 Topics Week writable, topics_week
topics_year int64 Topics Year writable, topics_year
uploaded_logo_height int32 Uploaded Logo Height filters on the platform, writable, uploaded_logo.height
uploaded_logo_id int32 Uploaded Logo ID filters on the platform, writable, uploaded_logo.id
uploaded_logo_url varchar2 Uploaded Logo URL filters on the platform, writable, uploaded_logo.url
uploaded_logo_width int32 Uploaded Logo Width filters on the platform, writable, uploaded_logo.width

Referenced By

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)

All changes of the driver, 26.0 to 27.0