Skip to content

Update NoteSource

Request

Updates a specific NoteSource.

Security
apiKeyAuth and bearerAuth
Path
sourceKeyinteger, (int32)required

Source Key

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
source_Keyinteger, (int32)required

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

column_Name1string, [ 1 .. 128 ] charactersrequired

Defines the subject of 'Key_Value1'.

column_Name2string or null, <= 128 characters

Defines the subject of 'Key_Value2'.

column_Name3string or null, <= 128 characters

Defines the subject of 'Key_Value3'.

column_Name4string or null, <= 128 characters

Defines the subject of 'Key_Value4'.

column_Name5string or null, <= 128 characters

Defines the subject of 'Key_Value5'.

column_Type1string or null, <= 32 characters

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

column_Type2string or null, <= 32 characters

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

column_Type3string or null, <= 32 characters

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

column_Type4string or null, <= 32 characters

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

column_Type5string or null, <= 32 characters

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

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

key_Value1string, [ 1 .. 128 ] charactersrequired

Value of the subject specified by 'Column_Name1'.

key_Value2string or null, <= 128 characters

Value of the subject specified by 'Column_Name2'.

key_Value3string or null, <= 128 characters

Value of the subject specified by 'Column_Name3'.

key_Value4string or null, <= 128 characters

Value of the subject specified by 'Column_Name4'.

key_Value5string or null, <= 128 characters

Value of the subject specified by 'Column_Name5'.

navigate_Objectstring or null, <= 128 characters

PowerBuilder object connected to the note that is used for navigation

note_Keyinteger, (int32)required

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

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 PUT \
  'https://vbapi.vbasoftware.com/vbasoftware/note-sources/{sourceKey}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "source_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"
  }'

Responses

Success

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