agency-board
POST /v1/agency/boards/{boardId}/views
Create or replace a named cut of the board.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/views \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
⛔ Server-side rather than per-browser, because the value of a saved view is that the whole team opens the same one — on a second laptop, on a phone, and after a browser reset. ⭐ Upsert by name: saving over a view you already have is what a person means by pressing Save with the same name, and a uniqueness error there is a dead end with no remedy in a UI. Unknown keys in `definition` are DROPPED rather than refused, so a newer console and an older engine can coexist during a deploy.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
boardId (path) | Uuid | はい | Project board ID (UUIDv7). |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
name | string | はい | — |
definition | AgencyBoardViewDefinition | いいえ | The filters, grouping and search that make up one cut of a board. ⛔ Unknown keys are DROPPED on save rather than refused, so a newer console's extra control does not 400 against… |
is_default | boolean | いいえ | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | はい | — |
definition | AgencyBoardViewDefinition | はい | The filters, grouping and search that make up one cut of a board. ⛔ Unknown keys are DROPPED on save rather than refused, so a newer console's extra control does not 400 against… |
is_default | boolean | はい | What a member sees on opening this board cold. At most one per board. |
created_at | string | いいえ | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 422