移動

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

ユーザー・プリファレンスの取得

get

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

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

ユーザー・プリファレンスのフェッチ

リクエスト

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

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

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

ユーザー・プリファレンスの詳細を正常に取得しました。

本文()

ルート・スキーマ: PreferenceDetails

タイプ: object

すべて一致

ソースの表示

• object BaseObject_3
• object PrefernceObject2

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseObject_3"
        },
        {
            "$ref":"#/components/schemas/PrefernceObject2"
        }
    ],
    "example":{
        "attributesList":[
            {
                "name":"autoRefreshInterval",
                "default":true,
                "value":30,
                "defaultValue":30,
                "type":"INTEGER",
                "min":10,
                "max":100
            }
        ]
    }
}

例:

{
    "attributesList":[
        {
            "name":"autoRefreshInterval",
            "default":true,
            "value":30,
            "defaultValue":30,
            "type":"INTEGER",
            "min":10,
            "max":100
        }
    ]
}

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

タイプ: object

ソースの表示

• id: integer (int64)
  オブジェクトID。
• name: string
  オブジェクト名。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Object Id.",
            "format":"int64"
        },
        "name":{
            "type":"string",
            "description":"Object Name."
        }
    }
}

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

タイプ: object

ソースの表示

• attributesList: array attributesList

{
    "type":"object",
    "properties":{
        "attributesList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PreferenceAttribute"
            }
        }
    }
}

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

タイプ: array

ソースの表示

• 配列: object PreferenceAttribute

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

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

タイプ: object

ソースの表示

• default: boolean
• defaultValue: string
• max: integer
  型がINTEGERの場合に表示されます。
• min: integer
  型がINTEGERの場合に表示されます。
• name: string
  指定できる値: [ "autoRefreshInterval", "fontSize" ]
• options: string
  タイプがENUMの場合に表示されます。
• type: string
  指定できる値: [ "BOOLEAN", "ENUM", "INTEGER", "STRING" ]
• value: string

{
    "type":"object",
    "properties":{
        "name":{
            "$ref":"#/components/schemas/PreferenceAttributeEnum"
        },
        "default":{
            "type":"boolean"
        },
        "value":{
            "type":"string"
        },
        "defaultValue":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "BOOLEAN",
                "ENUM",
                "INTEGER",
                "STRING"
            ]
        },
        "options":{
            "type":"string",
            "description":"It is displayed when type is ENUM."
        },
        "min":{
            "type":"integer",
            "description":"It is displayed when type is INTEGER."
        },
        "max":{
            "type":"integer",
            "description":"It is displayed when type is INTEGER."
        }
    }
}

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

先頭に戻る