Retrieve Jobs
get
http://{host}:{port}/veridata/v1/services/configuration/jobs
Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Returns Veridata Jobs.
Request
Query Parameters
- desc: string The Job description.
- name: string Job name.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Ok.
Root Schema : schema
Type:
Show Source array
Example:
[ { "id":1001, "name":"job1", "description":"sample job to run", "createdOn":"2024-02-03T10:15:30Z", "updatedOn":"2024-02-03T10:15:30Z", "profileId":1, "numOfGroups":1 } ]
Nested Schema : Job
Type:
Show Source object
- createdOn: string (date-time) Pattern:
YYYY-MM-DDTHH:mm:ss.sssZ
Example:2024-02-03T10:15:30Z
- numOfGroups: integer
- profileId: integer Default Value:
1
- updatedOn: string (date-time) Pattern:
YYYY-MM-DDTHH:mm:ss.sssZ
Example:2024-02-03T10:15:30Z
Match All
Show Source Example:
{ "id":1001, "name":"job1", "description":"sample job to run", "createdOn":"2024-02-03T10:15:30Z", "updatedOn":"2024-02-03T10:15:30Z", "profileId":1, "numOfGroups":1 }
Nested Schema : BaseObject
Type:
Show Source object
- createdOn: string (date-time) Pattern:
YYYY-MM-DDTHH:mm:ss.sssZ
Example:2024-02-03T10:15:30Z
- description: string Object Description.
- id: integer (int64) Object Id.
- name: string Object Name.
- updatedOn: string (date-time) Pattern:
YYYY-MM-DDTHH:mm:ss.sssZ
Example:2024-02-03T10:15:30Z
Nested Schema : Job-allOf[1]
Type:
object
400 Response
Bad Request.
Root Schema : Error
Type:
Show Source object
- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }
401 Response
Unauthorized.
Root Schema : Error
Type:
Show Source object
- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }
404 Response
Not Found.
Root Schema : Error
Type:
Show Source object
- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }
500 Response
Server Error.
Root Schema : Error
Type:
Show Source object
- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }