Loket.nl REST API Data Model
PutEmployerNoteByNoteId |
Edit an employer note record__Activity name :__ PutEmployerNoteByNoteId__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding ` / metadata ` to the PUT URL.
Catalog: LoketNlRest
Schema: EmployerNotes
This is a read-only table function. The loket.nl (REST) API may not support changing the data or the Invantive SQL driver for loket.nl (REST) does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the loket.nl (REST) API.
Select loket.nl (REST) API URL: /providers/employers/notes/{noteId}
Insert loket.nl (REST) API URL: /providers/employers/notes/{noteId}
Update loket.nl (REST) API URL: /providers/employers/notes/{noteId}
Delete loket.nl (REST) API URL: /providers/employers/notes/{noteId}
Field Selection Method: NotRequired
Base Path: content
Select loket.nl (REST) API Operation: put /providers/employers/notes/{noteId}
Table Function Parameters
The following parameters can be used to control the behaviour of the table function PutEmployerNoteByNoteId. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
If-Match |
string |
☐ |
|
Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations). |
noteId |
guid |
☑ |
|
The unique identifier of the record |
Table Function Columns
The columns of the table function PutEmployerNoteByNoteId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
accessibleBy_key |
int32 |
|
☐ |
The key for accessible by |
accessibleBy_value |
string(50) |
|
☐ |
Description of the accessible by |
createdBy_formattedName |
string |
|
☐ |
preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> |
createdBy_id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
createdBy_initials |
string(6) |
|
☐ |
The initials of the user |
createdBy_lastName |
string(25) |
|
☐ |
The last name of the user |
createdBy_prefix |
string(10) |
|
☐ |
The prefix of the user |
createdOn |
datetime |
|
☐ |
The date on which the note was created |
id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
lastModifiedBy_formattedName |
string |
|
☐ |
preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> |
lastModifiedBy_id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
lastModifiedBy_initials |
string(6) |
|
☐ |
The initials of the user |
lastModifiedBy_lastName |
string(25) |
|
☐ |
The last name of the user |
lastModifiedBy_prefix |
string(10) |
|
☐ |
The prefix of the user |
lastModifiedOn |
datetime |
|
☐ |
The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation). |
note |
string(4000) |
|
☐ |
The note it self.__Note:__ This is a free text field so users can add htlm/script etc. |
subject |
string(250) |
|
☐ |
subject of the note |
25-05-2022 14:15 Version 22.1.46-BETA+3385
