WSD プレゼンス API

  • リリースバージョン: Australia
  • 更新日 2026年04月27日
  • 所要時間：63分

    • WSD プレゼンス API を使用すると、ユーザーは毎週のルーチン、1 回限りの例外、協力者の可視化など、オフィス勤務スケジュールを管理できます。

    この API は、従業員がオフィスへの出席予定を同僚に伝えることができるようにすることで、 ワークプレイスサービスデリバリ (WSD) コンシェルジュエクスペリエンスをサポートします。この API は、次のアクションに使用します。
    • 毎週のオフィス勤務ルーチン、スケジュールされた例外、オプションで協力者のプレゼンス情報など、認証されたユーザーの完全なプレゼンスデータを取得します。
    • 従業員が定期的なスケジュールを設定できるように、毎週のオフィス勤務ルーチンを管理します。
    • 特定の日付のルーチンを上書きする 1 回限りの例外を作成および管理します。
    • 協力者を表示および管理して、調整されたオフィス内計画を有効にします。

    認証されたユーザーとは、ログインしているか、認証情報が API 要求に含まれているユーザーです。任意の順序でエンドポイントを呼び出します。それぞれが独立して動作します。

    WSD Presence API は sn_wsd_concierge 名前空間に属しています。コンシェルジュプラグインがアクティブな場合、 WSD 予約 API GET /user/context エンドポイントは、 WSD プレゼンス API からプレゼンススケジュールデータを返すことができます。

    要件

    WSD プレゼンス API には次のものが必要です。
    • ユーザーにアサインされた sn_wsd_core.workplace_user ロール。
    • ワークプレイスサービスデリバリ Core (com.sn_wsd_core) プラグインがアクティブ化されている。
    • sn_wsd_core.workplace_user ロールが割り当てられているユーザーレコードが少なくとも 1 つsys_userに存在する必要があります。

    WSD プレゼンス:DELETE /api/sn_wsd_concierge/v1/presence/collaborator/{collaborator_id}

    認証されたユーザーのプレゼンスヴィジビリティリストから協力者を削除します。ユーザーが同僚のオフィスへの出席を追跡する必要がなくなった場合は、このエンドポイントを使用します。

    認証されたユーザーとは、ログインしているか、認証情報が API 要求に含まれているユーザーです。協力者はsys_idによって識別されます。

    URL 形式

    バージョニングされた URL: /api/sn_wsd_concierge/{api_version}/presence/collaborator/{collaborator_id}

    デフォルト URL: /api/sn_wsd_concierge/presence/collaborator/{collaborator_id}

    サポートされている要求パラメーター

    表 : 1. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    collaborator_id ユーザーのヴィジビリティリストから削除する協力者のSys_id。

    テーブル： ユーザー [sys_user]

    データタイプ：文字列
    表 : 2. クエリパラメーター
    名前 説明
    なし
    表 : 3. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 4. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされているタイプ: application/json、 application/xml、または text/xml。
    認証 認証情報。ベーシック認証またはセッションベースの認証をサポートします。
    表 : 5. 応答ヘッダー
    ヘッダー 説明
    Content-Type 応答本文のデータ形式:application/json。

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 6. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400要求が正しくありません。collaborator_idパスパラメーターがないか無効です。
    404 見つかりません。指定された協力者が見つかりませんでした。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    result 要求の結果を含むオブジェクト。

    データタイプ: オブジェクト

    "result": {
  "message": "String"
}
    result.message 削除された協力者の数を示す確認メッセージ。

    データタイプ：文字列

    cURL 要求

    この例では、認証されたユーザーのプレゼンス可視化リストから特定の協力者を削除します。

    curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/collaborator/usr1a2b3c4d5e6" \
--request DELETE \
--header "Accept: application/json" \
--user "username:password"

    応答本文。

    {
  "result": {
    "message": "1 collaborator(s) removed"
  }
}

    WSD プレゼンス:DELETE /api/sn_wsd_concierge/v1/presence/exception/{exception_id}

    sys_idで識別される特定のプレゼンス例外を削除します。ユーザーが 1 回限りの上書きを削除し、その日付の通常の週次ルーチンに戻す場合は、このエンドポイントを使用します。

    URL 形式

    バージョニングされた URL: /api/sn_wsd_concierge/{api_version}/presence/exception/{exception_id}

    デフォルト URL: /api/sn_wsd_concierge/presence/exception/{exception_id}

    サポートされている要求パラメーター

    表 : 7. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    exception_id 必須です。削除するプレゼンス例外のSys_id。

    テーブル:従業員プレゼンスの例外 (sn_wsd_concierge_employee_presence_exception)

    データタイプ：文字列
    表 : 8. クエリパラメーター
    名前 説明
    なし
    表 : 9. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 10. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされているタイプ: application/json、 application/xml、または text/xml。
    認証認証情報。ベーシック認証またはセッションベースの認証をサポートします。
    表 : 11. 応答ヘッダー
    ヘッダー 説明
    Content-Type 応答本文のデータ形式:application/json。

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 12. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。exception_idパスパラメーターがないか無効です。
    404 見つかりません。指定された例外が見つかりませんでした。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    result 要求の結果を含むオブジェクト。

    データタイプ: オブジェクト

    "result": {
  "message": "String"
}
    result.message 例外が削除されたことを示す確認メッセージ。

    データタイプ：文字列

    cURL 要求

    この例では、例外 exc1a2b3c4d5e6 を削除し、その日付をユーザーの通常の週次ルーチンに戻します。

    curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/exception/exc1a2b3c4d5e6" \
--request DELETE \
--header "Accept: application/json" \
--user "username:password"

    応答本文。

    {
  "result": {
    "message": "Exception deleted successfully"
  }
}

    WSD プレゼンス:GET /api/sn_wsd_concierge/v1/プレゼンス/協力者

    認証されたユーザーの協力者のリストと、各協力者のプレゼンスデータ、ルーチン、および例外を取得します。このエンドポイントを使用して、同僚のオフィスへの出勤スケジュールを表示し、調整されたオフィス勤務計画を有効にします。

    URL 形式

    バージョニングされた URL: /api/sn_wsd_concierge/{api_version}/presence/collaborator

    デフォルト URL: /api/sn_wsd_concierge/presence/collaborator

    サポートされている要求パラメーター

    表 : 13. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 14. クエリパラメーター
    名前 説明
    なし
    表 : 15. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 16. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされているタイプ: application/json、 application/xml、または text/xml。
    認証 認証情報。ベーシック認証またはセッションベースの認証をサポートします。
    表 : 17. 応答ヘッダー
    ヘッダー 説明
    Content-Type 応答本文のデータ形式:application/json。

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 18. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    404 見つかりません。ユーザーが見つかりませんでした。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    result 要求の結果を含むオブジェクト。

    データタイプ: オブジェクト

    "result": {
  "count": Number,
  "collaborators": [Array]
}
    result.count 返された協力者の合計数。

    データタイプ：数値
    result.collaborators プレゼンスデータを含む協力者のリスト。

    協力者のプライバシーが有効になっている場合、 privacy_enabled は true で、 routine が null で exceptions が空です。

    データタイプ：オブジェクトのアレイ

    "collaborators": [
 {
  "sys_id": "String", 
  "name": "String", 
  "privacy_enabled": Boolean,
  "routine": {Object},
  "exceptions": [Array]
 }
]
    result.collaborators.sys_id 協力者のユーザーレコードのSys_id。

    テーブル： ユーザー [sys_user]

    データタイプ：文字列
    result.collaborators.name sys_userレコードに表示される協力者の名前を表示します。

    テーブル： ユーザー [sys_user]

    データタイプ：文字列
    result.collaborators.privacy_enabled ブーリアン。協力者がプレゼンスデータのプライバシーを有効にしているかどうかを示すフラグ。
    有効な値：
    • true:協力者のルーチンと例外は非表示になります。 routine は null で、 exceptions は空のアレイになります。
    • false:協力者のプレゼンスデータが表示されます。

    データタイプ：ブーリアン
    result.collaborators.routine 協力者の毎週のオフィス勤務ルーチン。

    予定されているオフィスへの出席を示す各曜日のブールフラグが含まれています。協力者がその日にオフィス勤務を予定している場合は true が表示され、出席が予定されていない場合は false が表示されます。

    データタイプ: オブジェクト

    "routine": { 
   "monday": "Boolean", 
   "tuesday": "Boolean", 
   "wednesday": "Boolean", 
   "thursday": "Boolean", 
   "friday": "Boolean", 
   "saturday": "Boolean", 
   "sunday": "Boolean" 
}
    result.collaborators.exceptions 協力者の 1 回限りのプレゼンスの例外。privacy_enabledが true の場合は空のアレイを返します。

    データタイプ：オブジェクトのアレイ

    "exceptions": [ 
 { 
  "sys_id": "String", 
  "date": "String", 
  "in_office": "Boolean", 
  "origin": "String", 
  "location": "String" 
 } 
]
    result.collaborators.exceptions.sys_id 例外レコードのSys_id。

    テーブル:従業員プレゼンスの例外 (sn_wsd_concierge_employee_presence_exception)

    データタイプ：文字列
    result.collaborators.exceptions.date この例外が適用される日付。これは、ユーザーのルーチンが上書きされる日付です。

    形式:yyyy-MM-dd

    データタイプ：文字列
    result.collaborators.exceptions.in_office この日付にユーザーがオフィスにいるかどうかを示すフラグ。これにより、その曜日に指定されている週次ルーチンが上書きされます。
    有効な値：
    • true:ユーザーはオフィスにいます。
    • false:ユーザーはオフィスにいません

    データタイプ：文字列
    result.collaborators.exceptions.origin 例外を作成したソース。
    有効な値：
    • ユーザー:従業員が手動で作成します。
    • システム:プラットフォームによって自動的に作成されます。
    • manual:アドミンまたはユーザーの代わりに作成されます。

    データタイプ：文字列
    result.collaborators.exceptions.location この日付にユーザーがいるオフィスの場所の名前または識別子。in_officeが true の場合にのみ関連します。ユーザーがリモートの場合、空の文字列になることがあります。

    データタイプ：文字列

    cURL 要求

    この例では、認証されたユーザーのすべての協力者とそのプレゼンスデータを取得します。

    curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/collaborator" \
--request GET \
--header "Accept: application/json" \
--user "username:password"

    応答本文。

    {
  "result": {
    "count": 2,
    "collaborators": [
      {
        "sys_id": "usr1a2b3c4d5e6", "name": "Jane Smith", "privacy_enabled": false,
        "routine": {
          "monday": true, "tuesday": true, "wednesday": false,
          "thursday": true, "friday": false, "saturday": false, "sunday": false
        },
        "exceptions": [
          { "sys_id": "exc1a2b3c", "date": "2026-03-10", "in_office": true, "origin": "user", "location": "Building B" }
        ]
      },
      { "sys_id": "usr7f8g9h0i1j2", "name": "John Doe", "privacy_enabled": true, "routine": null, "exceptions": [] }
    ]
  }
}

    WSD プレゼンス:GET /api/sn_wsd_concierge/v1/presence/exception

    認証されたユーザーのプレゼンス例外を取得します。例外は、日付範囲または特定の例外sys_idでフィルタリングできます。ユーザーの週次ルーチンに対する 1 回限りの上書きを表示する必要がある場合は、このエンドポイントを使用します。

    URL 形式

    バージョニングされた URL: /api/sn_wsd_concierge/{api_version}/presence/exception

    デフォルト URL: /api/sn_wsd_concierge/presence/exception

    サポートされている要求パラメーター

    表 : 19. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 20. クエリパラメーター
    名前 説明
    exception_id 取得する特定の例外のSys_id。

    指定すると、日付範囲フィルターが上書きされ、一致する例外のみが返されます。

    テーブル:従業員プレゼンスの例外 (sn_wsd_concierge_employee_presence_exception)

    データタイプ：文字列
    exception_start_date 例外をフィルタリングする開始日。

    形式:yyyy-MM-dd

    データタイプ：文字列

    デフォルト:今日
    exception_end_date 例外のフィルタリングの終了日。

    形式:yyyy-MM-dd

    データタイプ：文字列

    デフォルト:今日 + 3 か月
    表 : 21. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 22. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされているタイプ: application/json、 application/xml、または text/xml。
    認証 認証情報。ベーシック認証またはセッションベースの認証をサポートします。
    表 : 23. 応答ヘッダー
    ヘッダー 説明
    Content-Type 応答本文のデータ形式:application/json。

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 24. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。exception_start_dateまたはexception_end_dateの日付形式が無効です。
    404 見つかりません。指定された例外が見つかりませんでした。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    result 要求の結果を含むオブジェクト。

    データタイプ: オブジェクト

    "result": {
  "exceptions": [Array]
}
    result.exceptions フィルター基準に一致するプレゼンス例外のリスト。

    データタイプ：オブジェクトのアレイ

    "exceptions": [
{
  "sys_id": "sys_id", 
  "date": "String", 
  "in_office": String, 
  "origin": "String", 
  "location": "String" 
 }
]
    result.exceptions.date この例外が適用される日付。これは、ユーザーのルーチンが上書きされる日付です。

    形式:yyyy-MM-dd 形式

    データタイプ：文字列
    result.exceptions.in_office この日付にユーザーがオフィスにいるかどうかを示すフラグ。これにより、その曜日に指定されている週次ルーチンが上書きされます。
    有効な値：
    • true:ユーザーはオフィスにいます。
    • false:ユーザーはオフィスにいません

    データタイプ：文字列
    result.exceptions.location この日付におけるユーザーのオフィス所在地の名前または識別子。in_officeが true の場合にのみ関連します。ユーザーがリモートの場合、空の文字列になることがあります。

    データタイプ：文字列
    result.exceptions.origin 例外を作成したソース。
    有効な値：
    • ユーザー:従業員が手動で作成します。
    • システム:プラットフォームによって自動的に作成されます。
    • manual:アドミンまたはユーザーの代わりに作成されます。

    データタイプ：文字列
    result.exceptions.sys_id 例外レコードのSys_id。

    テーブル:従業員プレゼンスの例外 (sn_wsd_concierge_employee_presence_exception)

    データタイプ：文字列

    cURL 要求

    この例では、2026 年上半期のすべての例外を取得します。

    curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/exception?exception_start_date=2026-01-01&exception_end_date=2026-06-30" \
--request GET \
--header "Accept: application/json" \
--user "username:password"

    応答本文。

    {
  "result": {
    "exceptions": [
      { "sys_id": "exc1a2b3c4d5e6", "date": "2026-02-14", "in_office": true, "origin": "user", "location": "Building A" },
      { "sys_id": "exc7f8g9h0i1j2", "date": "2026-03-17", "in_office": false, "origin": "system", "location": "" }
    ]
  }
}

    WSD プレゼンス:GET /api/sn_wsd_concierge/v1/presence

    週次のオフィス勤務ルーチン、スケジュールされたプレゼンスの例外、オプションで協力者のプレゼンス情報など、認証されたユーザーの完全なプレゼンスデータを取得します。

    このエンドポイントを使用して、ユーザーの予定オフィス出席の全体像を把握します。プライバシー設定に従って、sys_idを指定して別のユーザーのプレゼンスデータを照会することもできます。

    URL 形式

    バージョニングされた URL: /api/sn_wsd_concierge/{api_version}/presence

    デフォルト URL: /api/sn_wsd_concierge/presence

    サポートされている要求パラメーター

    表 : 25. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 26. クエリパラメーター
    名前 説明
    user_id プレゼンスデータを取得するターゲットユーザーのSys_id。指定しない場合は、認証されたユーザーのプレゼンスデータを返します。
    注:
    クロスユーザークエリは、発信者に明示的な権限がない限り、401 Unauthorized を返します。

    テーブル： ユーザー [sys_user]

    データタイプ：文字列
    exception_start_date プレゼンスの例外をフィルタリングする開始日。

    形式:yyyy-MM-dd

    データタイプ：文字列

    デフォルト:今日
    exception_end_date プレゼンスの例外をフィルタリングする終了日。

    形式:yyyy-MM-dd

    データタイプ：文字列

    デフォルト:今日 + 3 か月
    include 応答に含める関連データ。

    有効な値: 協力者のみ

    データタイプ：文字列
    表 : 27. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 28. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされているタイプ: application/json、 application/xml、または text/xml。
    認証 認証情報。ベーシック認証またはセッションベースの認証をサポートします。
    表 : 29. 応答ヘッダー
    ヘッダー 説明
    Content-Type 応答本文のデータ形式:application/json。

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 30. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。exception_start_dateまたはexception_end_dateの日付形式が無効であるか、user_id形式が無効です。
    401 権限がありません。認証されたユーザーには、ターゲットユーザーのプレゼンスデータを表示する権限がありません。user_idが指定され、認証されたユーザーと一致しない場合に返されます。
    404 見つかりません。指定されたユーザーが見つかりませんでした。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    result 応答の結果を含むオブジェクト。
    "result": {
  "routine": {Object},
  "exceptions": [Array],
  "collaborators": [Array]
}
    result.routine ユーザーの毎週のオフィス勤務ルーチン。

    予定されているオフィスへの出席を示す各曜日のブールフラグが含まれています。認証されたユーザーがその日にオフィスに出社する予定がある場合は true が表示され、出席が予定されていない場合は false を表示します。

    データタイプ: オブジェクト

    "routine": { 
   "monday": "Boolean", 
   "tuesday": "Boolean", 
   "wednesday": "Boolean", 
   "thursday": "Boolean", 
   "friday": "Boolean", 
   "saturday": "Boolean", 
   "sunday": "Boolean" 
}
    result.exceptions 特定の日付のユーザーのルーチンを上書きする 1 回限りのプレゼンス例外のリスト。

    データタイプ：オブジェクトのアレイ

    "exceptions": [ 
   { 
     "sys_id": "String", 
     "date": "String", 
     "in_office": "Boolean", 
     "origin": "String", 
     "location": "String" 
   } 
]
    result.exceptions.sys_id 例外レコードのSys_id。

    テーブル:従業員プレゼンスの例外 (sn_wsd_concierge_employee_presence_exception)

    データタイプ：文字列
    result.exceptions.date この例外が適用される日付 (yyyy-MM-dd 形式)。これは、ユーザーのルーチンが上書きされる日付です。

    データタイプ：文字列
    result.exceptions.in_office この日付にユーザーがオフィスにいるかどうかを示すフラグ。これにより、その曜日に指定されている週次ルーチンが上書きされます。
    有効な値：
    • true:ユーザーはオフィスにいます。
    • false:ユーザーはオフィスにいません

    データタイプ：文字列
    result.exceptions.origin 例外を作成したソース。
    有効な値：
    • ユーザー:従業員が手動で作成します。
    • システム:プラットフォームによって自動的に作成されます。
    • manual:アドミンまたはユーザーの代わりに作成されます。

    データタイプ：文字列
    result.exceptions.location この日付におけるユーザーのオフィス所在地の名前または識別子。in_officeが true の場合にのみ関連します。ユーザーがリモートの場合、空の文字列になることがあります。

    データタイプ：文字列
    result.collaborators 協力者とそのプレゼンスデータのリスト。include=collaborators が指定されている場合にのみ返されます。

    協力者のプライバシーが有効になっている場合、 privacy_enabled は true で、 routine が null で exceptions が空です。

    データタイプ：オブジェクトのアレイ

    "collaborators": [ 
   { 
     "sys_id": "String", 
     "name": "String", 
     "privacy_enabled": Boolean, 
     "routine": {Object}, 
     "exceptions": [Array]
   } 
]
    result.collaborators.sys_id 協力者のユーザーレコードのSys_id。

    テーブル： ユーザー [sys_user]

    データタイプ：文字列
    result.collaborators.name sys_userレコードに表示される協力者の表示名。

    テーブル： ユーザー [sys_user]

    データタイプ：文字列
    result.collaborators.privacy_enabled ブーリアン。協力者がプレゼンスデータのプライバシーを有効にしているかどうかを示すフラグ。
    有効な値：
    • true:協力者のルーチンと例外は非表示になります。 routine は null で、 exceptions は空のアレイになります。
    • false:協力者のプレゼンスデータが表示されます。

    データタイプ：ブーリアン
    result.collaborators.routine 協力者の毎週のオフィス勤務ルーチン。

    予定されているオフィスへの出席を示す各曜日のブールフラグが含まれています。協力者がその日オフィス勤務を予定している場合は true が表示され、出席が予定されていない場合は false が表示されます。

    データタイプ: オブジェクト

    "routine": { 
   "monday": "Boolean", 
   "tuesday": "Boolean", 
   "wednesday": "Boolean", 
   "thursday": "Boolean", 
   "friday": "Boolean", 
   "saturday": "Boolean", 
   "sunday": "Boolean" 
}
    result.collaborators.exceptions 協力者の 1 回限りのプレゼンスの例外。認証されたユーザーの exceptions パラメーターと同じ構造に従います。privacy_enabledが true の場合は空のアレイを返します。

    データタイプ：オブジェクトのアレイ

    "exceptions": [ 
   { 
     "sys_id": "String", 
     "date": "String", 
     "in_office": "Boolean", 
     "origin": "String", 
     "location": "String" 
   } 
]

    cURL 要求

    この例では、2026 年第 1 四半期の例外について、協力者スケジュールを含む認証されたユーザーの完全なプレゼンスデータを取得します。

    curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence?include=collaborators&exception_start_date=2026-01-01&exception_end_date=2026-03-31" \
--request GET \
--header "Accept: application/json" \
--user "username:password"

    応答本文。

    {
  "result": {
    "routine": {
      "monday": true,  "tuesday": false, "wednesday": true,
      "thursday": true, "friday": false, "saturday": false, "sunday": false
    },
    "exceptions": [
      {
        "sys_id": "a1b2c3d4e5f6",
        "date": "2026-02-14",
        "in_office": true,
        "origin": "user",
        "location": "Building A"
      }
    ],
    "collaborators": [
      {
        "sys_id": "f6e5d4c3b2a1",
        "name": "Jane Smith",
        "privacy_enabled": false,
        "routine": {
          "monday": true, "tuesday": true, "wednesday": false,
          "thursday": true, "friday": false, "saturday": false, "sunday": false
        },
        "exceptions": []
      }
    ]
  }
}

    WSD プレゼンス:GET /api/sn_wsd_concierge/v1/presence/routine

    認証されたユーザーの週次オフィス勤務ルーチンのみを取得します。これは、例外や協力者のないルーチンスケジュールのみが必要な場合に、GET /presence の軽量の代替手段です。

    URL 形式

    バージョニングされた URL: /api/sn_wsd_concierge/{api_version}/presence/routine

    デフォルト URL: /api/sn_wsd_concierge/presence/routine

    サポートされている要求パラメーター

    表 : 31. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 32. クエリパラメーター
    名前 説明
    なし
    表 : 33. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 34. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされているタイプ: application/json、 application/xml、または text/xml。
    認証 認証情報。ベーシック認証またはセッションベースの認証をサポートします。
    表 : 35. 応答ヘッダー
    ヘッダー 説明
    Content-Type 応答本文のデータ形式:application/json。

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 36. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    404見つかりません。ユーザーまたはルーチンが見つかりませんでした。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    result 要求の結果を含むオブジェクト。

    データタイプ: オブジェクト

    "result": {
  "user_id": "String",
  "routine": {Object}
}
    result.user_id ルーチンが返されるユーザーのSys_id。

    テーブル:ユーザー [sys_id]

    データタイプ：文字列
    result.routine ユーザーの毎週の定期的なオフィス勤務スケジュール。

    予定されているオフィスへの出席を示す各曜日のブールフラグが含まれています。ユーザーがその日オフィスに出社する予定がある場合は true が表示され、出席が予定されていない場合は false を表示します。

    データタイプ: オブジェクト

    "routine": {
  "monday": Boolean,
  "tuesday": Boolean,
  "wednesday": Boolean,
  "thursday": Boolean, 
  "friday": Boolean,
  "saturday": Boolean,
  "sunday": Boolean
}

    cURL 要求

    この例では、認証されたユーザーの週次のオフィス勤務ルーチンを取得します。

    curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/routine" \
--request GET \
--header "Accept: application/json" \
--user "username:password"

    応答本文。ユーザーのルーチンに月曜日から木曜日までの出社出席が表示されていることを示します。

    {
  "result": {
    "user_id": "a1b2c3d4e5f6g7h8",
    "routine": {
      "monday": true,  "tuesday": true,  "wednesday": true,
      "thursday": true, "friday": false, "saturday": false, "sunday": false
    }
  }
}

    WSD プレゼンス:PATCH /api/sn_wsd_concierge/v1/プレゼンス/ルーチン

    認証されたユーザーの週次オフィス勤務ルーチンを部分的に更新します。ユーザーがスケジュール全体をリセットせずに特定の日を調整する必要がある場合は、このエンドポイントを使用します。

    要求本文に指定された日のみが更新されます。その他の日はすべて変更されません。

    URL 形式

    バージョニングされた URL: /api/sn_wsd_concierge/{api_version}/presence/routine

    デフォルト URL: /api/sn_wsd_concierge/presence/routine

    サポートされている要求パラメーター

    表 : 37. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 38. クエリパラメーター
    名前 説明
    なし
    表 : 39. 要求本文パラメーター (XML または JSON)
    名前 説明
    ルーチン 必須です。認証されたユーザーの週次ルーチン。

    予定されているオフィスへの出席を示す各曜日のブールフラグが含まれています。認証されたユーザーがその日にオフィスに出社する予定がある場合は true が表示され、出席が予定されていない場合は false を表示します。

    要求で省略された日は変更されません。空のルーチンオブジェクトは、no-op として受け入れられます。

    データタイプ: オブジェクト

    "routine": { 
   "monday": "Boolean", 
   "tuesday": "Boolean", 
   "wednesday": "Boolean", 
   "thursday": "Boolean", 
   "friday": "Boolean", 
   "saturday": "Boolean", 
   "sunday": "Boolean" 
}

    ヘッダー

    次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 40. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされているタイプ: application/json、 application/xml、または text/xml。
    認証 認証情報。ベーシック認証またはセッションベースの認証をサポートします。
    Content-Type 要求本文のデータ形式:application/json。
    表 : 41. 応答ヘッダー
    ヘッダー 説明
    Content-Type 応答本文のデータ形式:application/json。

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 42. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。要求本文がないか、形式が無効であるか、有効な日フィールドが指定されていません。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    result 要求の結果を含むオブジェクト。

    データタイプ: オブジェクト

    "result": {
 "message": "String",
 "result": {Object}
}
    result.message ルーチンが更新されたことを示す確認メッセージ。

    データタイプ：文字列
    result.result 未変更の日数を含む 7 日間すべてを含む、完全な更新済みルーチンオブジェクトが含まれます。

    データタイプ: オブジェクト

    "result": { 
  "routine": {Object} 
}
    result.routine 毎週のオフィス勤務ルーチン。各曜日のブールフラグを含みます。 true はオフィスへの出席を示し、 false は欠勤を示します。

    データタイプ: オブジェクト

    "routine": { 
  "monday": "Boolean", 
  "tuesday": "Boolean",
  "wednesday": "Boolean", 
  "thursday": "Boolean",
  "friday": "Boolean", 
  "saturday": "Boolean", 
  "sunday": "Boolean"
}

    cURL 要求

    この例では、金曜日と土曜日のみを true に更新し、他の日はすべて変更されません。

    curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/routine" \
--request PATCH \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username:password" \
--data '{
  "routine": { "friday": true, "saturday": true }
}'

    応答本文。

    {
  "result": {
    "message": "Routine updated successfully",
    "result": {
      "routine": {
        "monday": true, "tuesday": true, "wednesday": true,
        "thursday": true, "friday": true, "saturday": true, "sunday": false
      }
    }
  }
}

    WSD プレゼンス:POST /api/sn_wsd_concierge/v1/プレゼンス/協力者

    認証されたユーザーのプレゼンスヴィジビリティリストに 1 人以上の協力者を追加します。協力者は、互いのプレゼンスデータを表示できます。このエンドポイントを使用して、オフィスへの出席を追跡する同僚のチームまたはグループを構築します。

    URL 形式

    バージョニングされた URL: /api/sn_wsd_concierge/{api_version}/presence/collaborator

    デフォルト URL: /api/sn_wsd_concierge/presence/collaborator

    サポートされている要求パラメーター

    表 : 43. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 44. クエリパラメーター
    名前 説明
    なし
    表 : 45. 要求本文パラメーター (XML または JSON)
    名前 説明
    collaborator_ids 必須です。協力者として追加するユーザーを識別する空でないsys_id値のアレイ。

    テーブル： ユーザー [sys_user]

    データタイプ：文字列のアレイ
    "collaborator_ids": ["String", "String"]

    ヘッダー

    次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 46. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされているタイプ: application/json、 application/xml、または text/xml。
    認証 認証情報。ベーシック認証またはセッションベースの認証をサポートします。
    Content-Type 要求本文のデータ形式:application/json。
    表 : 47. 応答ヘッダー
    ヘッダー 説明
    Content-Type 応答本文のデータ形式:application/json。

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 48. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。collaborator_idsがないか、アレイが空であるか、sys_id形式が無効です。
    404 見つかりません。sys_userテーブルに 1 つ以上の協力者sys_idsが見つかりませんでした。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    result 要求の結果を含むオブジェクト。

    データタイプ: オブジェクト

    result": {
  "message": "String",
  "collaborators": [Array]
}
    result.message 協力者が追加されたことを示す確認メッセージ。

    データタイプ：文字列
    result.collaborators 新しく追加された協力者とそのプレゼンスデータのリスト。

    データタイプ：オブジェクトのアレイ

    "collaborators": [
 {
  "sys_id": "String",
  "name": "String",
  "privacy_enabled": Boolean,
  "routine": {Object},
  "exceptions": [Array]
 }
]
    result.collaborators.sys_id 協力者のユーザーレコードのSys_id。

    テーブル： ユーザー [sys_user]

    データタイプ：文字列
    result.collaborators.name sys_userレコードに表示される協力者の表示名。

    テーブル： ユーザー [sys_user]

    データタイプ：文字列
    result.collaborators.privacy_enabled ブーリアン。協力者がプレゼンスデータのプライバシーを有効にしているかどうかを示すフラグ。
    有効な値：
    • true:協力者のルーチンと例外は非表示になります。 routine は null で、 exceptions は空のアレイになります。
    • false:協力者のプレゼンスデータが表示されます。

    データタイプ：ブーリアン
    result.collaborators.routine 協力者の毎週のオフィス勤務ルーチン。

    予定されているオフィスへの出席を示す各曜日のブールフラグが含まれています。協力者がその日オフィス勤務を予定している場合は true が表示され、出席が予定されていない場合は false が表示されます。

    データタイプ: オブジェクト

    "routine": { 
   "monday": "Boolean", 
   "tuesday": "Boolean", 
   "wednesday": "Boolean", 
   "thursday": "Boolean", 
   "friday": "Boolean", 
   "saturday": "Boolean", 
   "sunday": "Boolean" 
}
    result.collaborators.exceptions 協力者の 1 回限りのプレゼンスの例外。privacy_enabledが true の場合は空のアレイを返します。

    データタイプ：オブジェクトのアレイ

    "exceptions": [ 
   { 
     "sys_id": "String", 
     "date": "String", 
     "in_office": "Boolean", 
     "origin": "String", 
     "location": "String" 
   } 
]
    result.collaborators.exceptions.sys_id 例外レコードのSys_id。

    テーブル:従業員プレゼンスの例外 (sn_wsd_concierge_employee_presence_exception)

    データタイプ：文字列
    result.collaborators.exceptions.date この例外が適用される日付。これは、ユーザーのルーチンが上書きされる日付です。

    形式:yyyy-MM-dd 形式

    データタイプ：文字列
    result.collaborators.exceptions.in_office この日付にユーザーがオフィスにいるかどうかを示すフラグ。これにより、その曜日に指定されている週次ルーチンが上書きされます。
    有効な値：
    • true:ユーザーはオフィスにいます。
    • false:ユーザーはオフィスにいません

    データタイプ：文字列
    result.collaborators.exceptions.origin 例外を作成したソース。
    有効な値：
    • ユーザー:従業員が手動で作成します。
    • システム:プラットフォームによって自動的に作成されます。
    • manual:アドミンまたはユーザーの代わりに作成されます。

    データタイプ：文字列
    result.collaborators.exceptions.location この日付におけるユーザーのオフィス所在地の名前または識別子。in_officeが true の場合にのみ関連します。ユーザーがリモートの場合、空の文字列になることがあります。

    データタイプ：文字列

    cURL 要求

    この例では、sys_idsを指定して 2 人のユーザーを協力者として追加します。

    curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/collaborator" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username:password" \
