デバイス ポータル API リファレンスDevice portal API reference

内のすべて、 Windows Device Portalデータにアクセスし、デバイスの管理をプログラム的に使用できる REST API の上に構築されます。Everything in the Windows Device Portal is built on top of REST API's that you can use to access the data and control your device programmatically.

アプリの展開App deloyment

/api/app/packagemanager/package (削除)/api/app/packagemanager/package (DELETE)

アプリをアンインストールします。Uninstalls an app

パラメーターParameters

  • パッケージ:アンインストールするパッケージのファイル名。package : File name of the package to be uninstalled.

/api/app/packagemanager/package (POST)/api/app/packagemanager/package (POST)

アプリをインストールします。Installs an App

パラメーターParameters

  • パッケージ:パッケージをインストールするのファイル名。package : File name of the package to be installed.

ペイロードPayload

  • 準拠したマルチパートの http 本文multi-part conforming http body

/api/app/packagemanager/packages (GET)/api/app/packagemanager/packages (GET)

詳細と、システムにインストールされているアプリの一覧を取得します。Retrieves the list of installed apps on the system, with details

戻り値のデータReturn data

  • 詳細とインストールされているパッケージの一覧List of installed packages with details

/api/app/packagemanager/state (GET)/api/app/packagemanager/state (GET)

アプリのインストールの進行状況での状態を取得します。Gets the status of in progress app installation

ダンプの収集Dump collection

/api/debug/dump/usermode/crashcontrol (削除)/api/debug/dump/usermode/crashcontrol (DELETE)

サイドロードされたアプリのダンプの収集がクラッシュする無効にします。Disables crash dump collection for a sideloaded app

パラメーターParameters

  • packageFullname: パッケージ名packageFullname : package name

/api/debug/dump/usermode/crashcontrol (GET)/api/debug/dump/usermode/crashcontrol (GET)

クラッシュ ダンプの収集にサイドロードしたアプリの設定を取得します。Gets settings for sideloaded apps crash dump collection

パラメーターParameters

  • packageFullname: パッケージ名packageFullname : package name

/api/debug/dump/usermode/crashcontrol (POST)/api/debug/dump/usermode/crashcontrol (POST)

有効にし、サイドロードされたアプリのダンプ制御の設定の設定Enables and sets dump control settings for a sideloaded app

パラメーターParameters

  • packageFullname: パッケージ名packageFullname : package name

/api/debug/dump/usermode/crashdump (削除)/api/debug/dump/usermode/crashdump (DELETE)

サイドロードされたアプリのクラッシュ ダンプを削除します。Deletes a crash dump for a sideloaded app

パラメーターParameters

  • packageFullname: パッケージ名packageFullname : package name
  • ファイル名: ダンプ ファイルの名前fileName : dump file name

/api/debug/dump/usermode/crashdump (GET)/api/debug/dump/usermode/crashdump (GET)

サイドロードされたアプリのクラッシュ ダンプを取得します。Retrieves a crash dump for a sideloaded app

パラメーターParameters

  • packageFullname: パッケージ名packageFullname : package name
  • ファイル名: ダンプ ファイルの名前fileName : dump file name

戻り値のデータReturn data

  • ダンプ ファイル。Dump file. WinDbg または Visual Studio での検査します。Inspect with WinDbg or Visual Studio

/api/debug/dump/usermode/dumps (GET)/api/debug/dump/usermode/dumps (GET)

サイドロードしたアプリのすべてのクラッシュ ダンプのリストを返しますReturns list of all crash dumps for sideloaded apps

戻り値のデータReturn data

  • サイド ロード アプリごとの一連のクラッシュ ダンプします。List of crash dumps per side loaded app

ETWETW

/api/etw/providers (GET)/api/etw/providers (GET)

登録されているプロバイダーを列挙します。Enumerates registered providers

戻り値のデータReturn data

  • プロバイダー、フレンドリ名と GUID の一覧List of providers, friendly name and GUID

