在席情報を取得する（ユーザー ID を指定）

ユーザー ID を指定して在席情報を取得します。

URL

クラウド版

https://sample.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

パスパラメーター

HTTP メソッド

GET

利用できるバージョン

• クラウド版 Garoon
• パッケージ版 Garoon 5.0 以降

必要なアクセス権

なし

リクエスト

パラメーター

なし

リクエストの例

URL

https://sample.cybozu.com/g/api/v1/presence/users/1

ヘッダー

1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

リクエストヘッダーの詳細は Garoon REST API の共通仕様 を参照してください。

レスポンス

プロパティ

プロパティ名	型	説明
user.id	数値	ユーザー ID
user.code	文字列	ユーザーのログイン名 パッケージ版 Garoon の場合、ログイン名を公開する設定が必要です。 詳細は ユーザー情報の項目を変更する を参照してください。
user.name	文字列	ユーザーの表示名
updatedAt	文字列	在席情報の更新日時 形式は ISO8601 の UTC タイムゾーンです。
notes	文字列	メモ 改行文字は「\n」です。
status	オブジェクト	在席情報のステータス
status.name	文字列	在席情報のステータス名 status.code ごとに内容が異なります。 また、値の言語は API を実行するユーザーの言語設定に応じます。次に示すのは、日本語に設定した場合の値です。 「attend」の場合：「在席」 「absence」の場合：「不在」 管理者またはアプリケーション管理者が追加したステータス：追加したステータス 空の文字列の場合：「登録がありません」
status.code	文字列	在席情報のステータスコード attend absence 管理者またはアプリケーション管理者が追加したステータス 空の文字列

レスポンスの例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

{
  "user": {
    "id": "1",
    "code": "c000001",
    "name": "Noboru Satoh(Satoh Noboru); Sales Department"
  },
  "updatedAt": "2022-09-29T06:25:18Z",
  "notes": "This is presence note.",
  "status": {
    "name": "At desk",
    "code": "attend"
  }
}

サンプルコード

curl を使ったリクエスト

1
2

curl -X GET 'https://sample.cybozu.com/g/api/v1/presence/users/1' \
-H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' 

Garoon REST API リクエストを送信する API を使ったリクエスト

1

await garoon.api('/api/v1/presence/users/1', 'GET', {});