Note References

Create NoteReference

Creates a new NoteReference

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reference_Key
required
integer <int32>

ID of the note reference. Note: This field is marked as NOT NULL in the database and therefore required by the API.

column_Name1
required
string [ 1 .. 128 ] characters

Defines the subject of 'Key_Value1'.

column_Name2
string or null <= 128 characters

Defines the subject of 'Key_Value2'.

column_Name3
string or null <= 128 characters

Defines the subject of 'Key_Value3'.

column_Name4
string or null <= 128 characters

Defines the subject of 'Key_Value4'.

column_Name5
string or null <= 128 characters

Defines the subject of 'Key_Value5'.

column_Type1
string or null <= 32 characters

Identifies the type of data of the value specified by 'Key_Value1'.

column_Type2
string or null <= 32 characters

Identifies the type of data of the value specified by 'Key_Value2'.

column_Type3
string or null <= 32 characters

Identifies the type of data of the value specified by 'Key_Value3'.

column_Type4
string or null <= 32 characters

Identifies the type of data of the value specified by 'Key_Value4'.

column_Type5
string or null <= 32 characters

Identifies the type of data of the value specified by 'Key_Value5'.

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_Value1
required
string [ 1 .. 128 ] characters

Value of the subject specified by 'Column_Name1'.

key_Value2
string or null <= 128 characters

Value of the subject specified by 'Column_Name2'.

key_Value3
string or null <= 128 characters

Value of the subject specified by 'Column_Name3'.

key_Value4
string or null <= 128 characters

Value of the subject specified by 'Column_Name4'.

key_Value5
string or null <= 128 characters

Value of the subject specified by 'Column_Name5'.

navigate_Object
string or null <= 128 characters

PowerBuilder object connected to the note that is used for navigation

note_Key
required
integer <int32>

ID of the associated note. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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-references
Request samples
{
  • "reference_Key": 0,
  • "column_Name1": "string",
  • "column_Name2": "string",
  • "column_Name3": "string",
  • "column_Name4": "string",
  • "column_Name5": "string",
  • "column_Type1": "string",
  • "column_Type2": "string",
  • "column_Type3": "string",
  • "column_Type4": "string",
  • "column_Type5": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "key_Value1": "string",
  • "key_Value2": "string",
  • "key_Value3": "string",
  • "key_Value4": "string",
  • "key_Value5": "string",
  • "navigate_Object": "string",
  • "note_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List NoteReference

Lists all NoteReference for the given noteKey

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
noteKey
required
integer <int32>

Note Key

query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/note-data/{noteKey}/note-references
Request samples 
Response samples 
No sample
Get NoteReference
Gets NoteReference


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
referenceKey
required
integer <int32> 
Reference Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/note-references/{referenceKey}
Request samples 
Response samples 
No sample
Update NoteReference
Updates a specific NoteReference.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
referenceKey
required
integer <int32> 
Reference Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
reference_Key
required
integer <int32> 
ID of the note reference. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
column_Name1
required
string  [ 1 .. 128 ] characters 
Defines the subject of 'Key_Value1'.


 
column_Name2
string or null  <= 128 characters 
Defines the subject of 'Key_Value2'.


 
column_Name3
string or null  <= 128 characters 
Defines the subject of 'Key_Value3'.


 
column_Name4
string or null  <= 128 characters 
Defines the subject of 'Key_Value4'.


 
column_Name5
string or null  <= 128 characters 
Defines the subject of 'Key_Value5'.


 
column_Type1
string or null  <= 32 characters 
Identifies the type of data of the value specified by 'Key_Value1'.


 
column_Type2
string or null  <= 32 characters 
Identifies the type of data of the value specified by 'Key_Value2'.


 
column_Type3
string or null  <= 32 characters 
Identifies the type of data of the value specified by 'Key_Value3'.


 
column_Type4
string or null  <= 32 characters 
Identifies the type of data of the value specified by 'Key_Value4'.


 
column_Type5
string or null  <= 32 characters 
Identifies the type of data of the value specified by 'Key_Value5'.


 
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_Value1
required
string  [ 1 .. 128 ] characters 
Value of the subject specified by 'Column_Name1'.


 
key_Value2
string or null  <= 128 characters 
Value of the subject specified by 'Column_Name2'.


 
key_Value3
string or null  <= 128 characters 
Value of the subject specified by 'Column_Name3'.


 
key_Value4
string or null  <= 128 characters 
Value of the subject specified by 'Column_Name4'.


 
key_Value5
string or null  <= 128 characters 
Value of the subject specified by 'Column_Name5'.


 
navigate_Object
string or null  <= 128 characters 
PowerBuilder object connected to the note that is used for navigation


 
note_Key
required
integer <int32> 
ID of the associated note. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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-references/{referenceKey}
Request samples 
{
  • "reference_Key": 0,
  • "column_Name1": "string",
  • "column_Name2": "string",
  • "column_Name3": "string",
  • "column_Name4": "string",
  • "column_Name5": "string",
  • "column_Type1": "string",
  • "column_Type2": "string",
  • "column_Type3": "string",
  • "column_Type4": "string",
  • "column_Type5": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "key_Value1": "string",
  • "key_Value2": "string",
  • "key_Value3": "string",
  • "key_Value4": "string",
  • "key_Value5": "string",
  • "navigate_Object": "string",
  • "note_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete NoteReference
Deletes an NoteReference


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
referenceKey
required
integer <int32> 
Reference Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/note-references/{referenceKey}
Request samples 
Create or Update Batch NoteReference
Create or Update multiple NoteReference 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 
reference_Key
required
integer <int32> 
ID of the note reference. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
column_Name1
required
string  [ 1 .. 128 ] characters 
Defines the subject of 'Key_Value1'.


 
column_Name2
string or null  <= 128 characters 
Defines the subject of 'Key_Value2'.


 
column_Name3
string or null  <= 128 characters 
Defines the subject of 'Key_Value3'.


 
column_Name4
string or null  <= 128 characters 
Defines the subject of 'Key_Value4'.


 
column_Name5
string or null  <= 128 characters 
Defines the subject of 'Key_Value5'.


 
column_Type1
string or null  <= 32 characters 
Identifies the type of data of the value specified by 'Key_Value1'.


 
column_Type2
string or null  <= 32 characters 
Identifies the type of data of the value specified by 'Key_Value2'.


 
column_Type3
string or null  <= 32 characters 
Identifies the type of data of the value specified by 'Key_Value3'.


 
column_Type4
string or null  <= 32 characters 
Identifies the type of data of the value specified by 'Key_Value4'.


 
column_Type5
string or null  <= 32 characters 
Identifies the type of data of the value specified by 'Key_Value5'.


 
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_Value1
required
string  [ 1 .. 128 ] characters 
Value of the subject specified by 'Column_Name1'.


 
key_Value2
string or null  <= 128 characters 
Value of the subject specified by 'Column_Name2'.


 
key_Value3
string or null  <= 128 characters 
Value of the subject specified by 'Column_Name3'.


 
key_Value4
string or null  <= 128 characters 
Value of the subject specified by 'Column_Name4'.


 
key_Value5
string or null  <= 128 characters 
Value of the subject specified by 'Column_Name5'.


 
navigate_Object
string or null  <= 128 characters 
PowerBuilder object connected to the note that is used for navigation


 
note_Key
required
integer <int32> 
ID of the associated note. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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-references-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}