/api/etw/session/realtime (GET/WebSocket)/api/etw/session/realtime (GET/WebSocket)

リアルタイムの ETW セッションを作成します。websocket 経由で管理します。Creates a realtime ETW session; managed over a websocket.

戻り値のデータReturn data

  • 有効なプロバイダーから ETW イベントETW events from the enabled providers

ホログラフィック OSHolographic OS

/api/holographic/os/etw/customproviders (GET)/api/holographic/os/etw/customproviders (GET)

システムに登録されていない HoloLens 特定 ETW プロバイダーの一覧を返しますReturns a list of HoloLens specific ETW providers that are not registered with the system

/api/holographic/os/services (GET)/api/holographic/os/services (GET)

実行されているすべてのサービスの状態を返します。Returns the states of all services running.

/api/holographic/os/settings/ipd (GET)/api/holographic/os/settings/ipd (GET)

ミリメートル単位ストアド IPD (Interpupillary 距離) を取得します。Gets the stored IPD (Interpupillary distance) in millimeters

/api/holographic/os/settings/ipd (POST)/api/holographic/os/settings/ipd (POST)

IPD を設定します。Sets the IPD

パラメーターParameters

  • ipd:ミリメートル単位で設定される新しい IPD 値ipd : New IPD value to be set in millimeters

/api/holographic/os/webmanagement/settings/https (GET)/api/holographic/os/webmanagement/settings/https (GET)

Device Portal の HTTPS 要件を取得するGet HTTPS requirements for the Device Portal

/api/holographic/os/webmanagement/settings/https (POST)/api/holographic/os/webmanagement/settings/https (POST)

デバイスのポータルの HTTPS 要件を設定します。Sets HTTPS requirements for the Device Portal

パラメーターParameters

  • 必須: yes、no または既定値required : yes, no or default

Holographic PerceptionHolographic Perception

/api/holographic/perception/client (GET/WebSocket)/api/holographic/perception/client (GET/WebSocket)

Websocket のアップグレードを受け取り、30 fps で更新プログラムを送信する perception クライアントを実行します。Accepts websocket upgrades and runs a perception client that sends updates at 30 fps.

パラメーターParameters

  • clientmode:"active"強制的 visual 追跡モード受動的に確立されることはできませんclientmode: "active" forces visual tracking mode when it can't be established passively

Holographic 温度Holographic Thermal

/api/holographic/thermal/stage (GET)/api/holographic/thermal/stage (GET)

(通常 0、1 ウォーム、重要な 2) のデバイスの温度のステージを取得します。Get the thermal stage of the device (0 normal, 1 warm, 2 critical)

Perception シミュレーション コントロールPerception Simulation Control

/api/holographic/simulation/control/mode (GET)/api/holographic/simulation/control/mode (GET)

シミュレーションのモードを取得します。Get the simulation mode

/api/holographic/simulation/control/mode (POST)/api/holographic/simulation/control/mode (POST)

シミュレーションのモードを設定します。Set the simulation mode

パラメーターParameters

  • モード: シミュレーション モード: 既定では、シミュレーション、リモートのレガシmode : simulation mode: default, simulation, remote, legacy

/api/holographic/simulation/control/stream (削除)/api/holographic/simulation/control/stream (DELETE)

コントロールのストリームを削除します。Delete a control stream.

/api/holographic/simulation/control/stream (GET/WebSocket)/api/holographic/simulation/control/stream (GET/WebSocket)

コントロールのストリームの web ソケット接続を開きます。Open a web socket connection for a control stream.

/api/holographic/simulation/control/stream (POST)/api/holographic/simulation/control/stream (POST)

コントロールのストリームを作成する (優先度が必要) または作成されたストリーム (必要な streamId) にデータをポストします。Create a control stream (priority is required) or post data to a created stream (streamId required). ポストされたデータは、' アプリケーションまたはオクテット ストリーム ' 型のことが必要です。Posted data is expected to be of type 'application/octet-stream'.

