Process Parameters

Create VBAProcessParameter

Creates a new VBAProcessParameter

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

VBAProcess Key

vBAProcessType
required
string

VBAProcess Type

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
vbaProcessParameter_Key
required
integer <int32>

Unique Identifier for the VBAProcessParameter table Note: This field is marked as NOT NULL in the database and therefore required by the API.

end_Date
string or null <date-time>

Date and time the process ended.

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

parameter_Name
required
string [ 1 .. 64 ] characters

Name of the parameter passed.

parameter_Type
required
string [ 1 .. 32 ] characters

Type of the parameter passed.

parameter_Value1
string or null

A value passed to the process.

parameter_Value10
string or null

A value passed to the process.

parameter_Value11
string or null

A value passed to the process.

parameter_Value12
string or null

A value passed to the process.

parameter_Value2
string or null

A value passed to the process.

parameter_Value3
string or null

A value passed to the process.

parameter_Value4
string or null

A value passed to the process.

parameter_Value5
string or null

A value passed to the process.

parameter_Value6
string or null

A value passed to the process.

parameter_Value7
string or null

A value passed to the process.

parameter_Value8
string or null

A value passed to the process.

parameter_Value9
string or null

A value passed to the process.

process_Automation
required
boolean

Flag is set by Process Automation to show it has been processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.

start_Date
string or null <date-time>

Date and time the process started.

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

vbaProcess_Key
required
integer <int32>

Unique Identifier for the VBAProcess table Note: This field is marked as NOT NULL in the database and therefore required by the API.

vbaProcess_Type
required
string [ 1 .. 32 ] characters

Type used to determine the process that triggers.

Responses
200

Success

401

Unauthorized

