Job Executions

Create JobExecution

Creates a new JobExecution

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
jobID
required
string

Job ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
jobExecution_Key
required
integer <int32>

Key value identifying an instance of the execution of the job Note: This field is marked as NOT NULL in the database and therefore required by the API.

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

job_Execute_Date
string or null <date-time>

Date the job was executed

job_Execute_User
string or null <= 20 characters

User that executed this instance of the job

job_ID
required
string [ 1 .. 32 ] characters

Identifier for the specific job that is run

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

vbA_Execute_End
string or null <date-time>

Date and time the instance of execution ended

vbA_Execute_Result
string or null <= 32 characters

Result of the instance of execution

vbA_Execute_Result_Message
string or null

Messages or files that were captured from the instance of execution

vbA_Execute_Start
string or null <date-time>

Date and time the instance of execution started

Responses
200

Success

401

Unauthorized

post/jobs/{jobID}/executions
Request samples
{
  • "jobExecution_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "job_Execute_Date": "2019-08-24T14:15:22Z",
  • "job_Execute_User": "string",
  • "job_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "vbA_Execute_End": "2019-08-24T14:15:22Z",
  • "vbA_Execute_Result": "string",
  • "vbA_Execute_Result_Message": "string",
  • "vbA_Execute_Start": "2019-08-24T14:15:22Z"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List JobExecution

Lists all JobExecution for the given jobID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
jobID
required
string

Job 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/jobs/{jobID}/executions
Request samples 
Response samples 
No sample
Get JobExecution
Gets JobExecution


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
jobID
required
string
Job ID


 
jobExecutionKey
required
integer <int32> 
JobExecution Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/jobs/{jobID}/executions/{jobExecutionKey}
Request samples 
Response samples 
No sample
Update JobExecution
Updates a specific JobExecution.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
jobID
required
string
Job ID


 
jobExecutionKey
required
integer <int32> 
JobExecution Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
jobExecution_Key
required
integer <int32> 
Key value identifying an instance of the execution of the job Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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


 
job_Execute_Date
string or null <date-time> 
Date the job was executed


 
job_Execute_User
string or null  <= 20 characters 
User that executed this instance of the job


 
job_ID
required
string  [ 1 .. 32 ] characters 
Identifier for the specific job that is run


 
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


 
vbA_Execute_End
string or null <date-time> 
Date and time the instance of execution ended


 
vbA_Execute_Result
string or null  <= 32 characters 
Result of the instance of execution


 
vbA_Execute_Result_Message
string or null
Messages or files that were captured from the instance of execution


 
vbA_Execute_Start
string or null <date-time> 
Date and time the instance of execution started


 
Responses 
200
Success


401
Unauthorized


put/jobs/{jobID}/executions/{jobExecutionKey}
Request samples 
{
  • "jobExecution_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "job_Execute_Date": "2019-08-24T14:15:22Z",
  • "job_Execute_User": "string",
  • "job_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "vbA_Execute_End": "2019-08-24T14:15:22Z",
  • "vbA_Execute_Result": "string",
  • "vbA_Execute_Result_Message": "string",
  • "vbA_Execute_Start": "2019-08-24T14:15:22Z"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete JobExecution
Deletes an JobExecution


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
jobID
required
string
Job ID


 
jobExecutionKey
required
integer <int32> 
JobExecution Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/jobs/{jobID}/executions/{jobExecutionKey}
Request samples 
Create or Update Batch JobExecution
Create or Update multiple JobExecution 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
jobID
required
string
Job ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
jobExecution_Key
required
integer <int32> 
Key value identifying an instance of the execution of the job Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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


 
job_Execute_Date
string or null <date-time> 
Date the job was executed


 
job_Execute_User
string or null  <= 20 characters 
User that executed this instance of the job


 
job_ID
required
string  [ 1 .. 32 ] characters 
Identifier for the specific job that is run


 
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


 
vbA_Execute_End
string or null <date-time> 
Date and time the instance of execution ended


 
vbA_Execute_Result
string or null  <= 32 characters 
Result of the instance of execution


 
vbA_Execute_Result_Message
string or null
Messages or files that were captured from the instance of execution


 
vbA_Execute_Start
string or null <date-time> 
Date and time the instance of execution started


 
Responses 
207
Success


401
Unauthorized


put/jobs/{jobID}/executions-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}