REST API for GoldenGate Veridata

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

application/json

Root Schema : schema

Type: object

Show Source

description: string
groups(required): array groups
name(required): string

Job Name.
profileId: integer

Default Value: 1

{
    "properties":{
        "name":{
            "description":"Job Name.",
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "profileId":{
            "type":"integer",
            "default":1
        },
        "groups":{
            "type":"array",
            "items":{
                "type":"integer",
                "description":"Group ID's."
            }
        }
    },
    "required":[
        "name",
        "groups"
    ],
    "example":{
        "name":"job1",
        "description":"sample job to run",
        "profileId":1,
        "groups":[
            1001
        ]
    }
}

Example:

{
    "name":"job1",
    "description":"sample job to run",
    "profileId":1,
    "groups":[
        1001
    ]
}

Nested Schema : groups

Type: array

Show Source

Array of: integer

Group ID's.

{
    "type":"array",
    "items":{
        "type":"integer",
        "description":"Group ID's."
    }
}

Response

Supported Media Types

application/json

201 Response

Successfully created Veridata job.

Root Schema : CreateJobResponse

Type: object

Show Source

groups: array groups
id: integer
name: string
numOfGroups: integer
profileId: integer

Default Value: 1

{
    "properties":{
        "id":{
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "profileId":{
            "type":"integer",
            "default":1
        },
        "numOfGroups":{
            "type":"integer"
        },
        "groups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/GroupForJob"
            }
        }
    },
    "example":{
        "id":1001,
        "name":"job1",
        "profileId":1,
        "numOfGroups":0,
        "groups":[
            {
                "name":"group1",
                "id":1001
            }
        ]
    }
}

Example:

{
    "id":1001,
    "name":"job1",
    "profileId":1,
    "numOfGroups":0,
    "groups":[
        {
            "name":"group1",
            "id":1001
        }
    ]
}

Nested Schema : groups

Type: array

Show Source

Array of: object GroupForJob

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/GroupForJob"
    }
}

Nested Schema : GroupForJob

Type: object

Show Source

id: integer

Default Value: 1
name: string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "id":{
            "type":"integer",
            "default":1
        }
    }
}

400 Response

Bad Request.

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.

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.

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.

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"
}