Jump to

• Request
• Response

Run a Job

post

http://{host}:{port}/veridata/v1/services/execution/jobs/{Id}

Required Role: Administrator, SuperUser, CommandLineOperator, JobOperator, RepairOperator

Run Veridata Job.

Request

Path Parameters

• Id(required): integer(int32)
  ID of the job to be run.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• groups: array groups
• profileId: integer (int32)
  Default Value: 1
• runRepair: boolean
  Default Value: false

{
    "type":"object",
    "properties":{
        "profileId":{
            "type":"integer",
            "format":"int32",
            "default":1
        },
        "runRepair":{
            "type":"boolean",
            "default":false
        },
        "groups":{
            "type":"array",
            "description":"",
            "items":{
                "$ref":"#/components/schemas/RunGroup"
            }
        }
    },
    "example":{
        "profileId":"1,",
        "runRepair":"false,",
        "groups":[
            {
                "groupId":"1001,",
                "comparePairs":[
                    {
                        "comparePairId":"1023,",
                        "srcPartId":"10,",
                        "tgtPartId":10
                    }
                ]
            }
        ]
    }
}

Example:

{
    "profileId":"1,",
    "runRepair":"false,",
    "groups":[
        {
            "groupId":"1001,",
            "comparePairs":[
                {
                    "comparePairId":"1023,",
                    "srcPartId":"10,",
                    "tgtPartId":10
                }
            ]
        }
    ]
}

Nested Schema : groups

Type: array

Show Source

• Array of: object RunGroup

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

Nested Schema : RunGroup

Type: object

Show Source

• comparePairs: array comparePairs
  List of Compare Pair's to be run.
• groupId: integer (int64)

{
    "type":"object",
    "properties":{
        "groupId":{
            "type":"integer",
            "format":"int64"
        },
        "comparePairs":{
            "type":"array",
            "description":"List of Compare Pair's to be run.\n",
            "items":{
                "$ref":"#/components/schemas/RunComparePair"
            }
        }
    }
}

Nested Schema : comparePairs

Type: array

List of Compare Pair's to be run.

Show Source

• Array of: object RunComparePair

{
    "type":"array",
    "description":"List of Compare Pair's to be run.\n",
    "items":{
        "$ref":"#/components/schemas/RunComparePair"
    }
}

Nested Schema : RunComparePair

Type: object

Show Source

• comparePairId: integer (int64)
• deltaRunId: string
  delta run ID Example - 1100,1,1
• srcPartId: integer
• tgtPartId: integer

{
    "type":"object",
    "properties":{
        "comparePairId":{
            "type":"integer",
            "format":"int64"
        },
        "srcPartId":{
            "type":"integer"
        },
        "tgtPartId":{
            "type":"integer"
        },
        "deltaRunId":{
            "type":"string",
            "description":"delta run ID Example - 1100,1,1"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: object

Show Source

• runID: integer
  Job Run ID.

{
    "type":"object",
    "properties":{
        "runID":{
            "type":"integer",
            "description":"Job Run ID."
        }
    }
}

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