Jobs

Create Job

Creates a new Job

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
job_ID
required
string [ 1 .. 32 ] characters

Identifier for the specific job that will be run

criteria_Object
string or null <= 128 characters

Criteria object used with the job to supply the paramters when it is run

description
string or null <= 512 characters

Description for the job that will be run

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_Type
string or null <= 32 characters

Identifier for the type of job

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
Request samples
{
  • "job_ID": "string",
  • "criteria_Object": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "job_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Job

Lists all Job

SecurityapiKeyAuth and bearerAuth
Request
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
Request samples 
Response samples 
No sample
Get Job
Gets Job


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
jobID
required
string
Job ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


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


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
jobID
required
string
Job ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
job_ID
required
string  [ 1 .. 32 ] characters 
Identifier for the specific job that will be run


 
criteria_Object
string or null  <= 128 characters 
Criteria object used with the job to supply the paramters when it is run


 
description
string or null  <= 512 characters 
Description for the job that will be run


 
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_Type
string or null  <= 32 characters 
Identifier for the type of job


 
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}
Request samples 
{
  • "job_ID": "string",
  • "criteria_Object": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "job_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Job
Deletes an Job


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
jobID
required
string
Job ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/jobs/{jobID}
Request samples 
Create or Update Batch Job
Create or Update multiple Job at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
job_ID
required
string  [ 1 .. 32 ] characters 
Identifier for the specific job that will be run


 
criteria_Object
string or null  <= 128 characters 
Criteria object used with the job to supply the paramters when it is run


 
description
string or null  <= 512 characters 
Description for the job that will be run


 
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_Type
string or null  <= 32 characters 
Identifier for the type of job


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