Note Categories

Create NoteCategory

Creates a new NoteCategory

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
note_Category
required
string [ 1 .. 8 ] characters

Name of the 'Note Category'.

allow_Note_Alert
required
boolean

Checking this option allows the system to generate alerts for this 'Note Category'. Note: This field is marked as NOT NULL in the database and therefore required by the API.

description
string or null <= 64 characters

Description of the 'Note Category'.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

key_Column
string or null <= 1024 characters

Internal use only. This is a comma separated list of fields used to create the NoteSource record for a new or existing note.

location
string or null <= 50 characters

Identifier of the location for the 'Note Category'.

navigate_Object
string or null <= 128 characters

Internal use only. Holds the navigation object used when navigating through the VBASoftware application.

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

post/note-categories
Request samples
{
  • "note_Category": "string",
  • "allow_Note_Alert": true,
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "key_Column": "string",
  • "location": "string",
  • "navigate_Object": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List NoteCategory

Lists all NoteCategory

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/note-categories
Request samples 
Response samples 
No sample
Get NoteCategory
Gets NoteCategory


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
noteCategory
required
string
Note Category


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/note-categories/{noteCategory}
Request samples 
Response samples 
No sample
Update NoteCategory
Updates a specific NoteCategory.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
noteCategory
required
string
Note Category


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
note_Category
required
string  [ 1 .. 8 ] characters 
Name of the 'Note Category'.


 
allow_Note_Alert
required
boolean
Checking this option allows the system to generate alerts for this 'Note Category'. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
description
string or null  <= 64 characters 
Description of the 'Note Category'.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
key_Column
string or null  <= 1024 characters 
Internal use only.  This is a comma separated list of fields used to create the NoteSource record for a new or existing note.


 
location
string or null  <= 50 characters 
Identifier of the location for the 'Note Category'.


 
navigate_Object
string or null  <= 128 characters 
Internal use only.  Holds the navigation object used when navigating through the VBASoftware application.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
200
Success


401
Unauthorized


put/note-categories/{noteCategory}
Request samples 
{
  • "note_Category": "string",
  • "allow_Note_Alert": true,
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "key_Column": "string",
  • "location": "string",
  • "navigate_Object": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete NoteCategory
Deletes an NoteCategory


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
noteCategory
required
string
Note Category


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/note-categories/{noteCategory}
Request samples 
Create or Update Batch NoteCategory
Create or Update multiple NoteCategory at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
note_Category
required
string  [ 1 .. 8 ] characters 
Name of the 'Note Category'.


 
allow_Note_Alert
required
boolean
Checking this option allows the system to generate alerts for this 'Note Category'. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
description
string or null  <= 64 characters 
Description of the 'Note Category'.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
key_Column
string or null  <= 1024 characters 
Internal use only.  This is a comma separated list of fields used to create the NoteSource record for a new or existing note.


 
location
string or null  <= 50 characters 
Identifier of the location for the 'Note Category'.


 
navigate_Object
string or null  <= 128 characters 
Internal use only.  Holds the navigation object used when navigating through the VBASoftware application.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
207
Success


401
Unauthorized


put/note-categories-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}