--data '{
  "collaborator_ids": ["usr1a2b3c4d5e6", "usr7f8g9h0i1j2"]
}'

    応答本文。

    {
  "result": {
    "message": "Collaborator(s) added successfully",
    "collaborators": [
      {
        "sys_id": "usr1a2b3c4d5e6", "name": "Jane Smith", "privacy_enabled": false,
        "routine": { "monday": true, "tuesday": true, "wednesday": false, "thursday": true, "friday": false, "saturday": false, "sunday": false },
        "exceptions": []
      },
      { "sys_id": "usr7f8g9h0i1j2", "name": "John Doe", "privacy_enabled": true, "routine": null, "exceptions": [] }
    ]
  }
}

    WSD プレゼンス:POST /api/sn_wsd_concierge/v1/presence/exception

    特定の日付に認証されたユーザーに 1 回限りのプレゼンス例外を作成します。ユーザーが通常リモートで作業する日にオフィスに出社する予定がある場合 (またはその逆) に、このエンドポイントを使用します。

    例外は、その日付のユーザーの週次ルーチンを上書きします。

    URL 形式

    バージョニングされた URL: /api/sn_wsd_concierge/[api_version}/presence/exception

    デフォルト URL: /api/sn_wsd_concierge/presence/exception

    サポートされている要求パラメーター

    表 : 49. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 50. クエリパラメーター
    名前 説明
    なし
    表 : 51. 要求本文パラメーター (XML または JSON)
    名前 説明
    例外 必須です。1 回限りのプレゼンス上書きを定義する例外オブジェクト。

    データタイプ: オブジェクト

    "exception": { 
  "date": "String", 
  "in_office": "Boolean",
  "location": "String", 
  "origin": "String".
  "sys_id": "String"
}
    exception.date 例外の日付。

    形式:yyyy-MM-dd

    データタイプ：文字列
    exception.in_office この日付にユーザーがオフィスにいるかどうかを示すフラグ。
    可能な値：
    • true:ユーザーはオフィスにいます。
    • false:ユーザーはオフィスにいません。

    データタイプ：ブーリアン
    exception.location この例外のオフィス所在地の名前または識別子。

    データタイプ：文字列
    exception.origin 例外のソース。
    有効な値：
    • ユーザー:従業員が手動で作成します。
    • システム:プラットフォームによって自動的に作成されます。
    • manual:アドミンまたはユーザーの代わりに作成されます。
    データタイプ：文字列
    exception.sys_id 更新する既存の例外のSys_id。

    テーブル:従業員プレゼンスの例外 (sn_wsd_concierge_employee_presence_exception)

    データタイプ：文字列

    ヘッダー

    次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 52. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされているタイプ: application/json、 application/xml、または text/xml。
    認証 認証情報。ベーシック認証またはセッションベースの認証をサポートします。
    Content-Type 要求本文のデータ形式:application/json。
    表 : 53. 応答ヘッダー
    ヘッダー 説明
    Content-Type 応答本文のデータ形式:application/json。

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 54. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。必須フィールドの日付がないか、日付形式が無効です。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    result 要求の結果を含むオブジェクト。

    データタイプ: オブジェクト

    "result": {
    "message": "String",
    "result": {Object}
  }
    result.message 例外が追加されたことを示す確認メッセージ。

    データタイプ：文字列
    result.result 作成された例外を含むオブジェクト。

    データタイプ: オブジェクト

    "result": {
 "exceptions": [Array]
}
    result.exceptions 作成された例外に関する詳細を含むアレイ。

    データタイプ：オブジェクトのアレイ

    "exceptions": [
 {
  "date": "String",
  "location": "String",
  "in_office": Boolean,
  "origin": "String",
  "sys_id": "String"
 }
]
    result.result.exceptions.date この例外が適用される日付 (yyyy-MM-dd 形式)。これは、ユーザーのルーチンが上書きされる日付です。

    データタイプ：文字列
    result.result.exceptions.in_office この日付にユーザーがオフィスにいるかどうかを示すフラグ。これにより、その曜日に指定されている週次ルーチンが上書きされます。
    有効な値：
    • true:ユーザーはオフィスにいます。
    • false:ユーザーはオフィスにいません

    データタイプ：文字列
    result.result.exceptions.location この日付におけるユーザーのオフィス所在地の名前または識別子。in_officeが true の場合にのみ関連します。ユーザーがリモートの場合、空の文字列になることがあります。

    データタイプ：文字列
    result.result.exceptions.origin 例外を作成したソース。
    有効な値：
    • ユーザー:従業員が手動で作成します。
    • システム:プラットフォームによって自動的に作成されます。
    • manual:アドミンまたはユーザーの代わりに作成されます。

    データタイプ：文字列
    result.result.exceptions.sys_id 例外レコードのSys_id。

    テーブル:従業員プレゼンスの例外 (sn_wsd_concierge_employee_presence_exception)

    データタイプ：文字列

    cURL 要求

    この例では、2026 年 2 月 14 日のプレゼンス例外を作成し、ユーザーを建物 A のオフィスにいるとマークします。

    curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/exception" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username:password" \
