Returns Help Center sections, including category, locale, and sorting details.

Table-Specific Information

Select

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

SELECT * FROM Sections WHERE Id = '13647896255645'
SELECT * FROM Sections WHERE Locale = 'en-us'
SELECT * FROM Sections WHERE Locale = 'en-us' AND Id = '13647896255645'
SELECT * FROM Sections WHERE CategoryId = '13625283663133'
SELECT * FROM Sections WHERE Locale = 'en-us' AND CategoryId = '13625283663133'

Insert

The Name and CategoryId columns are required to insert. All fields that are not readonly are optional. This operation is allowed for logged-in users with the "agent" role.

INSERT INTO Sections (Name, CategoryId) VALUES ('Test CData', '13626588262429')

Update

You must specify the Id of the section to update. This updates the section-level data such as Name, Description, Position, CategoryId, ParentSectionId, and ThemeTemplate. All fields that are not readonly are optional. This operation is allowed for logged-in users with the "Help Center manager" role.

UPDATE Sections SET Name = 'UpdatedName' WHERE Id = '13647896255645'

Delete

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

DELETE FROM Sections WHERE Id = '13647939064221'
DELETE FROM Sections WHERE Id = '13647939064221' AND Locale = 'en-us'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		The Id automatically assigned to the section upon creation.
CategoryId	Long	False	Categories.Id	The Id of the category to which this section belongs.
Name	String	False		The name of the section.
Description	String	False		The description of the section.
Locale	String	False		The locale in which the section is displayed.
ParentSectionId	Long	False		The Id of the section to which this section belongs. Only writable for Guide Enterprise customers.
CreatedAt	Datetime	True		The time at which the section was created.
UpdatedAt	Datetime	True		The time at which the section was last updated.
Url	String	True		The API URL of this section.
HtmlUrl	String	True		The URL of this section in Help Center.
Outdated	Boolean	True		Indicates whether the section is out of date.
Position	Integer	False		The position of this section in the section list. Used when sorting is set to manual. By default the section is added to the end of the list.
SourceLocale	String	True		The source (default) locale of the section.
ThemeTemplate	String	False		The theme template name used to display this section in Help Center.
Sorting	String	False		The type of sorting.