移動

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

ジョブ詳細の取得

get

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

必要なロール: Administrator、SuperUser、DetailMonitoringOperator、MonitoringOperator、CommandLineOperator

ジョブIDでVeridataジョブの詳細を取得します。

リクエスト

パス・パラメータ

• Id(必須): integer(int64)
  VeridataジョブID。

問合せパラメータ

• detail: boolean
  ブール値。trueに設定すると、そのジョブの比較ペアの詳細がフェッチされます。

  デフォルト値: false

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

Veridataジョブの詳細が正常に取得されました。

本文()

ルート・スキーマ: GetJobById

タイプ: object

ソースの表示

• groups: array groups

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Job"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "groups":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "type":"integer",
                        "description":"group ID."
                    },
                    "name":{
                        "type":"string",
                        "description":"group name."
                    },
                    "comparePairs":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "id":{
                                    "type":"integer",
                                    "description":"Compare pair ID."
                                },
                                "name":{
                                    "type":"string",
                                    "description":"Compare pair name."
                                },
                                "columnsSystemMapped":{
                                    "type":"boolean"
                                },
                                "deltaProcessingEnabled":{
                                    "type":"boolean"
                                },
                                "enabled":{
                                    "type":"boolean",
                                    "description":"Indicates whether the Compare Pair is mapped to the group or not."
                                },
                                "keyColumnsSystemMapped":{
                                    "type":"boolean"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "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,
        "groups":[
            {
                "id":1001,
                "name":"group1",
                "comparePairs":[
                    {
                        "id":1001,
                        "name":"compare-pair1",
                        "columnsSystemMapped":true,
                        "deltaProcessingEnabled":true,
                        "enabled":true,
                        "keyColumnsSystemMapped":true
                    }
                ]
            }
        ]
    }
}

すべて一致

ソースの表示

• object allOf Job
• object GetJobById-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Job"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "groups":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "type":"integer",
                        "description":"group ID."
                    },
                    "name":{
                        "type":"string",
                        "description":"group name."
                    },
                    "comparePairs":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "id":{
                                    "type":"integer",
                                    "description":"Compare pair ID."
                                },
                                "name":{
                                    "type":"string",
                                    "description":"Compare pair name."
                                },
                                "columnsSystemMapped":{
                                    "type":"boolean"
                                },
                                "deltaProcessingEnabled":{
                                    "type":"boolean"
                                },
                                "enabled":{
                                    "type":"boolean",
                                    "description":"Indicates whether the Compare Pair is mapped to the group or not."
                                },
                                "keyColumnsSystemMapped":{
                                    "type":"boolean"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "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,
        "groups":[
            {
                "id":1001,
                "name":"group1",
                "comparePairs":[
                    {
                        "id":1001,
                        "name":"compare-pair1",
                        "columnsSystemMapped":true,
                        "deltaProcessingEnabled":true,
                        "enabled":true,
                        "keyColumnsSystemMapped":true
                    }
                ]
            }
        ]
    }
}

例:

{
    "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,
    "groups":[
        {
            "id":1001,
            "name":"group1",
            "comparePairs":[
                {
                    "id":1001,
                    "name":"compare-pair1",
                    "columnsSystemMapped":true,
                    "deltaProcessingEnabled":true,
                    "enabled":true,
                    "keyColumnsSystemMapped":true
                }
            ]
        }
    ]
}

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

タイプ: array

ソースの表示

• 配列: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "type":"integer",
                "description":"group ID."
            },
            "name":{
                "type":"string",
                "description":"group name."
            },
            "comparePairs":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "id":{
                            "type":"integer",
                            "description":"Compare pair ID."
                        },
                        "name":{
                            "type":"string",
                            "description":"Compare pair name."
                        },
                        "columnsSystemMapped":{
                            "type":"boolean"
                        },
                        "deltaProcessingEnabled":{
                            "type":"boolean"
                        },
                        "enabled":{
                            "type":"boolean",
                            "description":"Indicates whether the Compare Pair is mapped to the group or not."
                        },
                        "keyColumnsSystemMapped":{
                            "type":"boolean"
                        }
                    }
                }
            }
        }
    }
}

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

タイプ: object

ソースの表示

• createdOn: string (date-time)
  パターン: YYYY-MM-DDTHH:mm:ss.sssZ

  例: 2024-02-03T10:15:30Z
• numOfGroups: integer
• profileId: integer
  デフォルト値: 1
• updatedOn: string (date-time)
  パターン: YYYY-MM-DDTHH:mm:ss.sssZ

  例: 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
    }
}

すべて一致

ソースの表示

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

例:

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

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

タイプ: object

ソースの表示

• createdOn: string (date-time)
  パターン: YYYY-MM-DDTHH:mm:ss.sssZ

  例: 2024-02-03T10:15:30Z
• description: string
  オブジェクトの説明。
• id: integer (int64)
  オブジェクトID。
• name: string
  オブジェクト名。
• updatedOn: string (date-time)
  パターン: YYYY-MM-DDTHH:mm:ss.sssZ

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

ネストされたスキーマ: Job-allOf[1]

タイプ: object

ネストされたスキーマ: GetJobById-allOf[1]

タイプ: object

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

タイプ: object

ソースの表示

• comparePairs: array comparePairs
• id: integer
  グループID。
• name: string
  グループ名。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"group ID."
        },
        "name":{
            "type":"string",
            "description":"group name."
        },
        "comparePairs":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "type":"integer",
                        "description":"Compare pair ID."
                    },
                    "name":{
                        "type":"string",
                        "description":"Compare pair name."
                    },
                    "columnsSystemMapped":{
                        "type":"boolean"
                    },
                    "deltaProcessingEnabled":{
                        "type":"boolean"
                    },
                    "enabled":{
                        "type":"boolean",
                        "description":"Indicates whether the Compare Pair is mapped to the group or not."
                    },
                    "keyColumnsSystemMapped":{
                        "type":"boolean"
                    }
                }
            }
        }
    }
}

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

タイプ: array

ソースの表示

• 配列: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "type":"integer",
                "description":"Compare pair ID."
            },
            "name":{
                "type":"string",
                "description":"Compare pair name."
            },
            "columnsSystemMapped":{
                "type":"boolean"
            },
            "deltaProcessingEnabled":{
                "type":"boolean"
            },
            "enabled":{
                "type":"boolean",
                "description":"Indicates whether the Compare Pair is mapped to the group or not."
            },
            "keyColumnsSystemMapped":{
                "type":"boolean"
            }
        }
    }
}

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

タイプ: object

ソースの表示

• columnsSystemMapped: boolean
• deltaProcessingEnabled: boolean
• enabled: boolean
  比較ペアがグループにマッピングされているかどうかを示します。
• id: integer
  比較ペアID。
• keyColumnsSystemMapped: boolean
• name: string
  比較ペア名。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Compare pair ID."
        },
        "name":{
            "type":"string",
            "description":"Compare pair name."
        },
        "columnsSystemMapped":{
            "type":"boolean"
        },
        "deltaProcessingEnabled":{
            "type":"boolean"
        },
        "enabled":{
            "type":"boolean",
            "description":"Indicates whether the Compare Pair is mapped to the group or not."
        },
        "keyColumnsSystemMapped":{
            "type":"boolean"
        }
    }
}

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

先頭に戻る