--data '{
  "exception": {
    "date": "2026-02-14",
    "in_office": true,
    "location": "Building A - Floor 3",
    "origin": "user"
  }
}'

    応答本文。

    {
  "result": {
    "message": "Exception added successfully",
    "result": {
      "exceptions": [
        {
          "sys_id": "a1b2c3d4e5f6g7h8",
          "date": "2026-02-14",
          "in_office": true,
          "origin": "user",
          "location": "Building A - Floor 3"
        }
      ]
    }
  }
}

    WSD プレゼンス:POST /api/sn_wsd_concierge/v1/プレゼンス/ルーチン

    認証されたユーザーに対して新しい週次オフィス勤務ルーチンを作成します。ユーザーがプレゼンスルーチンを初めて設定する場合は、このエンドポイントを使用します。

    すべての 7 日間をブール値で指定する必要があります。

    URL 形式

    バージョニングされた URL: /api/sn_wsd_concierge/{api_version}/presence/routine

    デフォルト URL: /api/sn_wsd_concierge/presence/routine

    サポートされている要求パラメーター

    表 : 55. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    ルーチン 必須です。ユーザーの毎週のオフィス勤務ルーチン。

    予定されているオフィスへの出席を示す各曜日のブールフラグが含まれています。ユーザーがその日オフィスに出社する予定がある場合は true が表示され、出席が予定されていない場合は false を表示します。

    すべての日が必須です。

    データタイプ: オブジェクト

    "routine": { 
   "monday": "Boolean", 
   "tuesday": "Boolean", 
   "wednesday": "Boolean", 
   "thursday": "Boolean", 
   "friday": "Boolean", 
   "saturday": "Boolean", 
   "sunday": "Boolean" 
}
    表 : 56. クエリパラメーター
    名前 説明
    なし
    表 : 57. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 58. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされているタイプ: application/json、 application/xml、または text/xml。
    認証 認証情報。ベーシック認証またはセッションベースの認証をサポートします。
    Content-Type 要求本文のデータ形式:application/json。
    表 : 59. 応答ヘッダー
    ヘッダー 説明
    Content-Type 応答本文のデータ形式:application/json。

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 60. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。必須フィールドがないか、無効なデータタイプです。7 日間はすべてブール値で指定する必要があります。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    result 要求の結果を含むオブジェクト。

    データタイプ: オブジェクト

    "result": {
 "message": "String",
 "result": {Object}
}
    result.message ルーチンが作成されたことを示す確認メッセージ。

    データタイプ：文字列
    result.result 7 日間すべての作成されたルーチンオブジェクトが含まれます。

    データタイプ: オブジェクト

    "result": { 
  "routine": {Object} 
}
    result.routine ユーザーの週次のオフィス勤務ルーチン。

    予定されているオフィスへの出席を示す各曜日のブールフラグが含まれています。ユーザーがその日オフィスに出社する予定がある場合は true が表示され、出席が予定されていない場合は false を表示します。

    データタイプ: オブジェクト

    "routine": { 
  "monday": "Boolean", 
  "tuesday": "Boolean",
  "wednesday": "Boolean", 
  "thursday": "Boolean",
  "friday": "Boolean", 
  "saturday": "Boolean", 
  "sunday": "Boolean"
}

    cURL 要求

    この例では、月曜日から木曜日までの毎週のオフィス勤務ルーチンを作成します。

    curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/routine" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username:password" \
