移動

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

ユーザーのお気に入りの取得

get

http://{host}:{port}/veridata/v1/services/preferences/favorites

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

Veridataユーザーのお気に入りの取得

リクエスト

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

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

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

ユーザーのお気に入りが正常にフェッチされました。

本文()

ルート・スキーマ: ListUserFavorites

タイプ: object

ソースの表示

• connections: array connections
• jobs: array jobs
• monitorJobs: array monitorJobs

{ "type":"object", "properties":{ "jobs":{ "type":"array", "items":{ "$ref":"#/components/schemas/FavoriteJob" } }, "monitorJobs":{ "type":"array", "items":{ "$ref":"#/components/schemas/FavoriteMonitorJob" } }, "connections":{ "type":"array", "items":{ "$ref":"#/components/schemas/FavoriteConnection" } } }, "example":{ "jobs":[ { "id":1020, "name":"job1" } ], "monitorJobs":[ { "runId":1021, "name":"job1" } ], "connections":[ { "id":1001, "name":"oracle" } ] } }

例:

{ "jobs":[ { "id":1020, "name":"job1" } ], "monitorJobs":[ { "runId":1021, "name":"job1" } ], "connections":[ { "id":1001, "name":"oracle" } ] }

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

タイプ: array

ソースの表示

• 配列: object FavoriteConnection

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

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

タイプ: array

ソースの表示

• 配列: object FavoriteJob

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

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

タイプ: array

ソースの表示

• 配列: object FavoriteMonitorJob

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

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

タイプ: object

ソースの表示

• id: integer (int64)
  接続ID。これは必須パラメータです。
• name: string

{ "type":"object", "properties":{ "id":{ "type":"integer", "description":"Connection ID. This is a required parameter.", "format":"int64" }, "name":{ "type":"string" } } }

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

タイプ: object

ソースの表示

• id: integer (int64)
  ジョブID。これは必須パラメータです。
• name: string

{ "type":"object", "properties":{ "id":{ "type":"integer", "description":"Job ID. This is a required parameter.", "format":"int64" }, "name":{ "type":"string" } } }

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

タイプ: object

ソースの表示

• name: string
• runId: integer (int64)
  実行ID。これは必須パラメータです。

{ "type":"object", "properties":{ "runId":{ "type":"integer", "format":"int64", "description":"Run ID. This is a required parameter." }, "name":{ "type":"string" } } }

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

先頭に戻る