RequestLog

Create RequestLog

Creates a new RequestLog

SecurityapiKeyAuth
Request
path Parameters
Request_Key
required
integer <int32>

Request Key

header Parameters
vbagateway-client-id
required
string

Client ID

vbagateway-client-code
required
string

Client code

vbagateway-user-id
required
string

User ID

vbagateway-database
required
string

Target database

Request Body schema:
required
log_Key
required
integer <int32>

Gets or sets the unique identifier for the log entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.

field_Name
required
string [ 1 .. 128 ] characters

Gets or sets the name of the field that was changed in the request. This field has a maximum length of 128 characters.

log_Date
required
string <date-time>

Gets or sets the date and time when the change was logged. Note: This field is marked as NOT NULL in the database and therefore required by the API.

new_Value
string or null <= 512 characters

Gets or sets the new value of the field after the change. This field has a maximum length of 512 characters.

old_Value
required
string [ 1 .. 512 ] characters

Gets or sets the old value of the field before the change. This field is marked as NOT NULL in the database and therefore required by the API.

request_Key
required
integer <int32>

Gets or sets the unique identifier for the request associated with this log entry. This field is marked as NOT NULL in the database and therefore required by the API.

userId
required
integer <int32>

Gets or sets the unique identifier of the user who made the change. This field is marked as NOT NULL in the database and therefore required by the API.

Responses
200

Success

401

Unauthorized

post/requests/{Request_Key}/logs
Request samples
{
  • "log_Key": 0,
  • "field_Name": "string",
  • "log_Date": "2019-08-24T14:15:22Z",
  • "new_Value": "string",
  • "old_Value": "string",
  • "request_Key": 0,
  • "userId": 0
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List RequestLog

Lists all RequestLog for the given Request_Key

SecurityapiKeyAuth
Request
path Parameters
Request_Key
required
integer <int32>

Request Key

query Parameters
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.

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

header Parameters
vbagateway-client-id
required
string

Client ID

vbagateway-client-code
required
string

Client code

vbagateway-user-id
required
string

User ID

vbagateway-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/requests/{Request_Key}/logs
Request samples 
Response samples 
No sample
Get RequestLog
Gets RequestLog


SecurityapiKeyAuth 
Request 
path Parameters
Request_Key
required
integer <int32> 
Request Key


 
Log_Key
required
integer <int32> 
Log Key


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/requests/{Request_Key}/logs/{Log_Key}
Request samples 
Response samples 
No sample
Update RequestLog
Updates a specific RequestLog.


SecurityapiKeyAuth 
Request 
path Parameters
Request_Key
required
integer <int32> 
Request Key


 
Log_Key
required
integer <int32> 
Log Key


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Request Body schema: 
required
log_Key
required
integer <int32> 
Gets or sets the unique identifier for the log entry.
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
field_Name
required
string  [ 1 .. 128 ] characters 
Gets or sets the name of the field that was changed in the request.
This field has a maximum length of 128 characters.


 
log_Date
required
string <date-time> 
Gets or sets the date and time when the change was logged.
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
new_Value
string or null  <= 512 characters 
Gets or sets the new value of the field after the change.
This field has a maximum length of 512 characters.


 
old_Value
required
string  [ 1 .. 512 ] characters 
Gets or sets the old value of the field before the change.
This field is marked as NOT NULL in the database and therefore required by the API.


 
request_Key
required
integer <int32> 
Gets or sets the unique identifier for the request associated with this log entry.
This field is marked as NOT NULL in the database and therefore required by the API.


 
userId
required
integer <int32> 
Gets or sets the unique identifier of the user who made the change.
This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
200
Success


401
Unauthorized


put/requests/{Request_Key}/logs/{Log_Key}
Request samples 
{
  • "log_Key": 0,
  • "field_Name": "string",
  • "log_Date": "2019-08-24T14:15:22Z",
  • "new_Value": "string",
  • "old_Value": "string",
  • "request_Key": 0,
  • "userId": 0
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete RequestLog
Deletes an RequestLog


SecurityapiKeyAuth 
Request 
path Parameters
Request_Key
required
integer <int32> 
Request Key


 
Log_Key
required
integer <int32> 
Log Key


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/requests/{Request_Key}/logs/{Log_Key}
Request samples 
Create or Update Batch RequestLog
Create or Update multiple RequestLog at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth 
Request 
path Parameters
Request_Key
required
integer <int32> 
Request Key


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Request Body schema: 
required
 Array 
log_Key
required
integer <int32> 
Gets or sets the unique identifier for the log entry.
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
field_Name
required
string  [ 1 .. 128 ] characters 
Gets or sets the name of the field that was changed in the request.
This field has a maximum length of 128 characters.


 
log_Date
required
string <date-time> 
Gets or sets the date and time when the change was logged.
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
new_Value
string or null  <= 512 characters 
Gets or sets the new value of the field after the change.
This field has a maximum length of 512 characters.


 
old_Value
required
string  [ 1 .. 512 ] characters 
Gets or sets the old value of the field before the change.
This field is marked as NOT NULL in the database and therefore required by the API.


 
request_Key
required
integer <int32> 
Gets or sets the unique identifier for the request associated with this log entry.
This field is marked as NOT NULL in the database and therefore required by the API.


 
userId
required
integer <int32> 
Gets or sets the unique identifier of the user who made the change.
This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
207
Success


401
Unauthorized


put/requests/{Request_Key}/logs-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}