デバイス ポータル コア API リファレンスDevice Portal core API reference

デバイス ポータルのすべての機能は、REST API の上に構築されています。開発者は REST API を直接呼び出して、プログラムからリソースにアクセスし、デバイスを制御することができます。All Device Portal functionality is built on REST APIs that developers can call directly to access resources and control their devices programmatically.

アプリの展開App deployment

アプリをインストールするInstall an app

申請Request

次の要求形式を使用して、アプリをインストールできます。You can install an app by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/app/packagemanager/package/api/app/packagemanager/package

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
packagepackage (必須) インストールするパッケージのファイル名。(required) The file name of the package to be installed.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • .appx または .appxbundle ファイル、およびアプリが必要とする依存関係。The .appx or .appxbundle file, as well as any dependencies the app requires.
  • デバイスが IoT または Windows デスクトップの場合、アプリの署名に使う証明書。The certificate used to sign the app, if the device is IoT or Windows Desktop. その他のプラットフォームでは、証明書は必要ありません。Other platforms do not require the certificate.

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 展開要求は受け入れられ、処理されています。Deploy request accepted and being processed
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

申請Request

次の要求形式を使用して、関連セットをインストールできます。You can install a related set by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/app/packagemanager/package/api/app/packagemanager/package

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
packagepackage (必須) インストールするパッケージのファイル名。(required) The file names of the packages to be installed.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • オプション パッケージをパラメーターとして指定するときは、"foo.appx.opt"、"bar.appxbundle.opt" などのようにパッケージのファイル名に ".opt" を追加します。Add ".opt" to the optional package file names when specifying them as a parameter, like so: "foo.appx.opt" or "bar.appxbundle.opt".
  • .appx または .appxbundle ファイル、およびアプリが必要とする依存関係。The .appx or .appxbundle file, as well as any dependencies the app requires.
  • デバイスが IoT または Windows デスクトップの場合、アプリの署名に使う証明書。The certificate used to sign the app, if the device is IoT or Windows Desktop. その他のプラットフォームでは、証明書は必要ありません。Other platforms do not require the certificate.

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 展開要求は受け入れられ、処理されています。Deploy request accepted and being processed
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

アプリをルース フォルダーに登録するRegister an app in a loose folder

申請Request

次の要求形式を使用して、アプリをルース フォルダーに登録できます。You can register an app in a loose folder by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/app/packagemanager/networkapp/api/app/packagemanager/networkapp

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

{
    "mainpackage" :
    {
        "networkshare" : "\\some\share\path",
        "username" : "optional_username",
        "password" : "optional_password"
    }
}

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 展開要求は受け入れられ、処理されています。Deploy request accepted and being processed
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

申請Request

次の要求形式を使用して、関連セットをルース フォルダーに登録できます。You can register a related set in loose folders by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/app/packagemanager/networkapp/api/app/packagemanager/networkapp

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

{
    "mainpackage" :
    {
        "networkshare" : "\\some\share\path",
        "username" : "optional_username",
        "password" : "optional_password"
    },
    "optionalpackages" :
    [
        {
            "networkshare" : "\\some\share\path2",
            "username" : "optional_username2",
            "password" : "optional_password2"
        },
        ...
    ]
}

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 展開要求は受け入れられ、処理されています。Deploy request accepted and being processed
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

アプリのインストール状態を取得するGet app installation status

申請Request

次の要求形式を使用して、現在進行中のアプリのインストールの状態を取得できます。You can get the status of an app installation that is currently in progress by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/app/packagemanager/state/api/app/packagemanager/state

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 最後の展開の結果The result of the last deployment
204204 インストールは実行中ですThe installation is running
404404 インストール操作は見つかりませんでしたNo installation action was found

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

アプリをアンインストールするUninstall an app

申請Request

次の要求形式を使用して、アプリをアンインストールできます。You can uninstall an app by using the following request format.

メソッドMethod 要求 URIRequest URI
DELETEDELETE /api/app/packagemanager/package/api/app/packagemanager/package

URI パラメーターURI parameters

URI パラメーターURI parameter 説明Description
packagepackage (必須) ターゲット アプリの PackageFullName (GET /api/app/packagemanager/packages から)(required) The PackageFullName (from GET /api/app/packagemanager/packages) of the target app

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

インストールされたアプリを取得するGet installed apps

申請Request

次の要求形式を使用して、システムにインストールされているアプリの一覧を取得できます。You can get a list of apps installed on the system by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/app/packagemanager/packages/api/app/packagemanager/packages

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、インストールされているパッケージの一覧と関連する詳細情報が含まれます。The response includes a list of installed packages with associated details. この応答のテンプレートは次のとおりです。The template for this response is as follows.

