カテゴリー内の他の記事

在席情報の更新 (PATCH)

フォローする

Index

在席情報の更新(ユーザーIDを指定)

ユーザーIDを指定して在席情報の内容を更新できます。

HTTP メソッド

PATCH

URI

クラウド版

https://(サブドメイン名).cybozu.com/g/api/v1/presence/users/{id}

パッケージ版(Windows環境)

http://(サーバーのIPアドレスまたはホスト名)/scripts/(インストール識別子)/grn.exe/api/v1/presence/users/{id}

パッケージ版(Linux環境)

http://(サーバーのIPアドレスまたはホスト名)/cgi-bin/(インストール識別子)/grn.cgi/api/v1/presence/users/{id}

使用可能なガルーンのバージョン

  • クラウド版 Garoon
  • パッケージ版 Garoon バージョン 5.0.0以降

必要なアクセス権

更新する在席情報に対する変更権限

リクエストパラメータ

パラメータ名 指定する値 必須 説明
id 数値 必須

更新する在席情報のユーザーIDを指定します。

リクエストの例 

リクエストヘッダ

PATCH /g/api/v1/presence/users/1 HTTP/1.1
Host: {subdomain}.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
  • Content-Typeヘッダは不要です。

リクエストボディ

パラメータ名 指定する値 説明
status.code 文字列

在席情報のステータスコード
指定しない場合は、空の文字列で更新されます。

  • attend
  • absence
  • 管理者またはアプリケーション管理者が追加したステータス
  • "" (空の文字列)
notes 文字列

メモ
指定しない場合は、空の文字列で更新されます。

改行文字は「\n」です。

レスポンスの例

処理が成功すると、在席情報の内容がJSON形式で返されます。

在席情報の更新(ログイン名を指定)

ログイン名を指定して在席情報の内容を更新できます。

HTTP メソッド

PATCH

URI

クラウド版

https://(サブドメイン名).cybozu.com/g/api/v1/presence/users/code/{code}

パッケージ版(Windows環境)

http://(サーバーのIPアドレスまたはホスト名)/scripts/(インストール識別子)/grn.exe/api/v1/presence/users/code/{code}

パッケージ版(Linux環境)

http://(サーバーのIPアドレスまたはホスト名)/cgi-bin/(インストール識別子)/grn.cgi/api/v1/presence/users/code/{code}

使用可能なガルーンのバージョン

  • クラウド版 Garoon
  • パッケージ版 Garoon バージョン 5.0.0以降

必要なアクセス権

在席情報の変更権限

リクエストパラメータ

パラメータ名 指定する値 必須 説明
code 文字列 必須

取得する在席情報のログイン名を指定します。

ユーザーが入力した値はURLエンコードする必要があります。
例:
"user one"という名前のユーザーを指定する場合、
"user%20one"と入力します。

リクエストの例 

リクエストヘッダ

PATCH /g/api/v1/presence/users/code/user%2520one HTTP/1.1
Host: {subdomain}.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
  • Content-Typeヘッダは不要です。

リクエストボディ

パラメータ名 指定する値 説明
status.code 文字列

在席情報のステータスコード
指定しない場合は、空の文字列で更新されます。

  • attend
  • absence
  • 管理者またはアプリケーション管理者が追加したステータス
  • "" (空の文字列)
notes 文字列

メモ
指定しない場合は、空の文字列で更新されます。

改行文字は「\n」です。

レスポンスの例

処理が成功すると、在席情報の内容がJSON形式で返されます。 

制限事項

  • API 実行ユーザーが操作可能なユーザーの在席情報のみ更新できます。
    他のユーザーの在席情報を更新する場合は、API 実行ユーザーを代理人に設定してください。
  • 「ステータスの自動設定」で、「ログイン時に在席を設定する」が有効の場合、Garoon ログイン時に在席情報のステータスコードは「attend」に自動更新されます。
    API を使って在席情報を制御する場合は、「ログイン時に在席を設定する」を無効にしてください。
    Garoon ヘルプ - 在席確認の一般設定 クラウド版
  • 共通仕様の制限事項 をご確認ください。

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。