Used to represent a high-level Note for an Employer.
| Name / Description | Type / Format | Example | |
|---|---|---|---|
title
The plain-text title of the Employer Note. Maximum 100 characters.
|
string
|
"string"
|
|
noteText
The plain-text content of the Employer Note. Maximum 2000 characters.
|
string
|
"string"
|
|
createdBy
The email address of the user that created the Note.
|
string
|
"string"
|
|
updatedBy
The email address of the user that last updated the Note.
|
string
|
"string"
|
|
documentCount
The number of attachments associated with this Note.
|
integer
int32
|
0
|
|
documents
The attachments associated with this Note.
|
Item[]
|
{Item}
|
|
id
The unique id of the object
|
string
uuid
|
"string"
|
{
"title": "string",
"noteText": "string",
"createdBy": "string",
"updatedBy": "string",
"documentCount": 0,
"documents": [
{
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
}
],
"id": "string"
}- none -