Perception シミュレーションの再生Perception Simulation Playback

/api/holographic/simulation/playback/file (削除)/api/holographic/simulation/playback/file (DELETE)

録画を削除します。Delete a recording.

パラメーターParameters

  • 録音:削除する記録の名前です。recording : Name of recording to delete.

/api/holographic/simulation/playback/file (POST)/api/holographic/simulation/playback/file (POST)

録画をアップロードします。Upload a recording.

/api/holographic/simulation/playback/files (GET)/api/holographic/simulation/playback/files (GET)

すべての記録を取得します。Get all recordings.

/api/holographic/simulation/playback/session (GET)/api/holographic/simulation/playback/session (GET)

録画の現在の再生状態を取得します。Get the current playback state of a recording.

パラメーターParameters

  • 録音:記録の名前です。recording : Name of recording.

/api/holographic/simulation/playback/session/file (削除)/api/holographic/simulation/playback/session/file (DELETE)

録画をアンロードします。Unload a recording.

パラメーターParameters

  • 録音:アンロードする記録の名前です。recording : Name of recording to unload.

/api/holographic/simulation/playback/session/file (POST)/api/holographic/simulation/playback/session/file (POST)

録画を読み込みます。Load a recording.

パラメーターParameters

  • 録音:記録を読み込むの名前です。recording : Name of recording to load.

/api/holographic/simulation/playback/session/files (GET)/api/holographic/simulation/playback/session/files (GET)

読み込まれたすべての記録を取得します。Get all loaded recordings.

/api/holographic/simulation/playback/session/pause (POST)/api/holographic/simulation/playback/session/pause (POST)

記録を一時停止します。Pause a recording.

パラメーターParameters

  • 録音:記録の名前です。recording : Name of recording.

/api/holographic/simulation/playback/session/play (POST)/api/holographic/simulation/playback/session/play (POST)

記録を再生します。Play a recording.

パラメーターParameters

  • 録音:記録の名前です。recording : Name of recording.

/api/holographic/simulation/playback/session/stop (POST)/api/holographic/simulation/playback/session/stop (POST)

録画を停止します。Stop a recording.

パラメーターParameters

  • 録音:記録の名前です。recording : Name of recording.

/api/holographic/simulation/playback/session/types (GET)/api/holographic/simulation/playback/session/types (GET)

読み込まれた記録では、データの種類を取得します。Get the types of data in a loaded recording.

パラメーターParameters

  • 録音:記録の名前です。recording : Name of recording.

Perception シミュレーションの記録Perception Simulation Recording

/api/holographic/simulation/recording/start (POST)/api/holographic/simulation/recording/start (POST)

録画を開始します。Start a recording. 1 つの記録のみを一度にアクティブにできます。Only a single recording can be active at once. Head、手、spatialMapping または環境のいずれかを設定する必要があります。One of head, hands, spatialMapping or environment must be set.

パラメーターParameters

  • ヘッド:レコード ヘッド データを 1 に設定します。head : Set to 1 to record head data.
  • ハンズ:1 に設定するには手の形のデータを記録します。hands : Set to 1 to record hand data.
  • spatialMapping:空間マッピングを記録する、1 に設定します。spatialMapping : Set to 1 to record spatial mapping.
  • 環境:環境のデータを記録する、1 に設定します。environment : Set to 1 to record environment data.
  • 名:記録の名前です。name : Name of the recording.
  • singleSpatialMappingFrame:空間マッピングは 1 つのフレームのみを記録する、1 に設定します。singleSpatialMappingFrame : Set to 1 to record only a single spatial mapping frame.

/api/holographic/simulation/recording/status (GET)/api/holographic/simulation/recording/status (GET)

状態の記録を取得します。Get recording state.

/api/holographic/simulation/recording/stop (GET)/api/holographic/simulation/recording/stop (GET)