{"InstalledPackages": [
    {
        "Name": string,
        "PackageFamilyName": string,
        "PackageFullName": string,
        "PackageOrigin": int, (https://msdn.microsoft.com/en-us/library/windows/desktop/dn313167(v=vs.85).aspx)
        "PackageRelativeId": string,
        "Publisher": string,
        "Version": {
            "Build": int,
            "Major": int,
            "Minor": int,
            "Revision": int
     },
     "RegisteredUsers": [
     {
        "UserDisplayName": string,
        "UserSID": string
     },...
     ]
    },...
]}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

BluetoothBluetooth


コンピューターの Bluetooth 無線を取得するGet the Bluetooth radios on the machine

申請Request

次の要求形式を使用して、コンピューターにインストールされている Bluetooth 無線の一覧を取得できます。You can get a list of the Bluetooth radios that are installed on the machine by using the following request format. これは、同じ JSON データを使用して、WebSocket 接続にもアップグレードできます。This can be upgraded to a WebSocket connection as well, with the same JSON data.

メソッドMethod 要求 URIRequest URI
GETGET /api/bt/getradios/api/bt/getradios
GET/WebSocketGET/WebSocket /api/bt/getradios/api/bt/getradios

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、デバイスにアタッチされている Bluetooth 無線の JSON 配列が含まれます。The response includes a JSON array of Bluetooth radios attached to the device.

{"BluetoothRadios" : [
    {
        "BluetoothAddress" : int64,
        "DisplayName" : string,
        "HasUnknownUsbDevice" : boolean,
        "HasProblem" : boolean,
        "ID" : string,
        "ProblemCode" : int,
        "State" : string
    },...
]}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

Bluetooth 無線をオンまたはオフにします。Turn the Bluetooth radio on or off

申請Request

特定の Bluetooth 無線をオンまたはオフに設定します。Sets a specific Bluetooth radio to On or Off.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/bt/setradio/api/bt/setradio

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
IDID (必須) Bluetooth 無線のデバイス ID であり、base 64 でエンコードされている必要があります。(required) The device ID for the Bluetooth radio and must be base 64 encoded.
状態State (必須)これは、"On" または "Off"にすることができます。(required) This can be "On" or "Off".

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

ペアリングした Bluetooth デバイスの一覧を取得するGet a list of paired Bluetooth devices

申請Request

現在ペアリングされている Bluetooth デバイスの一覧を取得するには、次の要求形式を使用します。You can get a list of the currently paired Bluetooth devices by using the following request format. これは、同じ JSON データを使用して WebSocket 接続にアップグレードできます。This can be upgraded to a WebSocket connection with the same JSON data. WebSocket 接続の有効期間中は、デバイスの一覧が変更される可能性があります。During the lifetime of the WebSocket connection, the device list can change. 更新が行われるたびに、WebSocket 接続を介してデバイスの完全な一覧が送信されます。A complete list of devices will be sent over the WebSocket connection each time there is an update.

メソッドMethod 要求 URIRequest URI
GETGET /api/bt/getpaired/api/bt/getpaired
GET/WebSocketGET/WebSocket /api/bt/getpaired/api/bt/getpaired

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、現在ペアリングされている Bluetooth デバイスの JSON 配列が含まれています。The response includes a JSON array of Bluetooth devices that are currently paired.

{"PairedDevices": [
    {
        "Name" : string,
        "ID" : string,
        "AudioConnectionStatus" : string
    },...
]}

デバイスをこのシステムのオーディオに使用できる場合は、 Audioconnectionstatusフィールドが表示されます。The AudioConnectionStatus field will be present if the device can be used for audio on this system. (ポリシーとオプションのコンポーネントがこの影響を受ける可能性があります)。Audioconnectionstatusは、"Connected" または "Disconnected" になります。(Policies and optional components may affect this.) AudioConnectionStatus will be either "Connected" or "Disconnected".


利用可能な Bluetooth デバイスの一覧を取得するGet a list of available Bluetooth devices

申請Request

ペアリングに使用できる Bluetooth デバイスの一覧を取得するには、次の要求形式を使用します。You can get a list of the Bluetooth devices available for pairing by using the following request format. これは、同じ JSON データを使用して WebSocket 接続にアップグレードできます。This can be upgraded to a WebSocket connection with the same JSON data. WebSocket 接続の有効期間中は、デバイスの一覧が変更される可能性があります。During the lifetime of the WebSocket connection, the device list can change. 更新が行われるたびに、WebSocket 接続を介してデバイスの完全な一覧が送信されます。A complete list of devices will be sent over the WebSocket connection each time there is an update.

メソッドMethod 要求 URIRequest URI
GETGET /api/bt/getavailable/api/bt/getavailable
GET/WebSocketGET/WebSocket /api/bt/getavailable/api/bt/getavailable

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、現在ペアリングに使用できる Bluetooth デバイスの JSON 配列が含まれています。The response includes a JSON array of Bluetooth devices that are currently available for pairing.

{"AvailableDevices": [
    {
        "Name" : string,
        "ID" : string
    },...
]}

Bluetooth デバイスの接続Connect a Bluetooth device

申請Request

デバイスをこのシステムのオーディオに使用できる場合、はデバイスに接続します。Will connect to the device if the device can be used for audio on this system. (ポリシーとオプションのコンポーネントがこの影響を受ける可能性があります)。(Policies and optional components may affect this.)

メソッドMethod 要求 URIRequest URI
POSTPOST /apidevice/api/bt/connectdevice

URI パラメーターURI parameters

URI パラメーターURI parameter 説明Description
IDID (必須)Bluetooth デバイスのアソシエーションエンドポイント ID。 Base64 でエンコードされている必要があります。(required) The Association Endpoint ID for the Bluetooth device and must be Base64-encoded.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

Bluetooth デバイスの切断Disconnect a Bluetooth device

申請Request

デバイスをこのシステムのオーディオに使用できる場合は、デバイスが切断されます。Will disconnect the device if the device can be used for audio on this system. (ポリシーとオプションのコンポーネントがこの影響を受ける可能性があります)。(Policies and optional components may affect this.)

メソッドMethod 要求 URIRequest URI
POSTPOST //またはデバイスを切断する/api/bt/disconnectdevice

URI パラメーターURI parameters

URI パラメーターURI parameter 説明Description
IDID (必須)Bluetooth デバイスのアソシエーションエンドポイント ID。 Base64 でエンコードされている必要があります。(required) The Association Endpoint ID for the Bluetooth device and must be Base64-encoded.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

デバイス マネージャーDevice manager


コンピューターにインストールされているデバイスを取得するGet the installed devices on the machine

申請Request

次の要求形式を使用して、コンピューターにインストールされているデバイスの一覧を取得できます。You can get a list of devices that are installed on the machine by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/devicemanager/devices/api/devicemanager/devices

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、デバイスにアタッチされているデバイスの JSON 配列が含まれます。The response includes a JSON array of devices attached to the device.

{"DeviceList": [
    {
        "Class": string,
        "Description": string,
        "ID": string,
        "Manufacturer": string,
        "ParentID": string,
        "ProblemCode": int,
        "StatusCode": int
    },...
]}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • IoTIoT

接続された USB デバイス/ハブのデータを取得するGet data on connected USB Devices/Hubs

申請Request

次の要求形式を使用して、接続された USB デバイスおよびハブの USB 記述子の一覧を取得できます。You can get a list of USB descriptors for connected USB devices and Hubs by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /ext/devices/usbdevices/ext/devices/usbdevices

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答は、ハブの USB 記述子およびポート情報と共に、USB デバイスのデバイス ID が含まれる JSON です。The response is JSON that includes DeviceID for the USB Device along with the USB Descriptors and port information for hubs.

{
    "DeviceList": [
        {
        "ID": string,
        "ParentID": string, // Will equal an "ID" within the list, or be blank
        "Description": string, // optional
        "Manufacturer": string, // optional
        "ProblemCode": int, // optional
        "StatusCode": int // optional
        },
        ...
    ]
}

返されるデータのサンプルSample return data

{
    "DeviceList": [{
        "ID": "System",
        "ParentID": ""
    }, {
        "Class": "USB",
        "Description": "Texas Instruments USB 3.0 xHCI Host Controller",
        "ID": "PCI\\VEN_104C&DEV_8241&SUBSYS_1589103C&REV_02\\4&37085792&0&00E7",
        "Manufacturer": "Texas Instruments",
        "ParentID": "System",
        "ProblemCode": 0,
        "StatusCode": 25174026
    }, {
        "Class": "USB",
        "Description": "USB Composite Device",
        "DeviceDriverKey": "{36fc9e60-c465-11cf-8056-444553540000}\\0016",
        "ID": "USB\\VID_045E&PID_00DB\\8&2994096B&0&1",
        "Manufacturer": "(Standard USB Host Controller)",
        "ParentID": "USB\\VID_0557&PID_8021\\7&2E9A8711&0&4",
        "ProblemCode": 0,
        "StatusCode": 25182218
    }]
}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • IoTIoT

ダンプの収集Dump collection


アプリのすべてのクラッシュ ダンプの一覧を取得するGet the list of all crash dumps for apps

申請Request

次の要求形式を使用して、サイドローディングされたすべてのアプリについて、利用可能なすべてのクラッシュ ダンプの一覧を取得できます。You can get the list of all the available crash dumps for all sideloaded apps by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/debug/dump/usermode/dumps/api/debug/dump/usermode/dumps

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、サイドローディングされたアプリケーションごとにクラッシュ ダンプの一覧が含まれます。The response includes a list of crash dumps for each sideloaded application.

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Window Mobile (Windows Insider Program のみ)Window Mobile (in Windows Insider Program)
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

アプリのクラッシュ ダンプ収集設定を取得するGet the crash dump collection settings for an app

申請Request

次の要求形式を使用して、サイドローディングされたアプリのクラッシュ ダンプ収集設定を取得できます。You can get the crash dump collection settings for a sideloaded app by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/debug/dump/usermode/crashcontrol/api/debug/dump/usermode/crashcontrol

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
packageFullnamepackageFullname (必須) サイドローディングされたアプリのパッケージの完全な名前。(required) The full name of the package for the sideloaded app.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答は、次の形式になります。The response has the following format.

{"CrashDumpEnabled": bool}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Window Mobile (Windows Insider Program のみ)Window Mobile (in Windows Insider Program)
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

サイドローディングされたアプリのクラッシュ ダンプを削除するDelete a crash dump for a sideloaded app

申請Request

次の要求形式を使用して、サイドローディングされたアプリのクラッシュ ダンプを削除できます。You can delete a sideloaded app's crash dump by using the following request format.

メソッドMethod 要求 URIRequest URI
DELETEDELETE /api/debug/dump/usermode/crashdump/api/debug/dump/usermode/crashdump

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
packageFullnamepackageFullname (必須) サイドローディングされたアプリのパッケージの完全な名前。(required) The full name of the package for the sideloaded app.
fileNamefileName (必須) 削除する必要があるダンプ ファイルの名前。(required) The name of the dump file that should be deleted.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Window Mobile (Windows Insider Program のみ)Window Mobile (in Windows Insider Program)
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

サイドローディングされたアプリのクラッシュ ダンプを無効にするDisable crash dumps for a sideloaded app

申請Request

次の要求形式を使用して、サイドローディングされたアプリのクラッシュ ダンプを無効にすることができます。You can disable crash dumps for a sideloaded app by using the following request format.

メソッドMethod 要求 URIRequest URI
DELETEDELETE /api/debug/dump/usermode/crashcontrol/api/debug/dump/usermode/crashcontrol

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
packageFullnamepackageFullname (必須) サイドローディングされたアプリのパッケージの完全な名前。(required) The full name of the package for the sideloaded app.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Window Mobile (Windows Insider Program のみ)Window Mobile (in Windows Insider Program)
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

サイドローディングされたアプリのクラッシュ ダンプをダウンロードするDownload the crash dump for a sideloaded app

申請Request

次の要求形式を使用して、サイドローディングされたアプリのクラッシュ ダンプをダウンロードできます。You can download a sideloaded app's crash dump by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/debug/dump/usermode/crashdump/api/debug/dump/usermode/crashdump

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
packageFullnamepackageFullname (必須) サイドローディングされたアプリのパッケージの完全な名前。(required) The full name of the package for the sideloaded app.
fileNamefileName (必須) ダウンロードするダンプ ファイルの名前。(required) The name of the dump file that you want to download.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、ダンプ ファイルが含まれます。The response includes a dump file. WinDbg または Visual Studio を使用して、ダンプ ファイルを検証できます。You can use WinDbg or Visual Studio to examine the dump file.

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Window Mobile (Windows Insider Program のみ)Window Mobile (in Windows Insider Program)
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

サイドローディングされたアプリのクラッシュ ダンプを有効にするEnable crash dumps for a sideloaded app

申請Request

次の要求形式を使用して、サイドローディングされたアプリのクラッシュ ダンプを有効にすることができます。You can enable crash dumps for a sideloaded app by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/debug/dump/usermode/crashcontrol/api/debug/dump/usermode/crashcontrol

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
packageFullnamepackageFullname (必須) サイドローディングされたアプリのパッケージの完全な名前。(required) The full name of the package for the sideloaded app.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK

使用可能なデバイスファミリAvailable device families

  • Window Mobile (Windows Insider Program のみ)Window Mobile (in Windows Insider Program)
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

バグチェック ファイルの一覧を取得するGet the list of bugcheck files

申請Request

次の要求形式を使用して、バグチェックのミニダンプ ファイルの一覧を取得できます。You can get the list of bugcheck minidump files by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/debug/dump/kernel/dumplist/api/debug/dump/kernel/dumplist

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、ダンプ ファイル名とこれらのファイルのサイズの一覧が含まれます。The response includes a list of dump file names and the sizes of these files. 一覧は、次の形式になります。This list will be in the following format.

{"DumpFiles": [
    {
        "FileName": string,
        "FileSize": int
    },...
]}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • IoTIoT

バグチェックのダンプ ファイルをダウンロードするDownload a bugcheck dump file

申請Request

次の要求形式を使用して、バグチェックのダンプ ファイルをダウンロードできます。You can download a bugcheck dump file by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/debug/dump/kernel/dump/api/debug/dump/kernel/dump

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
<ファイル名>filename (必須) ダンプ ファイルのファイル名。(required) The file name of the dump file. API を使ってダンプの一覧を取得することによって確認できます。You can find this by using the API to get the dump list.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、ダンプ ファイルが含まれます。The response includes the dump file. WinDbg を使用してこのファイルを調べることができます。You can inspect this file using WinDbg.

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • IoTIoT

バグチェックのクラッシュ制御の設定を取得するGet the bugcheck crash control settings

申請Request

次の要求形式を使用して、バグチェックのクラッシュ制御の設定を取得できます。You can get the bugcheck crash control settings by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/debug/dump/kernel/crashcontrol/api/debug/dump/kernel/crashcontrol

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、クラッシュの制御の設定が含まれます。The response includes the crash control settings. CrashControl について詳しくは、「CrashControl」をご覧ください。For more information about CrashControl, see the CrashControl article. 応答のテンプレートは次のとおりです。The template for the response is as follows.

{
    "autoreboot": bool (0 or 1),
    "dumptype": int (0 to 4),
    "maxdumpcount": int,
    "overwrite": bool (0 or 1)
}

ダンプの種類Dump types

0: 無効0: Disabled

1: 完全メモリ ダンプ (使用中のすべてのメモリを収集)1: Complete memory dump (collects all in-use memory)

2: カーネル メモリ ダンプ (ユーザー モード メモリを無視)2: Kernel memory dump (ignores user mode memory)

3: 限られたカーネル ミニダンプ3: Limited kernel minidump

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • IoTIoT

ライブ カーネル ダンプを取得するGet a live kernel dump

申請Request

次の要求形式を使用して、ライブ カーネル ダンプを取得できます。You can get a live kernel dump by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/debug/dump/livekernel/api/debug/dump/livekernel

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、カーネル モードの完全なダンプが含まれます。The response includes the full kernel mode dump. WinDbg を使用してこのファイルを調べることができます。You can inspect this file using WinDbg.

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • IoTIoT

ライブ ユーザー プロセスからダンプを取得するGet a dump from a live user process

申請Request

次の要求形式を使用して、ライブ ユーザー プロセスのダンプを取得できます。You can get the dump for live user process by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/debug/dump/usermode/live/api/debug/dump/usermode/live

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
pidpid (必須) 目的のプロセスの一意のプロセス ID。(required) The unique process id for the process you are interested in.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、プロセス ダンプが含まれます。The response includes the process dump. WinDbg または Visual Studio を使用してこのファイルを調べることができます。You can inspect this file using WinDbg or Visual Studio.

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • IoTIoT

バグチェックのクラッシュ制御の設定を行うSet the bugcheck crash control settings

申請Request

次の要求形式を使用して、バグチェック データの収集に関する設定を行うことができます。You can set the settings for collecting bugcheck data by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/debug/dump/kernel/crashcontrol/api/debug/dump/kernel/crashcontrol

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
autorebootautoreboot (オプション) true または false。(optional) True or false. これは、エラーやロックの発生後に、システムが自動的に再起動するかどうかを示します。This indicates whether the system restarts automatically after it fails or locks.
dumptypedumptype (オプション) dump タイプ。(optional) The dump type. サポートされる値については、「CrashDumpType 列挙体」をご覧ください。For the supported values, see the CrashDumpType Enumeration.
maxdumpcountmaxdumpcount (オプション) 保存するダンプの最大数。(optional) The maximum number of dumps to save.
overwriteoverwrite (オプション) true または false。(optional) True of false. これは、maxdumpcountで指定されているダンプ カウンターの制限に達した場合に古いダンプを上書きするかどうかを示します。This indicates whether or not to overwrite old dumps when the dump counter limit specified by maxdumpcount has been reached.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • IoTIoT

ETWETW


websocket 経由でリアルタイムの ETW セッションを作成するCreate a realtime ETW session over a websocket

申請Request

次の要求形式を使用して、リアルタイムの ETW セッションを作成できます。You can create a realtime ETW session by using the following request format. これは、websocket 経由で管理されます。This will be managed over a websocket. ETW イベントは、サーバーで一括処理され、1 秒に 1 回クライアントに送信されます。ETW events are batched on the server and sent to the client once per second.

メソッドMethod 要求 URIRequest URI
GET/WebSocketGET/WebSocket /api/etw/session/realtime/api/etw/session/realtime

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、有効なプロバイダーの ETW イベントが含まれます。The response includes the ETW events from the enabled providers. 以下の「ETW WebSocket コマンド」をご覧ください。See ETW WebSocket commands below.

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

ETW WebSocket コマンドETW WebSocket commands

次のコマンドは、クライアントからサーバーに送信されます。These commands are sent from the client to the server.

コマンドCommand 説明Description
provider {guid} enable {level}provider {guid} enable {level} {guid} で指定されたプロバイダー (括弧は不要) を指定されたレベルで有効にします。Enable the provider marked by {guid} (without brackets) at the specified level. {level} は、1 (最小限の詳細) ~ 5 (詳細) の int です。{level} is an int from 1 (least detail) to 5 (verbose).
provider {guid} disableprovider {guid} disable {guid} で指定されたプロバイダー (括弧は不要) を無効にします。Disable the provider marked by {guid} (without brackets).

この応答は、サーバーからクライアントに送信されます。This responses is sent from the server to the client. これは、テキストとして送信され、JSON で解析すると次の形式になります。This is sent as text and you get the following format by parsing the JSON.

{
    "Events":[
        {
            "Timestamp": int,
            "ProviderName": string,
            "ID": int, 
            "TaskName": string,
            "Keyword": int,
            "Level": int,
            payload objects...
        },...
    ],
    "Frequency": int
}

payload objects は、追加のキーと値のペア (文字列: 文字列) で、元の ETW イベントから提供されます。Payload objects are extra key-value pairs (string:string) that are provided in the original ETW event.

以下に例を示します。Example:

{
    "ID" : 42, 
    "Keyword" : 9223372036854775824, 
    "Level" : 4, 
    "Message" : "UDPv4: 412 bytes transmitted from 10.81.128.148:510 to 132.215.243.34:510. ",
    "PID" : "1218", 
    "ProviderName" : "Microsoft-Windows-Kernel-Network", 
    "TaskName" : "KERNEL_NETWORK_TASK_UDPIP", 
    "Timestamp" : 131039401761757686, 
    "connid" : "0", 
    "daddr" : "132.245.243.34", 
    "dport" : "500", 
    "saddr" : "10.82.128.118", 
    "seqnum" : "0", 
    "size" : "412", 
    "sport" : "500"
}

登録済みの ETW プロバイダーを列挙するEnumerate the registered ETW providers

申請Request

次の要求形式を使用して、登録済みプロバイダーを列挙できます。You can enumerate through the registered providers by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/etw/providers/api/etw/providers

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、ETW プロバイダーの一覧が含まれます。The response includes the list of ETW providers. 一覧には、各プロバイダーのフレンドリ名と GUID が次の形式で含まれます。The list will include the friendly name and GUID for each provider in the following format.

{"Providers": [
    {
        "GUID": string, (GUID)
        "Name": string
    },...
]}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

プラットフォームによって公開されているカスタム ETW プロバイダーを列挙します。Enumerate the custom ETW providers exposed by the platform.

申請Request

次の要求形式を使用して、登録済みプロバイダーを列挙できます。You can enumerate through the registered providers by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/etw/customproviders/api/etw/customproviders

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

200 OK。200 OK. 応答には、ETW プロバイダーの一覧が含まれます。The response includes the list of ETW providers. 一覧には、各プロバイダーのフレンドリ名と GUID が含まれます。The list will include the friendly name and GUID for each provider.

{"Providers": [
    {
        "GUID": string, (GUID)
        "Name": string
    },...
]}

状態コードStatus code

  • 標準の状態コード。Standard status codes.

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

LocationLocation


場所の上書きモードを取得するGet location override mode

申請Request

次の要求型式を使用して、デバイスの場所スタック上書き状態を取得できます。You can get the device's location stack override status by using the following request format. この呼び出しを成功させるには、開発者モードを有効にしておく必要があります。Developer mode must be on for this call to succeed.

メソッドMethod 要求 URIRequest URI
GETGET /ext/location/override/ext/location/override

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、デバイスの上書き状態が次の形式で含まれます。The response includes the override state of the device in the following format.

{"Override" : bool}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

場所の上書きモードを設定するSet location override mode

申請Request

次の要求型式を使用して、デバイスの場所スタック上書き状態を設定できます。You can set the device's location stack override status by using the following request format. 有効になっている場合は、場所スタックによって位置挿入が許可されます。When enabled, the location stack allows position injection. この呼び出しを成功させるには、開発者モードを有効にしておく必要があります。Developer mode must be on for this call to succeed.

メソッドMethod 要求 URIRequest URI
PUTPUT /ext/location/override/ext/location/override

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

{"Override" : bool}

応答Response

応答には、デバイスに設定されている上書き状態が次の形式で含まれます。The response includes the override state that the device has been set to in the following format.

{"Override" : bool}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

挿入された位置を取得するGet the injected position

申請Request

次の要求型式を使用して、デバイスの挿入 (スプーフィング) された場所を取得できます。You can get the device's injected (spoofed) location by using the following request format. 挿入された場所を設定する必要があります。設定されなかった場合は、エラーがスローされます。An injected location must be set, or an error will be thrown.

メソッドMethod 要求 URIRequest URI
GETGET /ext/location/position/ext/location/position

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、現在の挿入された緯度と経度の値が次の形式で含まれます。The response includes the current injected latitude and longitude values in the following format.

{
    "Latitude" : double,
    "Longitude" : double
}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

挿入された位置を設定するSet the injected position

申請Request

次の要求型式を使用して、デバイスの挿入 (スプーフィング) された場所を設定できます。You can set the device's injected (spoofed) location by using the following request format. あらかじめデバイス上で場所の上書きモードが有効になっており、設定される場所も有効である必要があります。それ以外の場合はエラーがスローされます。Location override mode must first be enabled on the device, and the set location must be a valid location or an error will be thrown.

メソッドMethod 要求 URIRequest URI
PUTPUT /ext/location/override/ext/location/override

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

{
    "Latitude" : double,
    "Longitude" : double
}

応答Response

応答には、設定された場所の情報が次の形式で含まれます。The response includes the location that has been set in the following format.

{
    "Latitude" : double,
    "Longitude" : double
}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

OS 情報OS information


コンピューター名を取得するGet the machine name

申請Request

次の要求形式を使用して、コンピューターの名前を取得できます。You can get the name of a machine by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/os/machinename/api/os/machinename

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、コンピューター名が次の形式で含まれます。The response includes the computer name in the following format.

{"ComputerName": string}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

オペレーティング システムの情報を取得するGet the operating system information

申請Request

次の要求形式を使用して、コンピューターの OS 情報を取得できます。You can get the OS information for a machine by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/os/info/api/os/info

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、OS 情報が次の形式で含まれます。The response includes the OS information in the following format.

{
    "ComputerName": string,
    "OsEdition": string,
    "OsEditionId": int,
    "OsVersion": string,
    "Platform": string
}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

デバイス ファミリを取得するGet the device family

申請Request

次の要求形式を使用して、デバイス ファミリ (Xbox、携帯電話、デスクトップなど) を取得できます。You can get the device family (Xbox, phone, desktop, etc) using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/os/devicefamily/api/os/devicefamily

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、デバイス ファミリ (SKU - デスクトップ、Xbox など) が含まれます。The response includes the device family (SKU - Desktop, Xbox, etc).

{
   "DeviceType" : string
}

DeviceType は、"Windows.Xbox"、"Windows.Desktop" などのようになります。DeviceType will look like "Windows.Xbox", "Windows.Desktop", etc.

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

コンピューター名を設定するSet the machine name

申請Request

次の要求形式を使用して、コンピューターの名前を設定できます。You can set the name of a machine by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/os/machinename/api/os/machinename

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
namename (必須) コンピューターの新しい名前。(required) The new name for the machine.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

ユーザー情報User information


アクティブ ユーザーを取得するGet the active user

申請Request

次の要求形式を使用して、デバイスのアクティブ ユーザーの名前を取得できます。You can get the name of the active user on the device by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/users/activeuser/api/users/activeuser

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、ユーザー情報が次の形式で含まれます。The response includes user information in the following format.

成功した場合:On success:

{
    "UserDisplayName" : string, 
    "UserSID" : string
}

失敗した場合:On failure:

{
    "Code" : int, 
    "CodeText" : string, 
    "Reason" : string, 
    "Success" : bool
}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

パフォーマンス データPerformance data


実行中のプロセスの一覧を取得するGet the list of running processes

申請Request

次の要求形式を使用して、現在実行中のプロセスの一覧を取得できます。You can get the list of currently running processes by using the following request format. これは、WebSocket 接続にアップグレードすることもでき、1 秒に 1 度クライアントにプッシュされる同じ JSON データを取得できます。this can be upgraded to a WebSocket connection as well, with the same JSON data being pushed to the client once per second.

メソッドMethod 要求 URIRequest URI
GETGET /api/resourcemanager/processes/api/resourcemanager/processes
GET/WebSocketGET/WebSocket /api/resourcemanager/processes/api/resourcemanager/processes

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、プロセスの一覧と各プロセスの詳細情報が含まれます。The response includes a list of processes with details for each process. 情報は JSON 形式で、テンプレートは次のとおりです。The information is in JSON format and has the following template.

{"Processes": [
    {
        "CPUUsage": float,
        "ImageName": string,
        "PageFileUsage": long,
        "PrivateWorkingSet": long,
        "ProcessId": int,
        "SessionId": int,
        "UserName": string,
        "VirtualSize": long,
        "WorkingSetSize": long
    },...
]}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

システム パフォーマンスの統計情報を取得するGet the system performance statistics

申請Request

次の要求形式を使用して、システム パフォーマンスの統計情報を取得できます。You can get the system performance statistics by using the following request format. これには、読み取りと書き込みのサイクルや、使用されているメモリの量などの情報が含まれます。This includes information such as read and write cycles and how much memory has been used.

メソッドMethod 要求 URIRequest URI
GETGET /api/resourcemanager/systemperf/api/resourcemanager/systemperf
GET/WebSocketGET/WebSocket /api/resourcemanager/systemperf/api/resourcemanager/systemperf

これは、WebSocket 接続にアップグレードできます。This can also be upgraded to a WebSocket connection. 1 秒に 1 度以下と同じ JSON データが提供されます。It provides the same JSON data below once every second.

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、CPU と GPU の使用量、メモリ アクセス、ネットワーク アクセスなど、パフォーマンスの統計情報が含まれます。The response includes the performance statistics for the system such as CPU and GPU usage, memory access, and network access. この情報は JSON 形式で、テンプレートは次のとおりです。This information is in JSON format and has the following template.

{
    "AvailablePages": int,
    "CommitLimit": int,
    "CommittedPages": int,
    "CpuLoad": int,
    "IOOtherSpeed": int,
    "IOReadSpeed": int,
    "IOWriteSpeed": int,
    "NonPagedPoolPages": int,
    "PageSize": int,
    "PagedPoolPages": int,
    "TotalInstalledInKb": int,
    "TotalPages": int,
    "GPUData": 
    {
        "AvailableAdapters": [{ (One per detected adapter)
            "DedicatedMemory": int,
            "DedicatedMemoryUsed": int,
            "Description": string,
            "SystemMemory": int,
            "SystemMemoryUsed": int,
            "EnginesUtilization": [ float,... (One per detected engine)]
        },...
    ]},
    "NetworkingData": {
        "NetworkInBytes": int,
        "NetworkOutBytes": int
    }
}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

PowerPower


現在のバッテリ状態を取得するGet the current battery state

申請Request

次の要求形式を使用して、バッテリの現在の状態を取得できます。You can get the current state of the battery by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/power/battery/api/power/battery

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

現在のバッテリ状態に関する情報が次の形式で返されます。The current battery state information is returned using the following format.

{
    "AcOnline": int (0 | 1),
    "BatteryPresent": int (0 | 1),
    "Charging": int (0 | 1),
    "DefaultAlert1": int,
    "DefaultAlert2": int,
    "EstimatedTime": int,
    "MaximumCapacity": int,
    "RemainingCapacity": int
}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

アクティブな電源設定を取得するGet the active power scheme

申請Request

次の要求形式を使用して、アクティブな電源設定を取得できます。You can get the active power scheme by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/power/activecfg/api/power/activecfg

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

アクティブな電源設定の形式は、次のとおりです。The active power scheme has the following format.

{"ActivePowerScheme": string (guid of scheme)}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • IoTIoT

電源設定のサブ値を取得するGet the sub-value for a power scheme

申請Request

次の要求形式を使用して、電源設定のサブ値を取得できます。You can get the sub-value for a power scheme by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/power/cfg/ /api/power/cfg/

オプション:Options:

  • SCHEME_CURRENTSCHEME_CURRENT

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

利用可能な電源状態の完全な一覧は、アプリケーションごとが基本で、バッテリ低下、重要なバッテリといったさまざまな電源状態がフラグ設定されています。A full listing of power states available is on a per-application basis and the settings for flagging various power states like low and critical batterty.

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • IoTIoT

システムの電源状態を取得するGet the power state of the system

申請Request

次の要求形式を使用して、システムの電源状態を確認できます。You can check the power state of the system by using the following request format. これによって、低電力状態になっているかどうかを確認できます。This will let you check to see if it is in a low power state.

メソッドMethod 要求 URIRequest URI
GETGET /api/power/state/api/power/state

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

電源状態の情報のテンプレートは次のとおりです。The power state information has the following template.

{"LowPowerState" : false, "LowPowerStateAvailable" : true }

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

アクティブな電源設定を行うSet the active power scheme

申請Request

次の要求形式を使用して、アクティブな電源設定を設定できます。You can set the active power scheme by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/power/activecfg/api/power/activecfg

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
schemescheme (必須) システムのアクティブな電源設定として設定するスキームの GUID。(required) The GUID of the scheme you want to set as the active power scheme for the system.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • IoTIoT

電源設定のサブ値を設定するSet the sub-value for a power scheme

申請Request

次の要求形式を使用して、電源設定のサブ値を設定できます。You can set the sub-value for a power scheme by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/power/cfg/ /api/power/cfg/

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
valueACvalueAC (必須) AC 電源に使用する値。(required) The value to use for A/C power.
valueDCvalueDC (必須) バッテリ電源に使用する値。(required) The value to use for battery power.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • IoTIoT

SleepStudy レポートを取得するGet a sleep study report

申請Request

メソッドMethod 要求 URIRequest URI
GETGET /api/power/sleepstudy/report/api/power/sleepstudy/report

次の要求形式を使用して、SleepStudy レポートを取得できます。You can get a sleep study report by using the following request format.

URI パラメーターURI parameters | URI パラメーターURI parameter | 説明Description | | :------ | :------ | | FileNameFileName | (必須) ダウンロードするファイルの完全な名前。(required) The full name for the file you want to download. この値は、hex64 エンコードされている必要があります。This value should be hex64 encoded. |

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答は、スリープ検査の結果が含まれているファイルです。The response is a file containing the sleep study.

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • IoTIoT

利用可能な SleepStudy レポートを列挙するEnumerate the available sleep study reports

申請Request

次の要求形式を使用して、利用可能な SleepStudy レポートを列挙できます。You can enumerate the available sleep study reports by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/power/sleepstudy/reports/api/power/sleepstudy/reports

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

利用可能なレポートの一覧のテンプレートは次のとおりです。The list of available reports has the following template.

{"Reports": [
    {
        "FileName": string
    },...
]}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • IoTIoT

スリープ スタディ変換を取得するGet the sleep study transform

申請Request

次の要求形式を使用して、スリープ スタディ変換を取得できます。You can get the sleep study transform by using the following request format. この変換は、SleepStudy レポートを、ユーザーが読み取ることができる XML 形式に変換する XSLT です。This transform is an XSLT that converts the sleep study report into an XML format that can be read by a person.

メソッドMethod 要求 URIRequest URI
GETGET /api/power/sleepstudy/transform/api/power/sleepstudy/transform

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、スリープ スタディ変換が含まれます。The response contains the sleep study transform.

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • IoTIoT

リモコンRemote control


ターゲット コンピューターを再起動するRestart the target computer

申請Request

次の要求形式を使用して、ターゲット コンピューターを再起動できます。You can restart the target computer by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/control/restart/api/control/restart

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

ターゲット コンピューターをシャットダウンするShut down the target computer

申請Request

次の要求形式を使用して、ターゲット コンピューターをシャット ダウンできます。You can shut down the target computer by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/control/shutdown/api/control/shutdown

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

タスク マネージャーTask manager


最新のアプリを起動するStart a modern app

申請Request

次の要求形式を使用して、最新のアプリを起動できます。You can start a modern app by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/taskmanager/app/api/taskmanager/app

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
appidappid (必須) 起動するアプリの PRAID。(required) The PRAID for the app you want to start. この値は、hex64 エンコードされている必要があります。This value should be hex64 encoded.
packagepackage (必須) 起動するアプリ パッケージの完全な名前。(required) The full name for the app package you want to start. この値は、hex64 エンコードされている必要があります。This value should be hex64 encoded.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

最新のアプリを停止するStop a modern app

申請Request

次の要求形式を使用して、最新のアプリを停止できます。You can stop a modern app by using the following request format.

メソッドMethod 要求 URIRequest URI
DELETEDELETE /api/taskmanager/app/api/taskmanager/app

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
packagepackage (必須) 停止するアプリ パッケージの完全な名前。(required) The full name of the app packages that you want to stop. この値は、hex64 エンコードされている必要があります。This value should be hex64 encoded.
forcestopforcestop (オプション) 値が yes の場合は、システムがすべてのプロセスを強制的に停止することを示します。(optional) A value of yes indicates that the system should force all processes to stop.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

PID でプロセスを強制終了するKill process by PID

申請Request

次の要求形式を使用して、プロセスを強制終了できます。You can kill a process by using the following request format.

メソッドMethod 要求 URIRequest URI
DELETEDELETE /api/taskmanager/process/api/taskmanager/process

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
pidpid (必須) 終了するプロセスの一意のプロセス ID。(required) The unique process id for the process to stop.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

ネットワークNetworking


現在の IP 構成を取得するGet the current IP configuration

申請Request

次の要求形式を使用して、現在の IP 構成を取得できます。You can get the current IP configuration by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/networking/ipconfig/api/networking/ipconfig

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

応答には、次のテンプレートの IP 構成が含まれます。The response includes the IP configuration in the following template.

{"Adapters": [
    {
        "Description": string,
        "HardwareAddress": string,
        "Index": int,
        "Name": string,
        "Type": string,
        "DHCP": {
            "LeaseExpires": int, (timestamp)
            "LeaseObtained": int, (timestamp)
            "Address": {
                "IpAddress": string,
                "Mask": string
            }
        },
        "WINS": {(WINS is optional)
            "Primary": {
                "IpAddress": string,
                "Mask": string
            },
            "Secondary": {
                "IpAddress": string,
                "Mask": string
            }
        },
        "Gateways": [{ (always 1+)
            "IpAddress": "10.82.128.1",
            "Mask": "255.255.255.255"
            },...
        ],
        "IpAddresses": [{ (always 1+)
            "IpAddress": "10.82.128.148",
            "Mask": "255.255.255.0"
            },...
        ]
    },...
]}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

静的 IP アドレスを設定する (IPV4 構成)Set a static IP address (IPV4 configuration)

申請Request

静的 IP と DNS を使用して IPV4 構成を設定します。Sets the IPV4 configuration with static IP and DNS. 静的 IP が指定されていない場合は、DHCP が有効になります。If a static IP is not specified, then it enables DHCP. 静的 IP を指定する場合は、DNS も指定する必要があります。If a static IP is specified, then DNS must be specified also.

メソッドMethod 要求 URIRequest URI
PUTPUT /api/networking/ipv4config/api/networking/ipv4config

URI パラメーターURI parameters

URI パラメーターURI parameter 説明Description
AdapterNameAdapterName (必須)ネットワークインターフェイスの GUID。(required) The network interface GUID.
IPAddressIPAddress 設定する静的 IP アドレス。The static IP address to set.
ネットSubnetMask ( IPAddressが null でない場合は必須)静的サブネットマスク。(required if IPAddress is not null) The static subnet mask.
DefaultGatewayDefaultGateway ( IPAddressが null でない場合は必須)静的なデフォルトゲートウェイ。(required if IPAddress is not null) The static default gateway.
PrimaryDNSPrimaryDNS ( IPAddressが null でない場合は必須)設定する静的プライマリ DNS。(required if IPAddress is not null) The static primary DNS to set.
セカンダリ DnsSecondayDNS ( Primarydnsが null でない場合は必須)設定する静的セカンダリ DNS。(required if PrimaryDNS is not null) The static secondary DNS to set.

わかりやすくするために、インターフェイスを DHCP に設定するには、ネットワーク上の AdapterName のみをシリアル化します。For clarity, to set an interface to DHCP, serialize just the AdapterName on the wire:

{
    "AdapterName":"{82F86C1B-2BAE-41E3-B08D-786CA44FEED7}"
}

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

ワイヤレス ネットワーク インターフェイスを列挙するEnumerate wireless network interfaces

申請Request

次の要求形式を使用して、利用可能なワイヤレス ネットワーク インターフェイスを列挙できます。You can enumerate the available wireless network interfaces by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/wifi/interfaces/api/wifi/interfaces

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

次の形式の利用可能なワイヤレス インターフェイスと詳細の一覧。A list of the available wireless interfaces with details in the following format.

{"Interfaces": [{
    "Description": string,
    "GUID": string (guid with curly brackets),
    "Index": int,
    "ProfilesList": [
        {
            "GroupPolicyProfile": bool,
            "Name": string, (Network currently connected to)
            "PerUserProfile": bool
        },...
    ]
    }
]}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

ワイヤレス ネットワークを列挙するEnumerate wireless networks

申請Request

次の要求形式を使用して、指定されたインターフェイスのワイヤレス ネットワークの一覧を列挙できます。You can enumerate the list of wireless networks on the specified interface by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/wifi/networks/api/wifi/networks

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
インターフェイスinterface (必須) ワイヤレス ネットワークの検索に使用するネットワーク インターフェイスの GUID (括弧は不要)。(required) The GUID for the network interface to use to search for wireless networks, without brackets.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

指定されたインターフェイスで見つかったワイヤレス ネットワークの一覧。The list of wireless networks found on the provided interface. これには、ネットワークの詳細が次の形式で含まれます。This includes details for the networks in the following format.

{"AvailableNetworks": [
    {
        "AlreadyConnected": bool,
        "AuthenticationAlgorithm": string, (WPA2, etc)
        "Channel": int,
        "CipherAlgorithm": string, (for example, AES)
        "Connectable": int, (0 | 1)
        "InfrastructureType": string,
        "ProfileAvailable": bool,
        "ProfileName": string,
        "SSID": string,
        "SecurityEnabled": int, (0 | 1)
        "SignalQuality": int,
        "BSSID": [int,...],
        "PhysicalTypes": [string,...]
    },...
]}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

Wi-Fi ネットワークを接続および切断するConnect and disconnect to a Wi-Fi network.

申請Request

次の要求形式を使用して、Wi-Fi ネットワークを接続および切断できます。You can connect or disconnect to a Wi-Fi network by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/wifi/network/api/wifi/network

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
インターフェイスinterface (必須) ネットワークへの接続に使用するネットワーク インターフェイスの GUID。(required) The GUID for the network interface you use to connect to the network.
opop (必須) 実行するアクションを示します。(required) Indicates the action to take. 設定可能な値は、connect または disconnect です。Possible values are connect or disconnect.
ssidssid ( op == connect の場合は必須) 接続先 SSID。(required if op == connect) The SSID to connect to.
keykey ( op == connect で、ネットワークで認証が必要な場合は必須) 共有キー。(required if op == connect and network requires authentication) The shared key.
createprofilecreateprofile (必要) デバイスでネットワークのプロファイルを作成します。(required) Create a profile for the network on the device. これにより、今後、デバイスはネットワークに自動接続されます。This will cause the device to auto-connect to the network in the future. yes または no を指定できます。This can be yes or no.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

Wi-Fi のプロファイルを削除するDelete a Wi-Fi profile

申請Request

次の要求形式を使用して、特定のインターフェイス上のネットワークに関連付けられたプロファイルを削除できます。You can delete a profile associated with a network on a specific interface by using the following request format.

メソッドMethod 要求 URIRequest URI
DELETEDELETE /api/wifi/profile/api/wifi/profile

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
インターフェイスinterface (必須) 削除するプロファイルに関連付けられたネットワーク インターフェイスの GUID。(required) The GUID for the network interface associated with the profile to delete.
プロファイルprofile (必須) 削除するプロファイルの名前。(required) The name of the profile to delete.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

Windows エラー報告 (WER)Windows Error Reporting (WER)


Windows エラー報告 (WER) ファイルをダウンロードするDownload a Windows error reporting (WER) file

申請Request

次の要求形式を使用して、WER 関連のファイルをダウンロードできます。You can download a WER-related file by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/wer/report/file/api/wer/report/file

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
ユーザーuser (必須) レポートに関連付けられたユーザー名。(required) The user name associated with the report.
typetype (必須) レポートの種類。(required) The type of report. これは queried または archived のいずれかになります。This can be either queried or archived.
namename (必須) レポートの名前。(required) The name of the report. base64 でエンコードされている必要があります。This should be base64 encoded.
ファイルfile (必須) レポートからダウンロードするファイルの名前。(required) The name of the file to download from the report. base64 でエンコードされている必要があります。This should be base64 encoded.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • 応答には、要求したファイルが含まれています。Response contains the requested file.

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

Windows エラー報告 (WER) レポート内のファイルを列挙するEnumerate files in a Windows error reporting (WER) report

申請Request

次の要求形式を使用して、WER レポート内のファイルを列挙できます。You can enumerate the files in a WER report by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/wer/report/files/api/wer/report/files

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
ユーザーuser (必須) レポートに関連付けられたユーザー。(required) The user associated with the report.
typetype (必須) レポートの種類。(required) The type of report. これは queried または archived のいずれかになります。This can be either queried or archived.
namename (必須) レポートの名前。(required) The name of the report. base64 でエンコードされている必要があります。This should be base64 encoded.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

{"Files": [
    {
        "Name": string, (Filename, not base64 encoded)
        "Size": int (bytes)
    },...
]}

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

Windows エラー報告 (WER) レポートを一覧表示するList the Windows error reporting (WER) reports

申請Request

次の要求形式を使用して、WER レポートを取得できます。You can get the WER reports by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/wer/reports/api/wer/reports

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

WER 報告の形式は次のとおりです。The WER reports in the following format.

{"WerReports": [
    {
        "User": string,
        "Reports": [
            {
                "CreationTime": int,
                "Name": string, (not base64 encoded)
                "Type": string ("Queue" or "Archive")
            },
    },...
]}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

Windows Performance Recorder (WPR)Windows Performance Recorder (WPR)


カスタム プロファイルを使用してトレースを開始するStart tracing with a custom profile

申請Request

次の要求形式を使用して、WPR プロファイルをアップロードし、そのプロファイルを使用してトレースを開始できます。You can upload a WPR profile and start tracing using that profile by using the following request format. 一度に実行できるトレースは 1 つのみです。Only one trace can run at a time. プロファイルはデバイス上に残りません。The profile will not remain on the device.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/wpr/customtrace/api/wpr/customtrace

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • カスタム WPR プロファイルが含まれる、原則に従ったマルチパートの http 本文。A multi-part conforming http body that contains the custom WPR profile.

応答Response

WPR セッション状態の形式は次のとおりです。The WPR session status in the following format.

{
    "SessionType": string, (Running or Idle) 
    "State": string (normal or boot)
}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

起動パフォーマンス トレース セッションを開始するStart a boot performance tracing session

申請Request

次の要求形式を使用して、WPR の起動トレース セッションを開始できます。You can start a boot WPR tracing session by using the following request format. これは、パフォーマンス トレース セッションとも呼びます。This is also known as a performance tracing session.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/wpr/boottrace/api/wpr/boottrace

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
プロファイルprofile (必須) このパラメーターは起動時に必要です。(required) This parameter is required on start. パフォーマンス トレース セッションを開始する必要があるプロファイルの名前。The name of the profile that should start a performance tracing session. 指定可能なプロファイルは、perfprofiles/profiles.json に格納されています。The possible profiles are stored in perfprofiles/profiles.json.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

この API は、開始時に次の形式で WPR セッション状態を返します。On start, this API returns the WPR session status in the following format.

{
    "SessionType": string, (Running or Idle) 
    "State": string (boot)
}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

起動パフォーマンス トレース セッションを停止するStop a boot performance tracing session

申請Request

次の要求形式を使用して、WPR の起動トレース セッションを停止できます。You can stop a boot WPR tracing session by using the following request format. これは、パフォーマンス トレース セッションとも呼びます。This is also known as a performance tracing session.

メソッドMethod 要求 URIRequest URI
GETGET /api/wpr/boottrace/api/wpr/boottrace

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なし。None. 注: これは時間のかかる処理です。Note: This is a long running operation. ETL のディスクへの書き込みが終了すると、制御が戻ります。It will return when the ETL is finished writing to disk.

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

パフォーマンス トレース セッションを開始するStart a performance tracing session

申請Request

次の要求形式を使用して、WPR のトレース セッションを開始できます。You can start a WPR tracing session by using the following request format. これは、パフォーマンス トレース セッションとも呼びます。This is also known as a performance tracing session. 一度に実行できるトレースは 1 つのみです。Only one trace can run at a time.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/wpr/trace/api/wpr/trace

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
プロファイルprofile (必須) パフォーマンス トレース セッションを開始する必要があるプロファイルの名前。(required) The name of the profile that should start a performance tracing session. 指定可能なプロファイルは、perfprofiles/profiles.json に格納されています。The possible profiles are stored in perfprofiles/profiles.json.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

この API は、開始時に次の形式で WPR セッション状態を返します。On start, this API returns the WPR session status in the following format.

{
    "SessionType": string, (Running or Idle) 
    "State": string (normal)
}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

パフォーマンスのトレース セッションを停止するStop a performance tracing session

申請Request

次の要求形式を使用して、WPR のトレース セッションを停止できます。You can stop a WPR tracing session by using the following request format. これは、パフォーマンス トレース セッションとも呼びます。This is also known as a performance tracing session.

メソッドMethod 要求 URIRequest URI
GETGET /api/wpr/trace/api/wpr/trace

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なし。None. 注: これは時間のかかる処理です。Note: This is a long running operation. ETL のディスクへの書き込みが終了すると、制御が戻ります。It will return when the ETL is finished writing to disk.

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

トレース セッションの状態を取得するRetrieve the status of a tracing session

申請Request

次の要求形式を使用して、現在の WPR セッションの状態を取得できます。You can retrieve the status of the current WPR session by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/wpr/status/api/wpr/status

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

WPR トレース セッションの状態の形式は次のとおりです。The status of the WPR tracing session in the following format.

{
    "SessionType": string, (Running or Idle) 
    "State": string (normal or boot)
}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

完了したトレース セッション (ETL) を一覧表示するList completed tracing sessions (ETLs)

申請Request

次の要求形式を使用して、デバイス上の ETL トレースの一覧を取得できます。You can get a listing of ETL traces on the device using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/wpr/tracefiles/api/wpr/tracefiles

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

完了したトレース セッションの一覧は次の形式で提供されます。The listing of completed tracing sessions is provided in the following format.

{"Items": [{
    "CurrentDir": string (filepath),
    "DateCreated": int (File CreationTime),
    "FileSize": int (bytes),
    "Id": string (filename),
    "Name": string (filename),
    "SubPath": string (filepath),
    "Type": int
}]}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

トレース セッション (ETL) をダウンロードするDownload a tracing session (ETL)

申請Request

次の要求形式を使用して、トレースファイル (ブート トレースまたはユーザー モード トレース) をダウンロードできます。You can download a tracefile (boot trace or user-mode trace) using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/wpr/tracefile/api/wpr/tracefile

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameter on the request URI:

URI パラメーターURI parameter 説明Description
<ファイル名>filename (必須) ダウンロードする ETL トレースの名前。(required) The name of the ETL trace to download. これらは /api/wpr/tracefiles にあります。These can be found in /api/wpr/tracefiles

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • トレース ETL ファイルを返します。Returns the trace ETL file.

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

トレース セッション (ETL) を削除するDelete a tracing session (ETL)

申請Request

次の要求形式を使用して、トレースファイル (ブート トレースまたはユーザー モード トレース) を削除できます。You can delete a tracefile (boot trace or user-mode trace) using the following request format.

メソッドMethod 要求 URIRequest URI
DELETEDELETE /api/wpr/tracefile/api/wpr/tracefile

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameter on the request URI:

URI パラメーターURI parameter 説明Description
<ファイル名>filename (必須) 削除する ETL トレースの名前。(required) The name of the ETL trace to delete. これらは /api/wpr/tracefiles にあります。These can be found in /api/wpr/tracefiles

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • トレース ETL ファイルを返します。Returns the trace ETL file.

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • IoTIoT

DNS SD タグDNS-SD Tags


タグを表示するView Tags

申請Request

デバイスに現在適用されているタグを表示します。View the currently applied tags for the device. これらのタグは、T キー内の DNS-SD TXT レコードを使用してアドバタイズされます。These are advertised via DNS-SD TXT records in the T key.

メソッドMethod 要求 URIRequest URI
GETGET /api/dns-sd/tags/api/dns-sd/tags

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答 現在適用されているタグの形式は次のとおりです。Response The currently applied tags in the following format.

 {
    "tags": [
        "tag1", 
        "tag2", 
        ...
     ]
}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
5XX5XX サーバー エラーServer Error

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

タグを削除するDelete Tags

申請Request

DNS-SD によって現在アドバタイズされているすべてのタグを削除します。Delete all tags currently advertised by DNS-SD.

メソッドMethod 要求 URIRequest URI
DELETEDELETE /api/dns-sd/tags/api/dns-sd/tags

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
5XX5XX サーバー エラーServer Error

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

タグを削除するDelete Tag

申請Request

DNS-SD によって現在アドバタイズされている 1 つのタグを削除します。Delete a tag currently advertised by DNS-SD.

メソッドMethod 要求 URIRequest URI
DELETEDELETE /api/dns-sd/tag/api/dns-sd/tag

URI パラメーターURI parameters

URI パラメーターURI parameter 説明Description
tagValuetagValue (必須) 削除するタグ。(required) The tag to be removed.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

タグを追加するAdd a Tag

申請Request

DNS-SD アドバタイズにタグを追加します。Add a tag to the DNS-SD advertisement.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/dns-sd/tag/api/dns-sd/tag

URI パラメーターURI parameters

URI パラメーターURI parameter 説明Description
tagValuetagValue (必要) 追加するタグ。(required) The tag to be added.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
401401 タグ領域のオーバーフロー。Tag space Overflow. 提供されたタグが、結果として生成される DNS-SD サービス レコードに対して長すぎます。Results when the proposed tag is too long for the resulting DNS-SD service record.

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • IoTIoT

アプリのエクスプローラーApp File Explorer


既知のフォルダーを取得するGet known folders

申請Request

アクセス可能なトップ レベル フォルダーの一覧を取得します。Obtain a list of accessible top-level folders.

メソッドMethod 要求 URIRequest URI
GETGET /api/filesystem/apps/knownfolders/api/filesystem/apps/knownfolders

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答 利用可能なフォルダーの形式は次のとおりです。Response The available folders in the following format.

 {"KnownFolders": [
    "folder0",
    "folder1",...
]}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 展開要求は受け入れられ、処理されています。Deploy request accepted and being processed
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • XboxXbox
  • IoTIoT

ファイルを取得するGet files

申請Request

フォルダー内のファイルの一覧を取得します。Obtain a list of files in a folder.

メソッドMethod 要求 URIRequest URI
GETGET /api/filesystem/apps/files/api/filesystem/apps/files

URI パラメーターURI parameters

URI パラメーターURI parameter 説明Description
knownfolderidknownfolderid (必須) 必要なファイルの一覧の対象となるトップレベル ディレクトリ。(required) The top-level directory where you want the list of files. サイドロードされたアプリにアクセスするには、LocalAppData を使用します。Use LocalAppData for access to sideloaded apps.
packagefullnamepackagefullname ( knownfolderid == LocalAppData の場合は必須) 対象となるアプリのパッケージのフルネーム。(required if knownfolderid == LocalAppData) The package full name of the app you are interested in.
パスpath (オプション) 上で指定したフォルダーまたはパッケージ内のサブディレクトリ。(optional) The sub-directory within the folder or package specified above.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答 利用可能なフォルダーの形式は次のとおりです。Response The available folders in the following format.

{"Items": [
    {
        "CurrentDir": string (folder under the requested known folder),
        "DateCreated": int,
        "FileSize": int (bytes),
        "Id": string,
        "Name": string,
        "SubPath": string (present if this item is a folder, this is the name of the folder),
        "Type": int
    },...
]}

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • XboxXbox
  • IoTIoT

ファイルをダウンロードするDownload a file

申請Request

既知のフォルダーまたは appLocalData からファイルを取得します。Obtain a file from a known folder or appLocalData.

メソッドMethod 要求 URIRequest URI
GETGET /api/filesystem/apps/file/api/filesystem/apps/file

URI パラメーターURI parameters

URI パラメーターURI parameter 説明Description
knownfolderidknownfolderid (必須) ファイルをダウンロードするトップレベル ディレクトリ。(required) The top-level directory where you want to download files. サイドロードされたアプリにアクセスするには、LocalAppData を使用します。Use LocalAppData for access to sideloaded apps.
<ファイル名>filename (必須) ダウンロードするファイルの名前。(required) The name of the file being downloaded.
packagefullnamepackagefullname ( knownfolderid == LocalAppData の場合は必須) 対象となるパッケージのフルネーム。(required if knownfolderid == LocalAppData) The package full name you are interested in.
パスpath (オプション) 上で指定したフォルダーまたはパッケージ内のサブディレクトリ。(optional) The sub-directory within the folder or package specified above.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • 要求するファイル (存在する場合)The file requested, if present

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 要求したファイルThe requested file
404404 ファイルが見つからないFile not found
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • XboxXbox
  • IoTIoT

ファイルの名前の変更Rename a file

申請Request

フォルダー内のファイルの名前を変更します。Rename a file in a folder.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/filesystem/apps/rename/api/filesystem/apps/rename

URI パラメーターURI parameters

URI パラメーターURI parameter 説明Description
knownfolderidknownfolderid (必須) ファイルが存在するトップレベル ディレクトリ。(required) The top-level directory where the file is located. サイドロードされたアプリにアクセスするには、LocalAppData を使用します。Use LocalAppData for access to sideloaded apps.
<ファイル名>filename (必須) 名前を変更するファイルの元の名前。(required) The original name of the file being renamed.
newfilenamenewfilename (必須) ファイルの新しい名前。(required) The new name of the file.
packagefullnamepackagefullname ( knownfolderid == LocalAppData の場合は必須) 対象となるアプリのパッケージのフルネーム。(required if knownfolderid == LocalAppData) The package full name of the app you are interested in.
パスpath (オプション) 上で指定したフォルダーまたはパッケージ内のサブディレクトリ。(optional) The sub-directory within the folder or package specified above.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK .. ファイルの名前が変更されましたThe file is renamed
404404 ファイルが見つからないFile not found
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • XboxXbox
  • IoTIoT

ファイルを削除するDelete a file

申請Request

フォルダー内のファイルを削除します。Delete a file in a folder.

メソッドMethod 要求 URIRequest URI
DELETEDELETE /api/filesystem/apps/file/api/filesystem/apps/file

URI パラメーターURI parameters

URI パラメーターURI parameter 説明Description
knownfolderidknownfolderid (必須) ファイルを削除するトップレベル ディレクトリ。(required) The top-level directory where you want to delete files. サイドロードされたアプリにアクセスするには、LocalAppData を使用します。Use LocalAppData for access to sideloaded apps.
<ファイル名>filename (必須) 削除するファイルの名前。(required) The name of the file being deleted.
packagefullnamepackagefullname ( knownfolderid == LocalAppData の場合は必須) 対象となるアプリのパッケージのフルネーム。(required if knownfolderid == LocalAppData) The package full name of the app you are interested in.
パスpath (オプション) 上で指定したフォルダーまたはパッケージ内のサブディレクトリ。(optional) The sub-directory within the folder or package specified above.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK .. ファイルが削除されます。The file is deleted
404404 ファイルが見つからないFile not found
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • XboxXbox
  • IoTIoT

ファイルをアップロードするUpload a file

申請Request

フォルダーにファイルをアップロードします。Upload a file to a folder. この場合、同じ名前を持つ既存のファイルは上書きされますが、新しいフォルダーは作成されません。This will overwrite an existing file with the same name, but will not create new folders.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/filesystem/apps/file/api/filesystem/apps/file

URI パラメーターURI parameters

URI パラメーターURI parameter 説明Description
knownfolderidknownfolderid (必須) ファイルをアップロードするトップレベル ディレクトリ。(required) The top-level directory where you want to upload files. サイドロードされたアプリにアクセスするには、LocalAppData を使用します。Use LocalAppData for access to sideloaded apps.
packagefullnamepackagefullname ( knownfolderid == LocalAppData の場合は必須) 対象となるアプリのパッケージのフルネーム。(required if knownfolderid == LocalAppData) The package full name of the app you are interested in.
パスpath (オプション) 上で指定したフォルダーまたはパッケージ内のサブディレクトリ。(optional) The sub-directory within the folder or package specified above.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

状態コードStatus code

この API では次の状態コードが返される可能性があります。This API has the following expected status codes.

HTTP 状態コードHTTP status code 説明Description
200200 OKOK .. ファイルがアップロードされます。The file is uploaded
4XX4XX エラー コードError codes
5XX5XX エラー コードError codes

使用可能なデバイスファミリAvailable device families

  • Windows MobileWindows Mobile
  • Windows DesktopWindows Desktop
  • HoloLensHoloLens
  • XboxXbox
  • IoTIoT