WSD Shift API

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：4分

    • ワークプレイスサービスデリバリ (WSD) Shift API は、指定された日時のシフトのタイムスパンを返すエンドポイントを提供します。

    この API にアクセスするには、問い合わせユーザーに sn_wsd_core.workplace_user ロールが必要であり、Workplace Safety Management (sn_wsd_core) と Workplace Reservation Management (sn_wsd_rsv) プラグインを有効にする必要があります。

    この API は sn_wsd_rsv 名前空間で実行されます。

    ワークプレイス予約管理の詳細については、「ワークプレイス予約管理」を参照してください。

    WSD Shift - GET /api/sn_wsd_rsv/wsd_shift/{shift_id}/timespan

    指定された日付/時刻とシフトのタイムスパンを返します。

    URL 形式

    バージョニングされた URL：/api/sn_wsd_rsv/{api_version}/wsd_shift/{shift_id}/timespan

    デフォルトの URL：/api/sn_wsd_rsv/wsd_shift/{shift_id}/timespan

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

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

    データタイプ：文字列
    shift_id タイムスパンを取得するシフトの sys_id。

    シフトベースの予約の詳細については、「 シフトベースの予約を有効にする」を参照してください。

    データタイプ：文字列

    テーブル:シフト [sn_wsd_core_shift]
    表 : 2. クエリパラメーター
    名前 説明
    attempt_earlier_start 指定された開始値がシフトのタイムスパン内にある場合に、早い開始時間を設定するかどうかを示すフラグ。
    有効な値：
    • true：指定されたシフトに start パラメーターで指定された日付/時刻が含まれている場合、指定された開始日時をタイムスパンの開始として返します。
    • false：関連するレコードで定義されているシフトのタイムスパンを返します。

    データタイプ：ブーリアン

    デフォルト値：false
    start 必須。返すシフトのタイムスパンの開始日時。

    形式：UTC - yyyy-mm-ddThh:mm:ssZ (2022-05-23T08:00:00Z など)
    timezone シフトのタイムスパンを認定するときに使用するタイムゾーン (ECT や PST など)。このタイムゾーンでのシフトのタイムスパンも返します。

    形式：UTC

    データタイプ：文字列

    デフォルト：ユーザーのタイムゾーン
    表 : 3. 要求本文パラメーター
    名前 説明
    なし

    ヘッダー

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

    表 : 4. 要求ヘッダー
    ヘッダー 説明
    承認 要求本文のデータ形式。サポートされるタイプ：application/json、application/xml、または text/xml。

    デフォルト： application/json
    表 : 5. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

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

    応答本文のパラメーター

    名前 説明
    result 検索条件に一致したシフトのタイムスパンに関する詳細。

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

    "result":{
  "end": "String",
  "start": "String"
}
    result.end 指定されたタイムゾーンでのシフトのタイムスパンの終了日時。

    形式：UTC：yyyy-mm-ddThh:mm:ssZ (2022-05-23T08:00:00Z など)

    データタイプ：文字列
    result.start 指定されたタイムゾーンでのシフトのタイムスパンの開始日時。

    形式：UTC：yyyy-mm-ddThh:mm:ssZ (2022-05-23T08:00:00Z など)

    データタイプ：文字列

    cURL 要求

    次のコード例は、シフトのタイムスパンを取得する方法を示しています。

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/wsd_shift/e5d23acfdb42a01097acc9003996193a/timespan?attempt_earlier_start=true&start=2022-05-23T08:00:00Z&timezone=ECT" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    返される結果：

    {
  "result": {
    "start": "2022-05-23T08:00:00Z",
    "end": "2022-05-23T15:00:00Z"
  }
}