Help Items

The HelpItem table in the Help package stores information related to various help items that are available for users. It includes columns for item ID, title, description, category, and link. The table allows for easy navigation and access to different help resources, such as tutorials, FAQs, and user manuals. It also provides a search feature, allowing users to quickly find the relevant help item they are looking for. Additionally, the HelpItem table stores the date the item was last updated, ensuring that users have access to the most current and accurate information. This table serves as a centralized location for all help items, making it easier for users to find the assistance they need.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
int32

The HelpItemId is a unique identity field that is assigned to each HelpItem within the HelpItem table. This field is of data type integer and is used to uniquely identify each HelpItem in the table. It serves as a primary key and ensures that no two HelpItems have the same identifier. This field is essential for maintaining the integrity of the data and for efficient retrieval and updating of HelpItems. Any references or relationships to a specific HelpItem will be based on its HelpItemId. Overall, the HelpItemId provides a reliable and structured means of organizing and managing the HelpItem table.

int32

The HelpCategoryId field in the HelpItem table is an integer data type that serves as a unique identifier for the category to which the help item belongs. This field is crucial for organizing and classifying help items, making it easier for users to search and find the information they need. It allows for efficient retrieval of help items related to a specific category, enabling a smoother and more streamlined help experience. This field is essential for maintaining the structure and organization of the help system, ensuring efficient and effective navigation for users.

string | null

Title is a field in the HelpItem table that stores variable length text data in the form of Unicode characters. This field can hold up to 4,000 characters and is typically used to store the title or label of a help item. The nvarchar data type allows for storage of both non-English characters and English characters, making it suitable for a wide range of languages. This field is useful for organizing and categorizing help items in a detailed and precise manner. Additionally, it provides flexibility in terms of the length and content of the title, allowing for descriptive and informative titles for each help item in the table.

string | null

The Content field in the HelpItem table is of data type nvarchar and serves as a storage space for text-based information. This field is typically used to provide detailed explanations, instructions, or notes related to a specific help item within an application or system. It can accommodate a wide range of characters and is designed to handle various languages and special characters. The purpose of this field is to enhance user understanding and provide valuable resources for troubleshooting, problem-solving, or other assistance needs. The Content field is an essential aspect of the HelpItem table, providing comprehensive and easily accessible information for users.

string | null

Miscellaneous notes and information for the entry or record.

string | null

The ItemId field in the HelpItem table is an NVARCHAR data type that uniquely identifies each help item. It is designed to store alphanumeric strings, allowing for a flexible and descriptive representation of the item’s identifier. This field ensures that each help item can be efficiently referenced and retrieved, supporting localization and internationalization by accommodating various character sets. The length of the ItemId can be defined to suit the expected format and variety of identifiers used in the application.

Response
200

OK

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!