post/vbaprocesses/{vBAProcessKey}/types/{vBAProcessType}/parameters
Request samples
{
  • "vbaProcessParameter_Key": 0,
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "parameter_Name": "string",
  • "parameter_Type": "string",
  • "parameter_Value1": "string",
  • "parameter_Value10": "string",
  • "parameter_Value11": "string",
  • "parameter_Value12": "string",
  • "parameter_Value2": "string",
  • "parameter_Value3": "string",
  • "parameter_Value4": "string",
  • "parameter_Value5": "string",
  • "parameter_Value6": "string",
  • "parameter_Value7": "string",
  • "parameter_Value8": "string",
  • "parameter_Value9": "string",
  • "process_Automation": true,
  • "start_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "vbaProcess_Key": 0,
  • "vbaProcess_Type": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Get VBAProcessParameter

Gets VBAProcessParameter

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

VBAProcess Key

vBAProcessType
required
string

VBAProcess Type

vBAProcessParameterKey
required
integer <int32>

VBAProcessParameter Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/vbaprocesses/{vBAProcessKey}/types/{vBAProcessType}/parameters/{vBAProcessParameterKey}
Request samples 
Response samples 
No sample
Update VBAProcessParameter
Updates a specific VBAProcessParameter.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
vBAProcessKey
required
integer <int32> 
VBAProcess Key


 
vBAProcessType
required
string
VBAProcess Type


 
vBAProcessParameterKey
required
integer <int32> 
VBAProcessParameter Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
vbaProcessParameter_Key
required
integer <int32> 
Unique Identifier for the VBAProcessParameter table Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
end_Date
string or null <date-time> 
Date and time the process ended.


 
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


 
parameter_Name
required
string  [ 1 .. 64 ] characters 
Name of the parameter passed.


 
parameter_Type
required
string  [ 1 .. 32 ] characters 
Type of the parameter passed.


 
parameter_Value1
string or null
A value passed to the process.


 
parameter_Value10
string or null
A value passed to the process.


 
parameter_Value11
string or null
A value passed to the process.


 
parameter_Value12
string or null
A value passed to the process.


 
parameter_Value2
string or null
A value passed to the process.


 
parameter_Value3
string or null
A value passed to the process.


 
parameter_Value4
string or null
A value passed to the process.


 
parameter_Value5
string or null
A value passed to the process.


 
parameter_Value6
string or null
A value passed to the process.


 
parameter_Value7
string or null
A value passed to the process.


 
parameter_Value8
string or null
A value passed to the process.


 
parameter_Value9
string or null
A value passed to the process.


 
process_Automation
required
boolean
Flag is set by Process Automation to show it has been processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
start_Date
string or null <date-time> 
Date and time the process started.


 
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


 
vbaProcess_Key
required
integer <int32> 
Unique Identifier for the VBAProcess table Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
vbaProcess_Type
required
string  [ 1 .. 32 ] characters 
Type used to determine the process that triggers.


 
Responses 
200
Success


401
Unauthorized


put/vbaprocesses/{vBAProcessKey}/types/{vBAProcessType}/parameters/{vBAProcessParameterKey}
Request samples 
{
  • "vbaProcessParameter_Key": 0,
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "parameter_Name": "string",
  • "parameter_Type": "string",
  • "parameter_Value1": "string",
  • "parameter_Value10": "string",
  • "parameter_Value11": "string",
  • "parameter_Value12": "string",
  • "parameter_Value2": "string",
  • "parameter_Value3": "string",
  • "parameter_Value4": "string",
  • "parameter_Value5": "string",
  • "parameter_Value6": "string",
  • "parameter_Value7": "string",
  • "parameter_Value8": "string",
  • "parameter_Value9": "string",
  • "process_Automation": true,
  • "start_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "vbaProcess_Key": 0,
  • "vbaProcess_Type": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete VBAProcessParameter
Deletes an VBAProcessParameter


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
vBAProcessKey
required
integer <int32> 
VBAProcess Key


 
vBAProcessType
required
string
VBAProcess Type


 
vBAProcessParameterKey
required
integer <int32> 
VBAProcessParameter Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/vbaprocesses/{vBAProcessKey}/types/{vBAProcessType}/parameters/{vBAProcessParameterKey}
Request samples 
Update Batch VBAProcessParameter
Updates a multiple VBAProcessParameter.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
vBAProcessKey
required
integer <int32> 
VBAProcess Key


 
vBAProcessType
required
string
VBAProcess Type


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
vbaProcessParameter_Key
required
integer <int32> 
Unique Identifier for the VBAProcessParameter table Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
end_Date
string or null <date-time> 
Date and time the process ended.


 
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


 
parameter_Name
required
string  [ 1 .. 64 ] characters 
Name of the parameter passed.


 
parameter_Type
required
string  [ 1 .. 32 ] characters 
Type of the parameter passed.


 
parameter_Value1
string or null
A value passed to the process.


 
parameter_Value10
string or null
A value passed to the process.


 
parameter_Value11
string or null
A value passed to the process.


 
parameter_Value12
string or null
A value passed to the process.


 
parameter_Value2
string or null
A value passed to the process.


 
parameter_Value3
string or null
A value passed to the process.


 
parameter_Value4
string or null
A value passed to the process.


 
parameter_Value5
string or null
A value passed to the process.


 
parameter_Value6
string or null
A value passed to the process.


 
parameter_Value7
string or null
A value passed to the process.


 
parameter_Value8
string or null
A value passed to the process.


 
parameter_Value9
string or null
A value passed to the process.


 
process_Automation
required
boolean
Flag is set by Process Automation to show it has been processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
start_Date
string or null <date-time> 
Date and time the process started.


 
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


 
vbaProcess_Key
required
integer <int32> 
Unique Identifier for the VBAProcess table Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
vbaProcess_Type
required
string  [ 1 .. 32 ] characters 
Type used to determine the process that triggers.


 
Responses 
207
Success


401
Unauthorized


put/vbaprocesses/{vBAProcessKey}/types/{vBAProcessType}/parameters-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}