現在の記録を停止します。Stop the current recording. 記録は、ファイルとして返されます。Recording will be returned as a file.

Mixed Reality キャプチャMixed Reality Capture

/api/holographic/mrc/file (削除)/api/holographic/mrc/file (DELETE)

デバイスから録画複合現実を削除します。Deletes a mixed reality recording from the device.

パラメーターParameters

  • ファイル名:削除するファイルのエンコード、名前、hex64filename : Name, hex64 encoded, of the file to delete

/api/holographic/mrc/settings (GET)/api/holographic/mrc/settings (GET)

取得、既定値に、複合現実設定のキャプチャGets the default mixed reality capture settings

/api/holographic/mrc/file (GET)/api/holographic/mrc/file (GET)

デバイスから複合現実ファイルをダウンロードします。Downloads a mixed reality file from the device. 使用 op ストリーミング ストリームのクエリ パラメーターを = です。Use op=stream query parameter for streaming.

パラメーターParameters

  • ファイル名:取得するビデオ ファイルのエンコード、名前、hex64filename : Name, hex64 encoded, of the video file to get
  • op: ストリームop : stream

/api/holographic/mrc/thumbnail (GET)/api/holographic/mrc/thumbnail (GET)

指定したファイルのサムネイル画像を取得します。Gets the thumbnail image for the specified file.

パラメーターParameters

  • ファイル名:エンコードされる場合は、サムネイルを要求する対象のファイルの名前、hex64filename: Name, hex64 encoded, of the file for which the thumbnail is being requested

/api/holographic/mrc/status (GET)/api/holographic/mrc/status (GET)

記録された複合現実 (実行、停止) の状態を取得します。Gets the status of the mixed reality recorded (running, stopped)

/api/holographic/mrc/files (GET)/api/holographic/mrc/files (GET)

デバイスに保存された複合現実ファイルの一覧を返しますReturns the list of mixed reality files stored on the device

/api/holographic/mrc/settings (POST)/api/holographic/mrc/settings (POST)

セットの既定値に、複合現実設定のキャプチャSets the default mixed reality capture settings

/api/holographic/mrc/video/control/start (POST)/api/holographic/mrc/video/control/start (POST)

複合現実の録音を開始します。Starts a mixed reality recording

パラメーターParameters

  • holo: キャプチャ ホログラム: true または falseholo : capture holograms: true or false
  • pv: キャプチャ PV カメラ: true または falsepv : capture PV camera: true or false
  • mic: キャプチャ マイク: true または falsemic : capture microphone: true or false
  • ループバック: アプリの音声のキャプチャ: true または falseloopback : capture app audio: true or false

/api/holographic/mrc/video/control/stop (POST)/api/holographic/mrc/video/control/stop (POST)

停止現在混合現実の記録Stops the current mixed reality recording

/api/holographic/mrc/photo (POST)/api/holographic/mrc/photo (POST)

複合現実の写真を撮影し、デバイス上のファイルを作成しますTakes a mixed reality photo and creates a file on the device

パラメーターParameters

  • holo: キャプチャ ホログラム: true または falseholo : capture holograms: true or false
  • pv: キャプチャ PV カメラ: true または falsepv : capture PV camera: true or false

複合現実のストリーミングMixed Reality Streaming

/api/holographic/stream/live.mp4 (GET)/api/holographic/stream/live.mp4 (GET)

フラグメント化 mp4 のチャンク ダウンロードを開始するInitiates a chunked download of a fragmented mp4

パラメーターParameters

  • holo: キャプチャ ホログラム: true または falseholo : capture holograms: true or false
  • pv: キャプチャ PV カメラ: true または falsepv : capture PV camera: true or false
  • mic: キャプチャ マイク: true または falsemic : capture microphone: true or false
  • ループバック: アプリの音声のキャプチャ: true または falseloopback : capture app audio: true or false