--data '{
  "routine": {
    "monday": true, "tuesday": true, "wednesday": true,
    "thursday": true, "friday": false, "saturday": false, "sunday": false
  }
}'

    応答本文。

    {
  "result": {
    "message": "Routine created successfully",
    "result": {
      "routine": {
        "monday": true, 
        "tuesday": true, 
        "wednesday": true,
        "thursday": true, 
        "friday": false, 
        "saturday": false,
        "sunday": false
      }
    }
  }
}

    WSD プレゼンス:PUT /api/sn_wsd_concierge/v1/presence/exception

    既存のプレゼンスの例外をキャンセルして置換を作成することで更新します。元の例外は、そのsys_idによって識別されます。ユーザーが以前に作成した例外の詳細を変更する必要がある場合は、このエンドポイントを使用します。

    URL 形式

    バージョニングされた URL: /api/sn_wsd_concierge/{api_version}/presence/exception

    デフォルト URL: /api/sn_wsd_concierge/presence/exception

    サポートされている要求パラメーター

    表 : 61. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 62. クエリパラメーター
    名前 説明
    なし
    表 : 63. 要求本文パラメーター (XML または JSON)
    名前 説明
    例外 必須です。更新された詳細を含む例外オブジェクト。[ sys_id ] フィールドと [ in_office ] フィールドは必須です。

    データタイプ: オブジェクト

    "exception": { 
  "date": "String", 
  "in_office": "Boolean",
  "location": "String", 
  "origin": "String",
  "sys_id": "String"
}
    exception.date 例外の日付。

    形式:yyyy-MM-dd

    データタイプ：文字列
    exception.in_office 必須です。この日付にユーザーがオフィスにいるかどうかを示すフラグ。
    可能な値：
    • true:ユーザーはオフィスにいます。
    • false:ユーザーはオフィスにいません。

    データタイプ：ブーリアン
    exception.location この例外のオフィス所在地の名前または識別子。

    データタイプ：文字列
    exception.origin 例外のソース。
    有効な値：
    • ユーザー:従業員が手動で作成します。
    • システム:プラットフォームによって自動的に作成されます。
    • manual:アドミンまたはユーザーの代わりに作成されます。

    データタイプ：文字列

    デフォルト:ユーザー
    exception.sys_id 必須です。更新する既存の例外のSys_id。

    テーブル:従業員プレゼンスの例外 (sn_wsd_concierge_employee_presence_exception)

    データタイプ：文字列

    ヘッダー

    次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 64. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされているタイプ: application/json、 application/xml、または text/xml。
    認証 認証情報。ベーシック認証またはセッションベースの認証をサポートします。
    Content-Type 要求本文のデータ形式:application/json。
    表 : 65. 応答ヘッダー
    ヘッダー 説明
    Content-Type 応答本文のデータ形式:application/json。

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 66. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。必須フィールドのsys_idまたはin_officeがありません。
    404 見つかりません。指定された例外が見つからなかったか、ユーザーにそれを変更する権限がありません。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    result 要求の結果を含むオブジェクト。

    データタイプ: オブジェクト

    "result": {
    "message": "String",
    "result": {Object}
}
    result.message 例外が更新されたことを示す確認メッセージ。

    データタイプ：文字列
    result.result 更新された例外が含まれています。

    データタイプ: オブジェクト

    "result": {
  "exceptions": [Array]
}
    result.result.exceptions プレゼンスの例外のリスト。

    データタイプ：オブジェクトのアレイ

    "exceptions": [
 {
  "sys_id": "sys_id", 
  "date": "String", 
  "in_office": String, 
  "origin": "String", 
  "location": "String" 
 }
]
    result.result.exceptions.sys_id 例外レコードのSys_id。

    テーブル:従業員プレゼンスの例外 (sn_wsd_concierge_employee_presence_exception)

    データタイプ：文字列
    result.exceptions.date この例外が適用される日付 (yyyy-MM-dd 形式)。これは、ユーザーのルーチンが上書きされる日付です。

    データタイプ：文字列
    result.exceptions.in_office この日付にユーザーがオフィスにいるかどうかを示すフラグ。これにより、その曜日に指定されている週次ルーチンが上書きされます。
    有効な値：
    • true:ユーザーはオフィスにいます。
    • false:ユーザーはオフィスにいません

    データタイプ：文字列
    result.exceptions.origin 例外を作成したソース。
    有効な値：
    • ユーザー:従業員が手動で作成します。
    • システム:プラットフォームによって自動的に作成されます。
    • manual:アドミンまたはユーザーの代わりに作成されます。

    データタイプ：文字列
    result.exceptions.location この日付におけるユーザーのオフィス所在地の名前または識別子。in_officeが true の場合にのみ関連します。ユーザーがリモートの場合、空の文字列になることがあります。

    データタイプ：文字列

    cURL 要求

    この例では、既存の例外を更新して、同じ日付にユーザーのステータスをリモート (オフィスにいない) に変更します。

    curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/exception" \
--request PUT \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username:password" \
--data '{
  "exception": {
    "sys_id": "exc1a2b3c4d5e6",
    "in_office": false,
    "date": "2026-02-14",
    "location": "",
    "origin": "user"
  }
}'

    応答本文。

    {
  "result": {
    "message": "Exception updated successfully",
    "result": {
      "exceptions": [
        { "sys_id": "exc9k0l1m2n3o4", "date": "2026-02-14", "in_office": false, "origin": "user", "location": "" }
      ]
    }
  }
}