Job Execution Metadata

Create JobExecutionMetaData

Creates a new JobExecutionMetaData

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.

jobExecution_Attribute
required
string [ 1 .. 64 ] characters

Attribute or parameter used by the job during execution

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

jobExecution_Attribute_Value
string or null

Value of the attribute or parameter used by the job during execution

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/jobs/{jobID}/executions/{jobExecutionKey}/metadata
Request samples
{
  • "jobExecution_Key": 0,
  • "jobExecution_Attribute": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "jobExecution_Attribute_Value": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List JobExecutionMetaData

Lists all JobExecutionMetaData for the given jobExecutionKey

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
jobID
required
string

Job ID

jobExecutionKey
required
integer <int32>

JobExecution Key

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/{jobExecutionKey}/metadata
Request samples 
Response samples 
No sample
Get JobExecutionMetaData
Gets JobExecutionMetaData


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
jobID
required
string
Job ID


 
jobExecutionKey
required
integer <int32> 
JobExecution Key


 
jobExecutionAttribute
required
string
JobExecution Attribute


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


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


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
jobID
required
string
Job ID


 
jobExecutionKey
required
integer <int32> 
JobExecution Key


 
jobExecutionAttribute
required
string
JobExecution Attribute


 
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.


 
jobExecution_Attribute
required
string  [ 1 .. 64 ] characters 
Attribute or parameter used by the job during execution


 
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


 
jobExecution_Attribute_Value
string or null
Value of the attribute or parameter used by the job during execution


 
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/jobs/{jobID}/executions/{jobExecutionKey}/metadata/{jobExecutionAttribute}
Request samples 
{
  • "jobExecution_Key": 0,
  • "jobExecution_Attribute": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "jobExecution_Attribute_Value": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete JobExecutionMetaData
Deletes an JobExecutionMetaData


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
jobID
required
string
Job ID


 
jobExecutionKey
required
integer <int32> 
JobExecution Key


 
jobExecutionAttribute
required
string
JobExecution Attribute


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/jobs/{jobID}/executions/{jobExecutionKey}/metadata/{jobExecutionAttribute}
Request samples 
Create or Update Batch JobExecutionMetaData
Create or Update multiple JobExecutionMetaData 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


 
jobExecutionKey
required
integer <int32> 
JobExecution Key


 
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.


 
jobExecution_Attribute
required
string  [ 1 .. 64 ] characters 
Attribute or parameter used by the job during execution


 
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


 
jobExecution_Attribute_Value
string or null
Value of the attribute or parameter used by the job during execution


 
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/jobs/{jobID}/executions/{jobExecutionKey}/metadata-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}