Help Item Notes

The HelpItemNote table contains notes for each individual help item in the Help package. This table is designed to provide additional information or instructions for each help item, such as troubleshooting tips or other relevant details. Each note is linked to its corresponding help item, allowing for easy reference and efficient organization. Additionally, this table allows for multiple notes to be added to a single help item, providing a comprehensive and thorough guide for users. The HelpItemNote table provides a valuable resource for troubleshooting and resolving issues, making it an essential component of the Help package.

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

The HelpItemNoteId is a unique identity field located in the HelpItemNote table, with a data type of int. This field serves as a primary key, providing a distinct identification number for each individual note in the HelpItemNote table. As an identity field, the HelpItemNoteId is automatically incremented with each new entry, ensuring the uniqueness of each note in the table. This allows for efficient organization and retrieval of notes related to various help items within the HelpItemNote table. The HelpItemNoteId is a crucial component of the HelpItemNote table, providing a vital link between notes and their corresponding help items.

int32

The HelpItemId field is an integer data type that belongs to the HelpItemNote table. It is used to identify a specific help item within the table and is typically used as a primary or foreign key. This field serves as a unique identifier for each help item and can be referenced in other tables for data retrieval and organization. The values within this field are automatically assigned by the database system and cannot be modified by users. The HelpItemId plays a crucial role in linking related information and ensuring data accuracy within the HelpItemNote table.

int32

The SystemAccountId field in the HelpItemNote table is an integer data type that stores the unique identification number of the user who created the note. This field is used to track the system account associated with each note, providing important information about the creator of the note for reference and accountability purposes. This field is essential for efficient organization and management of help items and notes within the system.

string | null

The Content field in the HelpItemNote table is a data type of nvarchar, which allows for the storage of variable-length character data. This field serves as a versatile space for storing various types of textual information related to a particular help item. It can contain detailed descriptions, instructions, notes, or any other relevant data that may assist users in understanding and utilizing the help item effectively. The nvarchar data type ensures that the Content field can accommodate multilingual entries, making it suitable for a diverse user base. Overall, the Content field is an essential component in the HelpItemNote table, providing comprehensive and accessible information to users seeking assistance.

Headers
string
enum
Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response
200

OK

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