Jobs

Operations for jobs

Start the job with the given name and group name. The job will only be started, if it is not already running.

post

Required Roles: ApiJobs

Authorizations

basicAuthoAuth2

AuthorizationstringRequired

Query parameters

jobGroupstringRequired

jobNamestringRequired

Responses

200

OK

application/json

errorMessagestringOptional

The error message describing why the job could not be completed.

jobGroupstringOptional

The group of the triggered job.

jobNamestringOptional

The name of the triggered job.

statusstring · enumRequired

Results of the attempt to trigger the job.

Possible values:

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

post

/rest/v5/jobs/startJob

HTTPcURLJavaScriptPython

POST /fact-finder/rest/v5/jobs/startJob?jobGroup=text&jobName=text HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Accept: */*

[
  {
    "errorMessage": "text",
    "jobGroup": "text",
    "jobName": "text",
    "status": "SUCCESS"
  }
]

Start the jobs with the given group name. A job will only be started, if it is not already running.

post

Required Roles: ApiJobs

Authorizations

basicAuthoAuth2

AuthorizationstringRequired

Query parameters

jobGroupstringRequired

Responses

200

OK

application/json

errorMessagestringOptional

The error message describing why the job could not be completed.

jobGroupstringOptional

The group of the triggered job.

jobNamestringOptional

The name of the triggered job.

statusstring · enumRequired

Results of the attempt to trigger the job.

Possible values:

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

post

/rest/v5/jobs/startJobsWithGroupName

HTTPcURLJavaScriptPython

POST /fact-finder/rest/v5/jobs/startJobsWithGroupName?jobGroup=text HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Accept: */*

[
  {
    "errorMessage": "text",
    "jobGroup": "text",
    "jobName": "text",
    "status": "SUCCESS"
  }
]

Start the jobs with the given name. A job will only be started, if it is not already running.

post

Required Roles: ApiJobs

Authorizations

basicAuthoAuth2

AuthorizationstringRequired

Query parameters

jobNamestringRequired

Responses

200

OK

application/json

errorMessagestringOptional

The error message describing why the job could not be completed.

jobGroupstringOptional

The group of the triggered job.

jobNamestringOptional

The name of the triggered job.

statusstring · enumRequired

Results of the attempt to trigger the job.

Possible values:

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

post

/rest/v5/jobs/startJobsWithName

HTTPcURLJavaScriptPython

POST /fact-finder/rest/v5/jobs/startJobsWithName?jobName=text HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Accept: */*

[
  {
    "errorMessage": "text",
    "jobGroup": "text",
    "jobName": "text",
    "status": "SUCCESS"
  }
]