NoteModel

A note is a customizable text string that can be attached to various account attributes
within Lockstep. You can use notes for internal communication, correspondence with
clients, or personal reminders. The Note Model represents a note and a number of
different metadata attributes related to the creation, storage, and ownership of the note.

See Extensibility for more information.

Methods

Fields

noteId

uuid, read-only

The unique ID of this record, automatically assigned by Lockstep when this record is
added to the Lockstep platform.

groupKey

uuid, read-only

The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
account will share the same GroupKey value. GroupKey values cannot be changed once created.

For more information, see Accounts and GroupKeys.

tableKey

string, nullable, 0-40 characters

The name of the table the note is associated with

objectKey

uuid

The ID of the object the note is associated with

noteText

string, nullable

The text of the note

noteType

string, nullable, 0-30 characters

The type of the note

isArchived

boolean, read-only

Flag indicating if the note has been archived

created

date-time, nullable, read-only

The date the note was created

createdUserId

uuid, read-only

The ID of the user who created the note

createdUserName

string, nullable, read-only

The name of the user who created the note

appEnrollmentId

uuid, nullable, read-only

AppEnrollmentId for this record; used for mapping purposes.

recipientName

string, nullable, 0-99 characters

The person to whom this note is intended for.


Did this page help you?