すべてのユーザーダッシュボードを取得する
リクエスト
GET <REST API URL>/userDashboards?fields=string&$skip=int&$top=int&query=string&orderBy=string
パラメーター | 説明 |
---|---|
fields | オプション。各 UserDashboard のフィールドの指定されたサブセットのみを返します。サブセットを定義するには、フィールド構文を使用します。 |
$skip | オプション。最初の UserDashboard を返す前にスキップする UserDashboard 数を設定できます。 |
$top | オプション。返される UserDashboard の最大数を設定できます。 |
query | オプション。検索クエリを指定して、返される結果をフィルタリングできます。サポートされている論理演算構文の定義については、照会の構文を参照してください。UserDashboards では、次のフィールドとタプルがサポートされています。 id : value — 指定された ID のユーザーダッシュボード user : user — 指定されたユーザーに関連付けられたユーザーダッシュボード |
orderBy | オプション。指定されたフィールドでソートされた UserDashboards のリストを返します。詳細についてはソート構文を参照してください。UserDashboards は次のフィールドによる並べ替えをサポートしています: ordinal |
レスポンス
レスポンスコード | 意味 |
---|---|
200 OK | リクエストが成功しました。 |
400 不正な要求 | リクエストパラメーターの少なくとも 1 つが無効です。例: 渡された JSON オブジェクトの必須フィールドがありません。詳細については、応答のエラーメッセージを確認してください。 |
403 禁止します | 要求元は、要求されたリソースにアクセスできません。 |
404 お探しのページが見つかりませんでした | 要求されたリソースが見つかりませんでした。 |
500 内部サーバーエラー | サーバーエラーのため、リクエストの処理に失敗しました。詳細については、応答のエラーメッセージを確認してください。 |
レスポンスボディ
{
"skip": int,
"top": int,
"total": int,
"userDashboards": [userDashboard, ...]
}