---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# WSD Shift API

# WSD Shift API {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：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` 名前空間で実行されます。

ワークプレイス予約管理の詳細については、「[ワークプレイス予約管理](https://www.servicenow.com/docs/access?context=workplace-rsv-mgmt-feat&version=xanadu&pubname=xanadu-employee-service-management&ft:locale=en-US)」を参照してください。

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

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

### URL 形式

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

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

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

{#wsd_shift-GET-timespan__entry__2}{#wsd_shift-GET-timespan__version-RESTAPI}

| 名前 | 説明 |
|-|-|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、<kbd class="ph userinput">v1</kbd> や <kbd class="ph userinput">v2</kbd>。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
| shift_id | タイムスパンを取得するシフトの sys_id。シフト \[sn_wsd_core_shift\] テーブルにあります。 シフトベースの予約の詳細については、「 [シフトベースの予約を有効にする](https://www.servicenow.com/docs/access?context=wsd-reservation-setup&version=xanadu&pubname=xanadu-employee-service-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 |
[表 : 1. パスパラメーター]

{#wsd_shift-GET-timespan__entry__8}

| 名前 | 説明 |
|-|-|
| attempt_earlier_start | 指定された開始値がシフトのタイムスパン内にある場合に、早い開始時間を設定するかどうかを示すフラグ。 有効な値： * true：指定されたシフトに start パラメーターで指定された日付/時刻が含まれている場合、指定された開始日時をタイムスパンの開始として返します。 * false：関連するレコードで定義されているシフトのタイムスパンを返します。 データタイプ：ブーリアン デフォルト値：false |
| start | 必須。返すシフトのタイムスパンの開始日時。 形式：UTC - yyyy-mm-ddThh:mm:ssZ (2022-05-23T08:00:00Z など) |
| timezone | シフトのタイムスパンを認定するときに使用するタイムゾーン (ECT や PST など)。このタイムゾーンでのシフトのタイムスパンも返します。 形式：UTC データタイプ：文字列 デフォルト：ユーザーのタイムゾーン |
[表 : 2. クエリパラメーター]

{#wsd_shift-GET-timespan__entry__16}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 3. 要求本文パラメーター]

### ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#wsd_shift-GET-timespan__entry__20}{#wsd_shift-GET-timespan__accept-reserv-entry}

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

{#wsd_shift-GET-timespan__entry__24}

| ヘッダー | 説明 |
|-|-|
| なし |   |
[表 : 5. 応答ヘッダー]

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#wsd_shift-GET-timespan__entry__28}{#wsd_shift-GET-timespan__entry-200-status-code}{#wsd_shift-GET-timespan__entry-401-status-code}{#wsd_shift-GET-timespan__entry-404-status-code}{#wsd_shift-GET-timespan__entry-500-status-code}

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

### 応答本文のパラメーター

{#wsd_shift-GET-timespan__entry__38}

| 名前 | 説明 |
|-|-|
| 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"
      }
    }