Represents categories used to organize sections and articles in the Help Center.

Table-Specific Information

Select

The following queries are processed server-side while other filters are processed client-side within the provider.

SELECT * FROM Categories WHERE Id = '13625378761117'
SELECT * FROM Categories WHERE Locale = 'en-us'
SELECT * FROM Categories WHERE Locale = 'en-us' AND Id = '13625378761117'

Insert

The Name column is required to insert. This operation is allowed for logged-in users with the "Help Center manager" role.

INSERT INTO Categories (Name, Locale) VALUES ('Test CData', 'en-us')

Update

You must specify the Id of the category to update it. You can update category-level metadata (such as Position) but not category translation properties (such as Name or Description). All fields that are not readonly are optional. This operation is allowed for logged-in users with the "Help Center manager" role.

UPDATE Categories SET Position = 2 WHERE Id = '13626563785373'

Delete

You must specify the Id of the category to delete it. This operation is allowed for logged-in users with the "Help Center manager" role.

DELETE FROM Categories WHERE Id = '13626686793885'
DELETE FROM Categories WHERE Id = '13626686793885' AND Locale = 'en-us'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		The Id automatically assigned when the category is created.
Name	String	False		The name of the category.
Description	String	False		The description of the category.
Locale	String	False		The locale where the category is displayed.
CreatedAt	Datetime	True		The date and time when the category was created.
UpdatedAt	Datetime	True		The date and time when the category was last updated.
Url	String	True		The API URL of the category.
HtmlUrl	String	True		The HTML URL of the category in the Help Center.
Outdated	Boolean	True		Indicates whether the category is out of date.
Position	Integer	False		The position of this category relative to other categories.
SourceLocale	String	True		The source (default) locale of the category.