Skip to content

Create NoteData

Request

Creates a new NoteData

Security
apiKeyAuth and bearerAuth
Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
note_Keyinteger, (int32)required

Key value used to identify a specific note

effective_Datestring or null, (date-time)

Date the information in the note goes into effect

entry_Datestring, (date-time)

Date record was first added to the system

entry_Userstring or null, <= 20 characters

User that first added the record to the system

note_Alertbooleanrequired

Flag identifying if there is an alert associated with the note

note_Alert_Endstring or null, (date-time)

Date the alert associated with a note terminates

note_Categorystring or null, <= 8 characters

Identifies the 'Category' of note. Note 'Category' are configured within 'Note Configuration'.

note_Datastring or null

Text data of the note.

note_Prioritystring or null, <= 8 characters

Identifies the 'Priority' of note. Note 'Priority' are configured within 'Note Configuration'.

note_Subjectstring or null, <= 64 characters

Description of the note's subject.

note_Typestring or null, <= 8 characters

Identifies the 'Type' of note. Note 'Types' are configured within 'Note Configuration'.

term_Datestring or null, (date-time)

Date the information in the note terminates

update_Datestring, (date-time)

Date the record was last updated in the system

update_Userstring or null, <= 20 characters

User that last updated the record in the system

curl -i -X POST \
  https://vbapi.vbasoftware.com/vbasoftware/note-data \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "note_Key": 0,
    "effective_Date": "2019-08-24T14:15:22Z",
    "entry_Date": "2019-08-24T14:15:22Z",
    "entry_User": "string",
    "note_Alert": true,
    "note_Alert_End": "2019-08-24T14:15:22Z",
    "note_Category": "string",
    "note_Data": "string",
    "note_Priority": "string",
    "note_Subject": "string",
    "note_Type": "string",
    "term_Date": "2019-08-24T14:15:22Z",
    "update_Date": "2019-08-24T14:15:22Z",
    "update_User": "string"
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}