/api/holographic/stream/live_high.mp4 (GET)/api/holographic/stream/live_high.mp4 (GET)

フラグメント化 mp4 のチャンク ダウンロードを開始するInitiates a chunked download of a fragmented mp4

パラメーターParameters

  • holo: キャプチャ ホログラム: true または falseholo : capture holograms: true or false
  • pv: キャプチャ PV カメラ: true または falsepv : capture PV camera: true or false
  • mic: キャプチャ マイク: true または falsemic : capture microphone: true or false
  • ループバック: アプリの音声のキャプチャ: true または falseloopback : capture app audio: true or false

/api/holographic/stream/live_low.mp4 (GET)/api/holographic/stream/live_low.mp4 (GET)

フラグメント化 mp4 のチャンク ダウンロードを開始するInitiates a chunked download of a fragmented mp4

パラメーターParameters

  • holo: キャプチャ ホログラム: true または falseholo : capture holograms: true or false
  • pv: キャプチャ PV カメラ: true または falsepv : capture PV camera: true or false
  • mic: キャプチャ マイク: true または falsemic : capture microphone: true or false
  • ループバック: アプリの音声のキャプチャ: true または falseloopback : capture app audio: true or false

/api/holographic/stream/live_med.mp4 (GET)/api/holographic/stream/live_med.mp4 (GET)

フラグメント化 mp4 のチャンク ダウンロードを開始するInitiates a chunked download of a fragmented mp4

パラメーターParameters

  • holo: キャプチャ ホログラム: true または falseholo : capture holograms: true or false
  • pv: キャプチャ PV カメラ: true または falsepv : capture PV camera: true or false
  • mic: キャプチャ マイク: true または falsemic : capture microphone: true or false
  • ループバック: アプリの音声のキャプチャ: true または falseloopback : capture app audio: true or false

ネットワークNetworking

/api/networking/ipconfig (GET)/api/networking/ipconfig (GET)

現在の ip 構成を取得します。Gets the current ip configuration

OS 情報OS Information

/api/os/info (GET)/api/os/info (GET)

オペレーティング システムの情報を取得します。Gets operating system information

/api/os/machinename (GET)/api/os/machinename (GET)

コンピューター名を取得します。Gets the machine name

/api/os/machinename (POST)/api/os/machinename (POST)

コンピューター名を設定します。Sets the machine name

パラメーターParameters

  • 名:新しいコンピューター名、hex64 エンコードされる場合に設定するにはname : New machine name, hex64 encoded, to set to

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

/api/resourcemanager/processes (GET)/api/resourcemanager/processes (GET)

詳細でプロセスを実行の一覧を返しますReturns the list of running processes with details

戻り値のデータReturn data

  • プロセスと各プロセスの詳細の一覧が JSONJSON with list of processes and details for each process

/api/resourcemanager/systemperf (GET)/api/resourcemanager/systemperf (GET)

