Event Args

Create EventArg

Creates a new EventArg

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

Event ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
event_ID
required
integer <int32>

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

argument_Name
required
string [ 1 .. 256 ] characters

Allows the User to choose from a list of existing process automation arguments to associate with the event.

argument_Type
string or null <= 32 characters

Identifies the type of process automation argument.

argument_Value
string or null <= 512 characters

The value of the process automation argument.

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

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/events/{eventID}/args
Request samples
{
  • "event_ID": 0,
  • "argument_Name": "string",
  • "argument_Type": "string",
  • "argument_Value": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List EventArg

Lists all EventArgs for the given EventID

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

Event ID

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/events/{eventID}/args
Request samples 
Response samples 
No sample
Get EventArg
Gets EventArg


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
eventID
required
integer <int32> 
Event ID


 
argumentName
required
string
Argument Name


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/events/{eventID}/args/{argumentName}
Request samples 
Response samples 
No sample
Update EventArg
Updates a specific EventArg.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
eventID
required
integer <int32> 
Event ID


 
argumentName
required
string
Argument Name


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
argument_Name
required
string  [ 1 .. 256 ] characters 
Allows the User to choose from a list of existing process automation arguments to associate with the event.


 
argument_Type
string or null  <= 32 characters 
Identifies the type of process automation argument.


 
argument_Value
string or null  <= 512 characters 
The value of the process automation argument.


 
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


 
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/events/{eventID}/args/{argumentName}
Request samples 
{
  • "event_ID": 0,
  • "argument_Name": "string",
  • "argument_Type": "string",
  • "argument_Value": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete EventArg
Deletes an EventArg


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
eventID
required
integer <int32> 
Event ID


 
argumentName
required
string
Argument Name


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/events/{eventID}/args/{argumentName}
Request samples 
Create or Update Batch EventArg
Create or Update multiple EventArg at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
eventID
required
integer <int32> 
Event ID


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
argument_Name
required
string  [ 1 .. 256 ] characters 
Allows the User to choose from a list of existing process automation arguments to associate with the event.


 
argument_Type
string or null  <= 32 characters 
Identifies the type of process automation argument.


 
argument_Value
string or null  <= 512 characters 
The value of the process automation argument.


 
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


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