移動

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

ジョブの置換

put

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

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

Veridataジョブを置換します。

リクエスト

パス・パラメータ

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

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

• application/json

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

ルート・スキーマ: schema

タイプ: object

ソースの表示

• description: string
• groups: array groups
• profileId: integer
  デフォルト値: 1

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

例:

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

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

タイプ: array

ソースの表示

• 配列: integer
  グループID。

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

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

ジョブが正常に更新されました。

本文()

ルート・スキーマ: 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

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

先頭に戻る