Create Job

post

http://{host}:{port}/veridata/v1/services/configuration/jobs

Required Role: Administrator, SuperUser, CommandLineOperator

Create Veridata Jobs.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Example:
{ "name":"job1", "description":"sample job to run", "profileId":1, "groups":[ 1001 ] }
Nested Schema : groups
Type: array
Show Source
Back to Top

Response

Supported Media Types

201 Response

Successfully created Veridata job.
Body ()
Root Schema : CreateJobResponse
Type: object
Show Source
Example:
{ "id":1001, "name":"job1", "profileId":1, "numOfGroups":0, "groups":[ { "name":"group1", "id":1001 } ] }
Nested Schema : groups
Type: array
Show Source
Nested Schema : GroupForJob
Type: object
Show Source

400 Response

Bad Request.
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }

401 Response

Unauthorized.
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }

404 Response

Not Found.
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }

500 Response

Server Error.
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }
Back to Top