移動

• リクエスト
• レスポンス

ジョブの実行

post

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

必要なロール: Administrator、SuperUser、CommandLineOperator、JobOperator、RepairOperator

Veridataジョブを実行します。

リクエスト

パス・パラメータ

• Id(必須): integer(int32)
  実行するジョブのID。

サポートされるメディア・タイプ

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

タイプ: object

ソースの表示

• groups: array groups
• profileId: integer (int32)
  デフォルト値: 1
• runRepair: boolean
  デフォルト値: 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
                    }
                ]
            }
        ]
    }
}

例:

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

ネストされたスキーマ: groups

タイプ: array

ソースの表示

• 配列: object RunGroup

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

ネストされたスキーマ: RunGroup

タイプ: object

ソースの表示

• comparePairs: array comparePairs
  実行する比較ペアのリスト。
• 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"
            }
        }
    }
}

ネストされたスキーマ: comparePairs

タイプ: array

実行する比較ペアのリスト。

ソースの表示

• 配列: object RunComparePair

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

ネストされたスキーマ: RunComparePair

タイプ: object

ソースの表示

• comparePairId: integer (int64)
• deltaRunId: string
  デルタ実行IDの例 - 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"
        }
    }
}

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200 レスポンス

操作が成功しました。

本文()

ルート・スキーマ: schema

タイプ: object

ソースの表示

• runID: integer
  ジョブ実行ID。

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

400 レスポンス

不正なリクエスト。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

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

例:

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

401 レスポンス

権限がありません。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

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

例:

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

404 レスポンス

見つかりません。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

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

例:

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

500 レスポンス

サーバー・エラー。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

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

例:

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

先頭に戻る