(読み取り/書き込みの I/O、メモリの統計情報などシステム パフォーマンスの統計情報を返しますです。Returns system perf statistics (I/O read/write, memory stats etc.

戻り値のデータReturn data

  • システム情報を使用して、JSON:CPU、GPU、メモリ、ネットワーク、IOJSON with system information: CPU, GPU, Memory, Network, IO

PowerPower

/api/power/battery (GET)/api/power/battery (GET)

現在のバッテリの状態を取得します。Gets the current battery state

/api/power/state (GET)/api/power/state (GET)

システムの低電力状態を確認しますChecks if the system is in a low power state

リモート コントロールRemote Control

/api/control/restart (POST)/api/control/restart (POST)

ターゲット デバイスを再起動します。Restarts the target device

/api/control/shutdown (POST)/api/control/shutdown (POST)

ターゲット デバイスをシャット ダウンShuts down the target device

タスク マネージャーTask Manager

/api/taskmanager/app (削除)/api/taskmanager/app (DELETE)

最新のアプリを停止します。Stops a modern app

パラメーターParameters

  • パッケージ:エンコードされた hex64、アプリ パッケージの完全な名前package : Full name of the app package, hex64 encoded
  • 強制:強制的にすべてのプロセスを停止する (= [はい])forcestop : Force all processes to stop (=yes)

/api/taskmanager/app (POST)/api/taskmanager/app (POST)

最新のアプリを起動します。Starts a modern app

パラメーターParameters

  • appid:開始するアプリの PRAID、hex64 エンコードappid : PRAID of app to start, hex64 encoded
  • パッケージ:エンコードされた hex64、アプリ パッケージの完全な名前package : Full name of the app package, hex64 encoded

WiFi の管理WiFi Management

/api/wifi/interfaces (GET)/api/wifi/interfaces (GET)

ワイヤレス ネットワーク インターフェイスを列挙します。Enumerates wireless network interfaces

戻り値のデータReturn data

  • (GUID、説明など) の詳細を含むワイヤレス インターフェイスの一覧List of wireless interfaces with details (GUID, description etc.)

/api/wifi/network (削除)/api/wifi/network (DELETE)

指定されたインターフェイス上のネットワークに関連付けられているプロファイルを削除します。Deletes a profile associated with a network on a specified interface

パラメーターParameters

  • インターフェイス: ネットワーク インターフェイスの guidinterface : network interface guid
  • プロファイル: プロファイル名profile : profile name

/api/wifi/networks (GET)/api/wifi/networks (GET)

指定したネットワーク インターフェイス上でワイヤレス ネットワークを列挙します。Enumerates wireless networks on the specified network interface

パラメーターParameters

  • インターフェイス: ネットワーク インターフェイスの guidinterface : network interface guid

戻り値のデータReturn data

  • ネットワーク インターフェイスの詳細に検出されたワイヤレス ネットワークの一覧List of wireless networks found on the network interface with details

/api/wifi/network (POST)/api/wifi/network (POST)

接続または指定されたインターフェイス上のネットワークに接続を切断Connects or disconnects to a network on the specified interface

パラメーターParameters

  • インターフェイス: ネットワーク インターフェイスの guidinterface : network interface guid
  • ssid: ssid、hex64 への接続にエンコードします。ssid : ssid, hex64 encoded, to connect to
  • op: 接続または切断op : connect or disconnect
  • createprofile: はいまたは nocreateprofile : yes or no
  • キー: エンコードされた共有のキー、hex64key : shared key, hex64 encoded

Windows パフォーマンス レコーダーWindows Performance Recorder

/api/wpr/customtrace (POST)/api/wpr/customtrace (POST)

WPR プロファイルをアップロードし、アップロードされたプロファイルを使用してトレースを開始します。Uploads a WPR profile and starts tracing using the uploaded profile.

ペイロードPayload

  • 準拠したマルチパートの http 本文multi-part conforming http body

戻り値のデータReturn data

  • WPR セッションの状態を返します。Returns the WPR session status.

/api/wpr/status (GET)/api/wpr/status (GET)

WPR セッションの状態を取得します。Retrieves the status of the WPR session

戻り値のデータReturn data

  • WPR セッションの状態。WPR session status.

/api/wpr/trace (GET)/api/wpr/trace (GET)

WPR (パフォーマンス) のトレース セッションを停止します。Stops a WPR (performance) tracing session

戻り値のデータReturn data

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

/api/wpr/trace (POST)/api/wpr/trace (POST)

セッションのトレース WPR (パフォーマンス) を開始します。Starts a WPR (performance) tracing sessions

パラメーターParameters

  • プロファイル:プロファイルの名前。profile : Profile name. 使用可能なプロファイル perfprofiles/profiles.json に格納されます。Available profiles are stored in perfprofiles/profiles.json

戻り値のデータReturn data

  • 起動時に、WPR セッションの状態を返します。On start, returns the WPR session status.

関連項目See also