メインコンテンツまでスキップ

プロジェクト権限のAPIについて

概要​

ここでは、プロジェクトの権限に関する API の全体像と使い方を紹介します。

API で操作する対象​

TimeTracker RX のプロジェクト設定のうち、「セキュリティ」画面を API 経由で操作します。

本操作に関する API は以下の4つです。

  1. プロジェクトの権限の追加
  2. プロジェクトの権限の取得
  3. プロジェクトの権限の更新
  4. プロジェクトの権限の削除

各APIの使い方​

対象の API を利用する以下の3つのシーン毎の使い方を紹介します。

セキュリティ設定前​

プロジェクト作成直後はセキュリティ設定はされていないため、下図のように何もない状態です。

この状態では API でセキュリティの設定を変更できません。

この状態で「プロジェクトの権限の取得」の Web API を実行しても、何も取得できません。

そのため、まずはセキュリティ設定の枠組みを作成します。

  • 実行するAPI： 「 プロジェクトの権限の追加 」
  • API 実行後の状態
    • TimeTracker RX のクライアント画面：
      以下のように、API のボディリクエストに記載した権限設定が反映されます。
    • API：プロジェクトの権限の取得
      戻り値で今回作成したセキュリティ設定の id を返します。

セキュリティ設定変更時​

実行するAPI： 「プロジェクトの権限の更新」

特定メンバの権限を削除する場合は上記 API のリクエストボディで設定してください。

権限を設定している全てのメンバを削除した場合は、セキュリティ設定削除API実行後と同じ状態になります。

セキュリティ設定削除時​

実行するするAPI： 「プロジェクトの権限の削除」

  • セキュリティ設定を初めからやり直したいときに実行してください。

  • 実行するとプロジェクト作成時と同じ状態（下図）になります。

再度セキュリティを設定する場合は、「セキュリティ設定前」と同じ手順を実施してください。
に最終更新