Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Ok.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Job

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Job"
    },
    "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
        }
    ]
}

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: object

Show Source

• 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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseObject"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "profileId":{
            "type":"integer",
            "default":1
        },
        "createdOn":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "updatedOn":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "numOfGroups":{
            "type":"integer"
        }
    },
    "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
    }
}

Match All

Show Source

• object BaseObject
• object Job-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseObject"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "profileId":{
            "type":"integer",
            "default":1
        },
        "createdOn":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "updatedOn":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "numOfGroups":{
            "type":"integer"
        }
    },
    "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
    }
}

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: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Object Id.",
            "format":"int64"
        },
        "name":{
            "type":"string",
            "description":"Object Name."
        },
        "description":{
            "type":"string",
            "description":"Object Description."
        },
        "createdOn":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "updatedOn":{
            "type":"string",
            "format":"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.

Body ()

Root Schema : Error

Type: object

Show Source

• errCode: string
  Veridata Error Code.
• errMsg: string
  Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

401 Response

Unauthorized.

Body ()

Root Schema : Error

Type: object

Show Source

• errCode: string
  Veridata Error Code.
• errMsg: string
  Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

404 Response

Not Found.

Body ()

Root Schema : Error

Type: object

Show Source

• errCode: string
  Veridata Error Code.
• errMsg: string
  Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

500 Response

Server Error.

Body ()

Root Schema : Error

Type: object

Show Source

• errCode: string
  Veridata Error Code.
• errMsg: string
  Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

Back to Top