移動

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

グループの取得

get

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

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

すべてのグループを取得します。

リクエスト

問合せパラメータ

• desc: string
  相似するグループの説明。
• name: string
  相似するグループ名。
• srcConn: string
  相似するソース接続名。
• tgtConn: string
  類似ターゲット接続名。

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

先頭に戻る

レスポンス

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

• application/json
• */*

200 レスポンス

グループが正常に返されました。

本文()

ルート・スキーマ: schema

タイプ: array

ソースの表示

• 配列: object ListAllResponseGroup

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

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

タイプ: object

ソースの表示

• sourceConnection: GroupConnection
• targetConnection: GroupConnection

{ "allOf":[ { "$ref":"#/components/schemas/BaseObject" }, { "type":"object" } ], "properties":{ "sourceConnection":{ "$ref":"#/components/schemas/GroupConnection" }, "targetConnection":{ "$ref":"#/components/schemas/GroupConnection" } } }

すべて一致

ソースの表示

• object BaseObject
• object ListAllResponseGroup-allOf[1]

{ "allOf":[ { "$ref":"#/components/schemas/BaseObject" }, { "type":"object" } ], "properties":{ "sourceConnection":{ "$ref":"#/components/schemas/GroupConnection" }, "targetConnection":{ "$ref":"#/components/schemas/GroupConnection" } } }

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

タイプ: object

ソースの表示

• id: integer (int64)
  ソース接続ID。
• name: string

{ "properties":{ "id":{ "type":"integer", "format":"int64", "description":"Source Connection ID." }, "name":{ "type":"string" } } }

ネストされたスキーマ: 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" } } }

ネストされたスキーマ: ListAllResponseGroup-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" }

先頭に戻る