---
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


---

# プッシュインストール API

# プッシュインストール API {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：6分

プッシュインストール API は、モバイルデバイスがアプリケーションからプッシュ通知を受信できるようにするトークンの登録および登録解除を行うためのエンドポイントを提供します。
プッシュ通知は、重要なことを知らせる、またはアクションの実行を要求する、ユーザーのモバイル端末に表示されるテキスト メッセージです。

カスタムモバイルアプリケーションを作成する場合、プッシュ通知を設定するには、デバイスをメーカーのサービスに登録する必要があります。サービスは、プッシュトークンを使用してそのデバイスに適切に通知を送信できるように、ユーザーのデバイスのアドレスを認識する必要があります。また、デバイスは通知を受信して対処できる必要があります。デバイスを登録してプッシュトークンを取得する方法については、デバイスのオペレーティングシステムの開発者向けドキュメントを参照してください。たとえば、Apple デバイスについては、次を参照してください：<https://developer.apple.com/documentation/usernotifications/registering_your_app_with_apns>

## プッシュインストール - POST /now/push/{pushApplicationName}/installation {#ariaid-title2}

デバイスが指定されたアプリケーションからプッシュ通知を受信できるようにするトークンを追加または更新します。

### URL 形式 {#push-POST-installation__section_x12_fqg_dmb}

バージョニングされた URL：/api/now/{api_version}/push/{pushApplicationName}/installation

デフォルトの URL：/api/now/push/{pushApplicationName}/installation

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

{#push-POST-installation__entry__2}{#push-POST-installation__version-RESTAPI}

| パラメーター | 説明 |
|-|-|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、<kbd class="ph userinput">v1</kbd> や <kbd class="ph userinput">v2</kbd>。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
| pushApplicationName | プッシュ通知を登録するアプリケーションの名前。このパラメーターは、プッシュアプリケーション \[sys_push_application\] テーブルの関連するアプリケーションの \[名前\] 列の値と同じである必要があります。 データタイプ：文字列 |
[表 : 1. パスパラメーター]

{#push-POST-installation__entry__8}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 2. クエリパラメーター]

{#push-POST-installation__entry__12}

| 要素 | 説明 |
|-|-|
| platform | プッシュ通知を登録するプラットフォーム。このパラメーターは、プッシュプラットフォーム \[sys_push_platform\] テーブルの \[名前\] 値である必要があります。 データタイプ：文字列 |
| token | プッシュ通知を受信できるようにモバイルアプリケーションを登録するときに、Apple などのデバイスメーカーによって提供されるトークン。エンドポイントは、トークン値をプッシュ通知インストール \[sys_push_notif_app_install\] テーブルに書き込みます。 データタイプ：文字列 |
[表 : 3. 要求本文パラメーター (XML または JSON)]

### ヘッダー

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

| ヘッダー | 説明 |
|-|-|
| Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 |
[表 : 4. 要求ヘッダー]

{#push-POST-installation__entry__22}

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

### ステータスコード

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

| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
| 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 |
| 500 | 内部サーバーエラー。サーバー側のコードで論理エラーが発生しました。 |
[表 : 6. ステータスコード]

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

{#push-POST-installation__entry__36}

| 名前 | 説明 |
|-|-|
| なし |   |
[ ]

### サンプル cURL 要求

    curl -X POST \
      https://instance.servicenow.com/api/now/push/ServiceNowPushApp/installation \
    --header "Content-Type: application/json" \
    --user "username":"password" \
    --data '{"platform":"Apple","token":"544836d77ac2e551bbf78204630509a7d494fc87f52e85da52e5b5d42910e2cf"}' \

    None

## プッシュインストール - POST /now/push/{pushApplicationName}/removeInstallation {#ariaid-title3}

モバイルデバイスが指定されたアプリケーションからプッシュ通知を受信できるようにするトークンを無効にします。

### URL 形式 {#push-POST-removeInstallation__section_uy3_drg_dmb}

バージョニングされた URL：/api/now/{api_version}/push/{pushApplicationName}/removeInstallation

デフォルトの URL：/api/now/push/{pushApplicationName}/removeInstallation

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

{#push-POST-removeInstallation__entry__2}{#push-POST-removeInstallation__version-RESTAPI}

| 名前 | 説明 |
|-|-|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、<kbd class="ph userinput">v1</kbd> や <kbd class="ph userinput">v2</kbd>。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
| pushApplicationName | プッシュ通知の登録を解除するアプリケーションの名前。このパラメーターは、プッシュアプリケーション \[sys_push_application\] テーブルの関連するアプリケーションの \[名前\] 列の値と同じである必要があります。 データタイプ：文字列 |
[表 : 7. パスパラメーター]

{#push-POST-removeInstallation__entry__8}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 8. クエリパラメーター]

{#push-POST-removeInstallation__entry__12}

| 要素 | 説明 |
|-|-|
| platform | プッシュ通知を登録するプラットフォーム。このパラメーターは、プッシュプラットフォーム \[sys_push_platform\] テーブルの \[名前\] 値である必要があります。 データタイプ：文字列 |
[表 : 9. 要求本文パラメーター (XML または JSON)]

### ヘッダー

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

| ヘッダー | 説明 |
|-|-|
| Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 |
[表 : 10. 要求ヘッダー]

{#push-POST-removeInstallation__entry__20}

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

### ステータスコード

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

| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
| 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 |
| 500 | 内部サーバーエラー。サーバー側のコードで論理エラーが発生しました。 |
[表 : 12. ステータスコード]

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

{#push-POST-removeInstallation__entry__34}

| 名前 | 説明 |
|-|-|
| なし |   |
[ ]

### サンプル cURL 要求

    curl -X POST \
      https://instance.servicenow.com/api/now/push/ServiceNowPushApp/removeInstallation \
    --header "Content-Type: application/json" \
    --user "username":"password" \
    --data '{"platform":"Apple"}' \

    None