移動

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

ジョブの作成

post

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

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

Veridataジョブを作成します。

リクエスト

この操作にはリクエスト・パラメータはありません。

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

• application/json

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

ルート・スキーマ: schema

タイプ: object

ソースの表示

• description: string
• groups(必須): array groups
• name(必須): string
  ジョブ名。
• profileId: integer
  デフォルト値: 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
        ]
    }
}

例:

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

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

タイプ: array

ソースの表示

• 配列: integer
  グループID。

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

先頭に戻る

レスポンス

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

• application/json

201 レスポンス

Veridataジョブが正常に作成されました。

本文()

ルート・スキーマ: CreateJobResponse

タイプ: object

ソースの表示

• groups: array groups
• id: integer
• name: string
• numOfGroups: integer
• profileId: integer
  デフォルト値: 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
            }
        ]
    }
}

例:

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

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

タイプ: array

ソースの表示

• 配列: object GroupForJob

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

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

タイプ: object

ソースの表示

• id: integer
  デフォルト値: 1
• name: string

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

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

先頭に戻る