JobsApi
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| deleteJob | DELETE /system/jobs/{jobGroup}/ | Delete Job |
| executeJob | POST /system/jobs/{jobGroup}/ | Execute Job |
| jobsList | GET /system/jobs | Registered Jobs |
| possibleJobsList | GET /system/jobs/classes | Possible Jobs |
| registerJob | PUT /system/jobs | Register Job |
| updateJob | PATCH /system/jobs/{jobGroup}/ | Update Job |
deleteJob
JsonValue_Boolean deleteJob(jobGroup, jobName)
Delete Job
Delete Job and reload all Job Information
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| jobGroup | String | Group Name of the Job | [default to Default] |
| jobName | String | Name of the Job | [default to null] |
Return type
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
executeJob
JsonValue_Boolean executeJob(jobGroup, jobName)
Execute Job
Execute scheduled Job manually
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| jobGroup | String | Group Name of the Job | [default to Default] |
| jobName | String | Name of the Job | [default to null] |
Return type
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
jobsList
List jobsList()
Registered Jobs
Returns the List of all registered Jobs with full information
Parameters
This endpoint does not need any parameter.
Return type
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
possibleJobsList
List possibleJobsList()
Possible Jobs
Returns the List of possible job classes
Parameters
This endpoint does not need any parameter.
Return type
List
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
registerJob
JobInformation registerJob(JobConfig)
Register Job
Register an Job and return the JobInformation with next schedule information
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| JobConfig | JobConfig |
Return type
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: application/json
- Accept: application/json, text/plain
updateJob
JobInformation updateJob(jobGroup, jobName, JobConfig)
Update Job
Add Job and get JobInformation back
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| jobGroup | String | Group Name of the Job | [default to Default] |
| jobName | String | Name of the Job | [default to null] |
| JobConfig | JobConfig |
Return type
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: application/json
- Accept: application/json, text/plain