Referencia de las API de REST principales del Portal de dispositivos Windows

Artículo
07/13/2023

Toda la funcionalidad del Portal de dispositivos Windows (WDP) se basa en las API de REST a las que los desarrolladores pueden llamar directamente para acceder a recursos y controlar sus dispositivos mediante programación.

Implementación de la aplicación

Instalar una aplicación

Solicitud

Puedes instalar una aplicación mediante el siguiente formato de solicitud.

Método	URI de solicitud
POST	/api/app/packagemanager/package

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
paquete	(obligatorio) Nombre de archivo del paquete que debe instalarse.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

El archivo .appx o .appxbundle, así como las dependencias necesarias de la aplicación.
El certificado que se usa para firmar la aplicación, si el dispositivo es IoT o escritorio de Windows. Otras plataformas no requieren el certificado.

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Implementar la solicitud aceptada y que se está procesando
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Nota

Windows Mixed Reality se ejecuta en un escritorio normal, por lo que es el mismo portal que Escritorio.

Solicitud

Puedes instalar un conjunto relacionado mediante el siguiente formato de solicitud.

Método	URI de solicitud
POST	/api/app/packagemanager/package

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
paquete	(obligatorio) Nombres de archivo de los paquetes que se van a instalar.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Agrega ".opt" a los nombres de archivo de los paquetes opcionales cuando los especifiques como un parámetro, por ejemplo: "foo.appx.opt" o "bar.appxbundle.opt".
El archivo .appx o .appxbundle, así como las dependencias necesarias de la aplicación.
El certificado que se usa para firmar la aplicación, si el dispositivo es IoT o escritorio de Windows. Otras plataformas no requieren el certificado.

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Implementar la solicitud aceptada y que se está procesando
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Registrar una aplicación en una carpeta dinámica

Solicitud

Puede registrar una aplicación en una carpeta dinámica mediante el siguiente formato de solicitud.

Método	URI de solicitud
POST	/api/app/packagemanager/networkapp

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

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

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Implementar la solicitud aceptada y que se está procesando
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
Xbox
HoloLens
IoT

Solicitud

Puedes registrar un conjunto relacionado en carpetas dinámicas mediante el siguiente formato de solicitud.

Método	URI de solicitud
POST	/api/app/packagemanager/networkapp

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

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

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Implementar la solicitud aceptada y que se está procesando
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
Xbox
HoloLens
IoT

Obtener el estado de instalación de la aplicación

Solicitud

Puedes obtener el estado de la instalación de una aplicación que está en curso mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/app/packagemanager/state

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	El resultado de la última implementación
204	La instalación se está ejecutando
404	No se encontró ninguna acción de instalación

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Desinstalar una aplicación

Solicitud

Puedes desinstalar una aplicación mediante el siguiente formato de solicitud.

Método	URI de solicitud
DELETE	/api/app/packagemanager/package

Parámetros de URI

Parámetro de URI	Descripción
paquete	(obligatorio) El elemento PackageFullName (de GET /api/app/packagemanager/packages) de la aplicación de destino

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Obtener aplicaciones instaladas

Solicitud

Puedes obtener una lista de aplicaciones instaladas en el sistema mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/app/packagemanager/packages

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye una lista de los paquetes instalados con detalles asociados. La plantilla para esta respuesta es la siguiente.

{"InstalledPackages": [
    {
        "Name": string,
        "PackageFamilyName": string,
        "PackageFullName": string,
        "PackageOrigin": int, (https://msdn.microsoft.com/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
     },...
     ]
    },...
]}

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Bluetooth

Obtener las radios Bluetooth en la máquina

Solicitud

Puedes obtener una lista de las radios Bluetooth que están instaladas en la máquina mediante el siguiente formato de solicitud. También se puede actualizar a una conexión WebSocket, con los mismos datos JSON.

Método	URI de solicitud
GET	/api/bt/getradios
GET/WebSocket	/api/bt/getradios

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye una matriz JSON de las radios Bluetooth conectadas al dispositivo.

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
HoloLens
IoT

Activar o desactivar la radio Bluetooth

Solicitud

Activa o desactiva una radio Bluetooth específica.

Método	URI de solicitud
POST	/api/bt/setradio

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
ID	(obligatorio) Id. de dispositivo de la radio Bluetooth que debe estar codificado en Base64.
Estado	(obligatorio) Puede ser `"On"` o `"Off"`.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
HoloLens
IoT

Obtener una lista de dispositivos Bluetooth emparejados

Solicitud

Puedes obtener una lista de los dispositivos Bluetooth emparejados actualmente con el siguiente formato de solicitud. También se puede actualizar a una conexión WebSocket, con los mismos datos JSON. Mientras las conexión de WebSocket está activa, la lista de dispositivos puede cambiar. Cada vez que exista una actualización, se enviará una lista completa de los dispositivos a través de la conexión WebSocket.

Método	URI de solicitud
GET	/api/bt/getpaired
GET/WebSocket	/api/bt/getpaired

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye una matriz JSON de los dispositivos Bluetooth que están emparejados actualmente.

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

El campo AudioConnectionStatus estará presente si el dispositivo se puede usar para audio en este sistema. (Las directivas y los componentes opcionales pueden influir). El valor de AudioConnectionStatus será "Connected" o "Disconnected".

Obtener una lista de dispositivos Bluetooth disponibles

Solicitud

Puedes obtener una lista de los dispositivos Bluetooth disponibles para emparejar con el siguiente formato de solicitud. También se puede actualizar a una conexión WebSocket, con los mismos datos JSON. Mientras las conexión de WebSocket está activa, la lista de dispositivos puede cambiar. Cada vez que exista una actualización, se enviará una lista completa de los dispositivos a través de la conexión WebSocket.

Método	URI de solicitud
GET	/api/bt/getavailable
GET/WebSocket	/api/bt/getavailable

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye una matriz JSON de los dispositivos Bluetooth que están disponibles actualmente para emparejar.

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

Conectar un dispositivo Bluetooth

Solicitud

Se conectará al dispositivo si este se puede usar para audio en este sistema. (Las directivas y los componentes opcionales pueden influir).

Método	URI de solicitud
POST	/api/bt/connectdevice

Parámetros de URI

Parámetro de URI	Descripción
ID	(obligatorio) Id. de extremo de asociación del dispositivo Bluetooth, que debe estar codificado en Base64.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
HoloLens
IoT

Desconectar un dispositivo Bluetooth

Solicitud

Desconectará el dispositivo si el dispositivo se puede usar para audio en este sistema. (Las directivas y los componentes opcionales pueden influir).

Método	URI de solicitud
POST	/api/bt/disconnectdevice

Parámetros de URI

Parámetro de URI	Descripción
ID	(obligatorio) Id. de extremo de asociación del dispositivo Bluetooth, que debe estar codificado en Base64.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
HoloLens
IoT

Administrador de dispositivos

Obtener los dispositivos instalados en la máquina

Solicitud

Puedes obtener una lista de dispositivos que están instalados en la máquina mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/devicemanager/devices

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye una matriz JSON de los dispositivos conectados al dispositivo.

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
IoT

Obtener datos sobre dispositivos o concentradores USB conectados

Solicitud

Puedes obtener una lista de los descriptores USB de los dispositivos y concentradores USB conectados mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/ext/devices/usbdevices

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta es un archivo JSON que incluye el DeviceID del dispositivo USB junto con los descriptores USB y la información de puerto de los concentradores.

{
    "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
        },
        ...
    ]
}

Ejemplo de datos devueltos

{
    "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
    }]
}

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
IoT

Colección de volcados de memoria

Obtener la lista de todos los volcados de memoria de aplicaciones

Solicitud

Puedes obtener la lista de todos los volcados de memoria disponibles para todas las aplicaciones transferidas localmente mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/debug/dump/usermode/dumps

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye una lista de volcados de memoria de cada aplicación transferida localmente.

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile (en el Programa Windows Insider)
Escritorio de Windows
HoloLens
IoT

Obtener la configuración de la colección de volcado de memoria de una aplicación

Solicitud

Puedes obtener la configuración de colección de volcado de memoria de una aplicación transferida localmente mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/debug/dump/usermode/crashcontrol

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
packageFullName	(obligatorio) Nombre completo del paquete de la aplicación transferida localmente.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta tiene el siguiente formato.

{"CrashDumpEnabled": bool}

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile (en el Programa Windows Insider)
Escritorio de Windows
HoloLens
IoT

Eliminar un volcado de memoria de una aplicación transferida localmente

Solicitud

Puedes eliminar un volcado de memoria de una aplicación transferida localmente mediante el siguiente formato de solicitud.

Método	URI de solicitud
DELETE	/api/debug/dump/usermode/crashdump

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
packageFullName	(obligatorio) Nombre completo del paquete de la aplicación transferida localmente.
fileName	(obligatorio) Nombre del archivo de volcado de memoria que se debe eliminar.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile (en el Programa Windows Insider)
Escritorio de Windows
HoloLens
IoT

Deshabilitar volcados de memoria de una aplicación transferida localmente

Solicitud

Puedes deshabilitar los volcados de memoria de una aplicación transferida localmente mediante el siguiente formato de solicitud.

Método	URI de solicitud
DELETE	/api/debug/dump/usermode/crashcontrol

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
packageFullName	(obligatorio) Nombre completo del paquete de la aplicación transferida localmente.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile (en el Programa Windows Insider)
Escritorio de Windows
HoloLens
IoT

Descargar el volcado de memoria de una aplicación transferida localmente

Solicitud

Puedes descargar un volcado de memoria de una aplicación transferida localmente mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/debug/dump/usermode/crashdump

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
packageFullName	(obligatorio) Nombre completo del paquete de la aplicación transferida localmente.
fileName	(obligatorio) Nombre del archivo de volcado de memoria que quieres descargar.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye un archivo de volcado de memoria. Puedes usar WinDbg o Visual Studio para examinar el archivo de volcado de memoria.

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile (en el Programa Windows Insider)
Escritorio de Windows
HoloLens
IoT

Habilitar los volcados de memoria de una aplicación transferida localmente

Solicitud

Puedes habilitar los volcados de memoria de una aplicación transferida localmente mediante el siguiente formato de solicitud.

Método	URI de solicitud
POST	/api/debug/dump/usermode/crashcontrol

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
packageFullName	(obligatorio) Nombre completo del paquete de la aplicación transferida localmente.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar

Familias de dispositivos disponibles

Windows Mobile (en el Programa Windows Insider)
Escritorio de Windows
HoloLens
IoT

Obtener la lista de archivos de comprobación de errores

Solicitud

Puedes obtener la lista de archivos de minivolcado de comprobación de errores mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/debug/dump/kernel/dumplist

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye una lista de nombres de archivo de volcado de memoria y los tamaños de estos archivos. Esta lista tendrá el siguiente formato.

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar

Familias de dispositivos disponibles

Escritorio de Windows
IoT

Descargar un archivo de volcado de memoria de comprobación de errores

Solicitud

Puedes descargar un archivo de volcado de memoria de comprobación de errores mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/debug/dump/kernel/dump

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
nombreDeArchivo	(obligatorio) Nombre del archivo de volcado de memoria. Puedes encontrarlo mediante la API para obtener la lista de volcado de memoria.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye el archivo de volcado de memoria. Puedes inspeccionar este archivo con WinDbg.

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
IoT

Obtener la configuración de control de bloqueo de comprobación de errores

Solicitud

Puedes obtener la configuración del control de bloqueo de comprobación de errores mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/debug/dump/kernel/crashcontrol

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye la configuración de control de bloqueo. Para obtener más información sobre CrashControl, consulta el artículo CrashControl. La plantilla para la respuesta es la siguiente.

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

Tipos de volcado

0: Deshabilitada

1: Volcado de memoria completo (recopila toda la memoria en uso)

2: Volcado de memoria de kernel (omite la memoria del modo de usuario)

3: Minivolcado de kernel limitado

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
IoT

Obtener un volcado de memoria de kernel dinámico

Solicitud

Puedes obtener un volcado de memoria de kernel dinámico mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/debug/dump/livekernel

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye el volcado de memoria de modo kernel completo. Puedes inspeccionar este archivo con WinDbg.

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
IoT

Obtener un volcado de memoria de un proceso de usuario dinámico

Solicitud

Puedes obtener el volcado de memoria del proceso de usuario dinámico mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/debug/dump/usermode/live

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
pid	(obligatorio) Identificador de proceso único para el proceso que te interesa.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye del volcado de memoria del proceso. Puedes inspeccionar este archivo con WinDbg o Visual Studio.

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
IoT

Establecer la configuración de control de bloqueo de comprobación de errores

Solicitud

Puedes establecer la configuración para recopilar datos de comprobación de errores mediante el siguiente formato de solicitud.

Método	URI de solicitud
POST	/api/debug/dump/kernel/crashcontrol

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
autoreboot	(opcional) True o false. Esto indica si el sistema se reinicia automáticamente después de que se produzca un error o se bloquee.
dumptype	(opcional) Tipo de volcado de memoria. Para obtener los valores admitidos, consulta CrashDumpType Enumeration.
maxdumpcount	(opcional) Número máximo de volcados de memoria que se deben guardar.
sobrescribir	(opcional) True o false. Indica si se deben sobrescribir o no los volcados de memoria antiguos cuando se alcanza el límite del contador de volcado de memoria especificado por maxdumpcount.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
IoT

ETW

Crear una sesión ETW en tiempo real a través de un WebSocket

Solicitud

Puedes crear una sesión ETW en tiempo real mediante el siguiente formato de solicitud. Se administrará a través de un websocket. Los eventos ETW se procesan por lotes en el servidor y se envían al cliente una vez por segundo.

Método	URI de la solicitud
GET/WebSocket	/api/etw/session/realtime

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye los eventos ETW de los proveedores habilitados. Ver los comandos de ETW WebSocket a continuación.

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
HoloLens
IoT

Comandos de ETW WebSocket

Estos comandos se envían desde el cliente al servidor.

Comando	Descripción
el proveedor {guid} habilita {level}	Habilita el proveedor marcado con {guid} (sin corchetes) en el nivel especificado. {level} es un int de 1 (mínimo detalle) a 5 (detallado).
el proveedor {guid} deshabilita	Deshabilitar el proveedor con la marca {guid} (sin corchetes).

Esta respuesta se envía desde el servidor al cliente. Esto se envía como texto y tú obtienes el siguiente formato analizando el JSON.

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

Los objetos de carga son pares de clave-valor adicionales (string:string) que se proporcionan en el evento ETW original.

Ejemplo:

{
    "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"
}

Enumerar los proveedores de ETW registrados

Solicitud

Puedes enumerar los proveedores registrados con el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/etw/providers

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye la lista de proveedores de ETW. La lista incluye el nombre descriptivo y el GUID para cada proveedor en el siguiente formato.

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
HoloLens
IoT

Enumerar los proveedores de ETW personalizados expuestos por la plataforma.

Solicitud

Puedes enumerar los proveedores registrados con el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/etw/customproviders

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

200 Correcto. La respuesta incluye la lista de proveedores de ETW. La lista incluirá el nombre descriptivo y el GUID de cada proveedor.

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

Código de estado

Códigos de estado estándar.

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
HoloLens
IoT

Ubicación

Obtener el modo de invalidación de ubicación

Solicitud

Puedes obtener el estado de invalidación de la pila de ubicaciones del dispositivo mediante el siguiente formato de solicitud. El modo de desarrollador debe estar activado para que esta llamada pueda tener éxito.

Método	URI de solicitud
GET	/ext/location/override

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye el estado de invalidación del dispositivo en el siguiente formato.

{"Override" : bool}

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Establecer el modo de invalidación de ubicación

Solicitud

Puedes establecer el estado de invalidación de la pila de ubicaciones del dispositivo mediante el siguiente formato de solicitud. Cuando está habilitada, la pila de ubicaciones permite la inyección de posición. El modo de desarrollador debe estar activado para que esta llamada pueda tener éxito.

Método	URI de la solicitud
PUT	/ext/location/override

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

{"Override" : bool}

Respuesta

La respuesta incluye el estado de invalidación que ha establecido el dispositivo en el siguiente formato.

{"Override" : bool}

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Obtener la posición inyectada

Solicitud

Puedes obtener la ubicación inyectada del dispositivo (sin precisión) mediante el siguiente formato de solicitud. Se debe establecer una ubicación inyectada, o se producirá un error.

Método	URI de solicitud
GET	/ext/location/position

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye los valores de longitud y latitud inyectados en el siguiente formato.

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Establecer la posición inyectada

Solicitud

Puedes establecer la ubicación inyectada del dispositivo (sin precisión) mediante el siguiente formato de solicitud. Primero debe estar habilitado el modo de invalidación de ubicación en el dispositivo y la ubicación establecida debe ser una ubicación válida, o se producirá un error.

Método	URI de la solicitud
PUT	/ext/location/override

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

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

Respuesta

La respuesta incluye la ubicación que se ha establecido en el siguiente formato.

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Información del SO

Obtener el nombre de la máquina

Solicitud

Puedes obtener el nombre de una máquina mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/os/machinename

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye el nombre del equipo en el siguiente formato.

{"ComputerName": string}

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Obtener la información del sistema operativo

Solicitud

Puedes obtener la información del sistema operativo de una máquina mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/os/info

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye la información del sistema operativo en el siguiente formato.

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Obtén la familia de dispositivos.

Solicitud

Puedes obtener la familia de dispositivos (Xbox, Teléfono, escritorio, etc.) mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/os/devicefamily

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye la familia de dispositivos (SKU - escritorio, Xbox, etc.).

{
   "DeviceType" : string
}

DeviceType tendrá un aspecto como "Windows.Xbox", "Windows.Desktop", etc.

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Establecer el nombre de la máquina

Solicitud

Puedes establecer el nombre de una máquina mediante el siguiente formato de solicitud.

Método	URI de solicitud
POST	/api/os/machinename

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
name	(obligatorio) Nuevo nombre de la máquina. Esto debe estar codificado en Base64.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Información de usuario

Obtener el usuario activo

Solicitud

Puedes obtener el nombre del usuario activo en el dispositivo mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/users/activeuser

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye la información del usuario en el siguiente formato.

En caso de éxito:

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

En caso de error:

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
HoloLens
IoT

Datos de rendimiento

Obtener la lista de procesos en ejecución

Solicitud

Puedes obtener la lista de procesos que se encuentran en ejecución actualmente mediante el siguiente formato de solicitud. esto puede actualizarse a una conexión WebSocket también, con los mismos datos de JSON que se envían al cliente una vez por segundo.

Método	URI de solicitud
GET	/api/resourcemanager/processes
GET/WebSocket	/api/resourcemanager/processes

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye una lista de procesos con detalles de cada proceso. La información está en formato JSON y tiene la siguiente plantilla.

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
HoloLens
IoT

Obtener las estadísticas de rendimiento del sistema

Solicitud

Puedes obtener las estadísticas de rendimiento del sistema mediante el siguiente formato de solicitud. Esto incluye información como, por ejemplo, leer y escribir ciclos y la cantidad de memoria que se ha usado.

Método	URI de solicitud
GET	/api/resourcemanager/systemperf
GET/WebSocket	/api/resourcemanager/systemperf

Esto también se pueden actualizar a una conexión WebSocket. Proporciona los mismos datos de JSON a continuación una vez por segundo.

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye las estadísticas de rendimiento del sistema, como el uso de la CPU y GPU, el acceso a la memoria y el acceso a la red. Esta información está en formato JSON y tiene la siguiente plantilla.

{
    "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
    }
}

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Potencia

Obtener el estado actual de la batería

Solicitud

Puedes obtener el estado actual de la batería mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/power/battery

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La información del estado actual de la batería se devuelve mediante el siguiente formato.

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
HoloLens
IoT

Obtener el plan de energía activo

Solicitud

Puedes obtener el plan de energía activo mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/power/activecfg

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

El plan de energía activo tiene el siguiente formato.

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
IoT

Obtener el subvalor de un plan de energía

Solicitud

Puedes obtener el subvalor de un plan de energía mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/power/cfg/<ruta de acceso del esquema de energía>

Opciones:

SCHEME_CURRENT

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Hay una lista completa de estados de energía disponible por aplicación y la configuración para marcar varios estados de energía, como bajo y crítico.

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
IoT

Obtener el estado de energía del sistema

Solicitud

Puedes comprobar el estado de energía del sistema mediante el siguiente formato de solicitud. Esto te permitirá comprobar si se encuentra en un estado de energía bajo.

Método	URI de solicitud
GET	/api/power/state

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La información de estado de energía tiene la siguiente plantilla.

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
HoloLens
IoT

Establecer el plan de energía activo

Solicitud

Puedes establecer el plan de energía activo mediante el siguiente formato de solicitud.

Método	URI de solicitud
POST	/api/power/activecfg

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
scheme	(obligatorio) GUID del esquema que quiere establecer como plan de energía activo para el sistema.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
IoT

Establecer el subvalor de un plan de energía

Solicitud

Puedes establecer el subvalor de un plan de energía mediante el siguiente formato de solicitud.

Método	URI de solicitud
POST	/api/power/cfg/<ruta de acceso del esquema de energía>

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
valueAC	(obligatorio) Valor que se usará para alimentación CA.
valueDC	(obligatorio) Valor que se usará para la energía de la batería.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar

Familias de dispositivos disponibles

Escritorio de Windows
IoT

Obtener un informe de estudio de suspensión

Solicitud

Método	URI de solicitud
GET	/api/power/sleepstudy/report

Puedes obtener un informe de estudio de suspensión mediante el siguiente formato de solicitud.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta es un archivo que contiene el estudio de suspensión.

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
IoT

Enumerar los informes de estudio de suspensión disponibles

Solicitud

Puedes enumerar los informes de estudio de suspensión disponibles mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/power/sleepstudy/reports

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La lista de los informes disponibles tiene la siguiente plantilla.

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
IoT

Obtener la transformación de estudio de suspensión

Solicitud

Puedes obtener la transformación de estudio de suspensión mediante el siguiente formato de solicitud. Esta transformación es de tipo XSLT que convierte el informe de estudio de suspensión en un formato XML que puede leer una persona.

Método	URI de solicitud
GET	/api/power/sleepstudy/transform

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta contiene la transformación de estudio de suspensión.

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
IoT

Control remoto

Reiniciar el equipo de destino

Solicitud

Puedes reiniciar el equipo de destino mediante el siguiente formato de solicitud.

Método	URI de solicitud
POST	/api/control/restart

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Apagar el equipo de destino

Solicitud

Puedes apagar el equipo de destino mediante el siguiente formato de solicitud.

Método	URI de solicitud
POST	/api/control/shutdown

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Administrador de tareas

Iniciar una aplicación moderna

Solicitud

Puedes iniciar una aplicación moderna mediante el siguiente formato de solicitud.

Método	URI de solicitud
POST	/api/taskmanager/app

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
appid	(obligatorio) PRAID de la aplicación que quieres iniciar. Este valor debe estar codificado mediante hex64.
paquete	(obligatorio) Nombre completo del paquete de la aplicación que quiere iniciar. Este valor debe estar codificado mediante hex64.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Detener una aplicación moderna

Solicitud

Puedes detener una aplicación moderna mediante el siguiente formato de solicitud.

Método	URI de solicitud
DELETE	/api/taskmanager/app

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
paquete	(obligatorio) Nombre completo de los paquetes de la aplicación que quiere detener. Este valor debe estar codificado mediante hex64.
forcestop	(opcional) Un valor de yes indica que el sistema debe forzar la detención de todos los procesos.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Eliminar el proceso por PID

Solicitud

Puedes eliminar el proceso mediante el siguiente formato de solicitud.

Método	URI de solicitud
DELETE	/api/taskmanager/process

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
pid	(obligatorio) Identificador de proceso único para detener el proceso.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
HoloLens
IoT

Funciones de red

Obtener la configuración IP actual

Solicitud

Puedes obtener la configuración IP actual mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/networking/ipconfig

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta incluye la configuración IP en la siguiente plantilla.

{"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"
            },...
        ]
    },...
]}

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Establecer una dirección IP estática (configuración de IPV4)

Solicitud

Establece la configuración de IPV4 con IP estática y DNS. Si no se especifica una IP estática, habilita DHCP. Si se especifica una IP estática, también se debe especificar DNS.

Método	URI de la solicitud
PUT	/api/networking/ipv4config

Parámetros de URI

Parámetro de URI	Descripción
AdapterName	(obligatorio) GUID de la interfaz de red.
IPAddress	Dirección IP estática que se va a establecer.
SubnetMask	(obligatorio si IPAddress no es null) Máscara de subred estática.
DefaultGateway	(obligatorio si IPAddress no es null) Puerta de enlace estática predeterminada.
PrimaryDNS	(obligatorio si IPAddress no es null) El DNS estático primario no se ha establecido.
SecondayDNS	(obligatorio si IPAddress no es null) El DNS estático secundario no se ha establecido.

Para mayor claridad, para establecer una interfaz en DHCP, serializa solo AdapterName en la conexión:

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

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Enumerar las interfaces de red inalámbrica

Solicitud

Puedes enumerar las interfaces de red inalámbrica disponibles mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/wifi/interfaces

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Una lista de las interfaces inalámbricas disponibles con detalles en el siguiente formato.

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Enumerar redes inalámbricas

Solicitud

Puedes enumerar la lista de redes inalámbricas en la interfaz especificada mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/wifi/networks

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
interfaz	(obligatorio) GUID de la interfaz de red que se usa para buscar redes inalámbricas, sin corchetes.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Lista de redes inalámbricas encontradas en la interfaz proporcionada. Esto incluye detalles para las redes en el siguiente formato.

{"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,...]
    },...
]}

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Conectar y desconectar en una red Wi-Fi.

Solicitud

Puedes conectarte a una red Wi-Fi o desconectarte de ella mediante el siguiente formato de solicitud.

Método	URI de solicitud
POST	/api/wifi/network

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
interfaz	(obligatorio) GUID de la interfaz de red que se usa para conectarse a la red.
op	(obligatorio) Indica la acción que se debe realizar. Los valores posibles son connect o disconnect.
ssid	(obligatorio si op == conectar) SSID al que se debe conectar.
key	( obligatorio si op == conectar y la red requiere autenticación**) Clave compartida.
createprofile	(obligatorio) Crea un perfil de la red en el dispositivo. Esto hará que el dispositivo se conecte a la red automáticamente en el futuro. Esto puede ser sí o no.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Eliminar un perfil de Wi-Fi

Solicitud

Puedes eliminar un perfil asociado con una red en una interfaz específica mediante el siguiente formato de solicitud.

Método	URI de solicitud
DELETE	/api/wifi/profile

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
interfaz	(obligatorio) GUID de la interfaz de red asociado con el perfil que se debe eliminar.
perfil	(obligatorio) Nombre del perfil que se debe eliminar.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Informe de errores de Windows (WER)

Descargar un archivo de Informe de errores de Windows (WER)

Solicitud

Puedes descargar un archivo relacionado con WER mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/wer/report/file

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
usuario	(obligatorio) Nombre de usuario asociado con el informe.
tipo	(obligatorio) Tipo de informe. Esto se puede consultar o archivar.
name	(obligatorio) Nombre del informe. Esto debe estar codificado en Base64.
file	(obligatorio) Nombre del archivo que se debe descargar del informe. Esto debe estar codificado en Base64.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La respuesta contiene el archivo solicitado.

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
HoloLens
IoT

Enumerar archivos en un Informe de errores de Windows (WER)

Solicitud

Puedes enumerar los archivos en un informe WER mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/wer/report/files

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
usuario	(obligatorio) Usuario asociado con el informe.
tipo	(obligatorio) Tipo de informe. Esto se puede consultar o archivar.
name	(obligatorio) Nombre del informe. Esto debe estar codificado en Base64.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

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

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
HoloLens
IoT

Enumerar en una lista los Informes de errores de Windows (WER)

Solicitud

Puedes obtener los informes WER mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/wer/reports

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Los informes WER en el siguiente formato.

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Escritorio de Windows
HoloLens
IoT

Windows Performance Recorder (WPR)

Iniciar el seguimiento con un perfil personalizado

Solicitud

Puedes cargar un perfil WPR e iniciar un seguimiento con dicho perfil mediante el siguiente formato de solicitud. Solo se puede ejecutar un seguimiento cada vez. El perfil no permanecerá en el dispositivo.

Método	URI de solicitud
POST	/api/wpr/customtrace

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Un cuerpo HTTP que conforma varias partes que contiene el perfil WPR personalizado.

Respuesta

El estado de sesión WPR en el siguiente formato.

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
HoloLens
IoT

Iniciar una sesión de seguimiento del rendimiento de arranque

Solicitud

Puedes iniciar una sesión de seguimiento de WPR de arranque mediante el siguiente formato de solicitud. También se conoce como una sesión de seguimiento del rendimiento.

Método	URI de solicitud
POST	/api/wpr/boottrace

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
perfil	(obligatorio) Este parámetro es necesario en el inicio. Nombre del perfil que debe iniciar una sesión de seguimiento del rendimiento. Los perfiles posibles se almacenan en perfprofiles/profiles.json.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

En Inicio, esta API devuelve el estado de sesión WPR en el siguiente formato.

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
HoloLens
IoT

Detener una sesión de seguimiento del rendimiento de arranque

Solicitud

Puedes detener una sesión de seguimiento de WPR de arranque mediante el siguiente formato de solicitud. También se conoce como una sesión de seguimiento del rendimiento.

Método	URI de solicitud
GET	/api/wpr/boottrace

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Ninguna. Nota: Esta es una operación de larga duración. Devolverá cuando el archivo ETL haya terminado de escribirse en disco.

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
HoloLens
IoT

Iniciar una sesión de seguimiento del rendimiento

Solicitud

Puedes iniciar una sesión de seguimiento de WPR mediante el siguiente formato de solicitud. También se conoce como una sesión de seguimiento del rendimiento. Solo se puede ejecutar un seguimiento cada vez.

Método	URI de solicitud
POST	/api/wpr/trace

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
perfil	(obligatorio) Nombre del perfil que debe iniciar una sesión de seguimiento del rendimiento. Los perfiles posibles se almacenan en perfprofiles/profiles.json.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

En Inicio, esta API devuelve el estado de sesión WPR en el siguiente formato.

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
HoloLens
IoT

Detener una sesión de seguimiento del rendimiento

Solicitud

Puedes detener una sesión de seguimiento de WPR mediante el siguiente formato de solicitud. También se conoce como una sesión de seguimiento del rendimiento.

Método	URI de solicitud
GET	/api/wpr/trace

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Ninguna. Nota: Esta es una operación de larga duración. Devolverá cuando el archivo ETL haya terminado de escribirse en disco.

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
HoloLens
IoT

Recuperar el estado de una sesión de seguimiento

Solicitud

Puedes recuperar el estado de la sesión actual de WPR mediante el siguiente formato de solicitud

Método	URI de solicitud
GET	/api/wpr/status

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

El estado de la sesión de seguimiento de WPR en el siguiente formato.

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
HoloLens
IoT

Lista de sesiones de seguimiento completadas (ETL)

Solicitud

Puedes obtener una lista del seguimientos de ETL en el dispositivo mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/wpr/tracefiles

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

La lista de sesiones de seguimiento completadas se proporciona en el siguiente formato.

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
HoloLens
IoT

Descargar una sesión de seguimiento (ETL)

Solicitud

Puedes descargar un archivo de seguimiento (seguimiento de arranque o el seguimiento de modo de usuario) mediante el siguiente formato de solicitud.

Método	URI de solicitud
GET	/api/wpr/tracefile

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
nombreDeArchivo	(obligatorio) El nombre del seguimiento ETL para descargar. Los encontrarás en /api/wpr/tracefiles

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Devuelve el archivo de seguimiento ETL.

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
HoloLens
IoT

Eliminar una sesión de seguimiento (ETL)

Solicitud

Puedes eliminar un archivo de seguimiento (seguimiento de arranque o el seguimiento de modo de usuario) mediante el siguiente formato de solicitud.

Método	URI de solicitud
DELETE	/api/wpr/tracefile

Parámetros de URI

Puedes especificar los siguientes parámetros adicionales en el URI de la solicitud:

Parámetro de URI	Descripción
nombreDeArchivo	(obligatorio) Nombre del seguimiento ETL que se debe eliminar. Los encontrarás en /api/wpr/tracefiles

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Devuelve el archivo de seguimiento ETL.

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
HoloLens
IoT

Etiquetas de DNS-SD

Ver etiquetas

Solicitud

Te permite ver las etiquetas aplicadas actualmente para el dispositivo. Estas se anuncian a través de los registros TXT de DNS-SD en la tecla T.

Método	URI de solicitud
GET	/api/dns-sd/tags

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta Las etiquetas aplicadas actualmente con el formato siguiente.

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
5XX	Error del servidor

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Eliminar etiquetas

Solicitud

Elimina todas las etiquetas anunciadas actualmente por DNS-SD.

Método	URI de solicitud
DELETE	/api/dns-sd/tags

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Ninguno

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
5XX	Error del servidor

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Eliminar etiqueta

Solicitud

Elimina una etiqueta anunciada actualmente por DNS-SD.

Método	URI de solicitud
DELETE	/api/dns-sd/tag

Parámetros de URI

Parámetro de URI	Descripción
tagValue	(obligatorio) La etiqueta que se debe quitar.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Ninguno

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Agregar una etiqueta

Solicitud

Agrega una etiqueta al anuncio de DNS-SD.

Método	URI de solicitud
POST	/api/dns-sd/tag

Parámetros de URI

Parámetro de URI	Descripción
tagValue	(obligatorio) La etiqueta que se debe agregar.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Ninguno

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
401	Desbordamiento del espacio de la etiqueta. Se produce si la etiqueta propuesta es demasiado larga para el registro de servicio de DNS-SD resultante.

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
Xbox
HoloLens
IoT

Explorador de archivos de la aplicación

Obtener carpetas conocidas

Solicitud

Obtén una lista de carpetas accesibles de nivel superior.

Método	URI de solicitud
GET	/api/filesystem/apps/knownfolders

Parámetros de URI

Ninguno

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta Las carpetas disponibles con el siguiente formato.

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

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Implementar la solicitud aceptada y que se está procesando
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
HoloLens
Xbox
IoT

Obtener archivos

Solicitud

Obtén una lista de los archivos que hay en una carpeta.

Método	URI de solicitud
GET	/api/filesystem/apps/files

Parámetros de URI

Parámetro de URI	Descripción
knownfolderid	(obligatorio) El directorio de nivel superior donde quieres la lista de archivos. Usa LocalAppData para obtener acceso a las aplicaciones transferidas localmente.
packagefullname	(*obligatorio si knownfolderid* == LocalAppData**) Nombre completo del paquete de la aplicación que te interesa.
path	(opcional) El subdirectorio dentro de la carpeta o el paquete especificado anteriormente.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta Las carpetas disponibles con el siguiente formato.

{"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
    },...
]}

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
HoloLens
Xbox
IoT

Descargar un archivo

Solicitud

Obtener un archivo de una carpeta conocida o appLocalData.

Método	URI de solicitud
GET	/api/filesystem/apps/file

Parámetros de URI

Parámetro de URI	Descripción
knownfolderid	(obligatorio) El directorio de nivel superior donde deseas descargar los archivos. Usa LocalAppData para obtener acceso a las aplicaciones transferidas localmente.
nombreDeArchivo	(obligatorio) El nombre del archivo que se va a descargar.
packagefullname	(*obligatorio si knownfolderid* == LocalAppData**) Nombre completo del paquete que te interesa.
path	(opcional) El subdirectorio dentro de la carpeta o el paquete especificado anteriormente.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

El archivo solicitado, si se encuentra presente.

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	El archivo solicitado
404	Archivo no encontrado
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
HoloLens
Xbox
IoT

Cambiar el nombre de un archivo

Solicitud

Cambiar el nombre de un archivo de una carpeta.

Método	URI de solicitud
POST	/api/filesystem/apps/rename

Parámetros de URI

Parámetro de URI	Descripción
knownfolderid	(obligatorio) El directorio de nivel superior en el que se encuentra el archivo. Usa LocalAppData para obtener acceso a las aplicaciones transferidas localmente.
nombreDeArchivo	(obligatorio) El nombre original del archivo cuyo nombre se va a cambiar.
newfilename	(obligatorio) El nuevo nombre del archivo.
packagefullname	(*obligatorio si knownfolderid* == LocalAppData**) Nombre completo del paquete de la aplicación que te interesa.
path	(opcional) El subdirectorio dentro de la carpeta o el paquete especificado anteriormente.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Ninguno

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar. Se cambia el nombre del archivo.
404	Archivo no encontrado
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
HoloLens
Xbox
IoT

Eliminar un archivo

Solicitud

Elimina un archivo de una carpeta.

Método	URI de solicitud
DELETE	/api/filesystem/apps/file

Parámetros de URI

Parámetro de URI	Descripción
knownfolderid	(obligatorio) El directorio de nivel superior del que quieres eliminar los archivos. Usa LocalAppData para obtener acceso a las aplicaciones transferidas localmente.
nombreDeArchivo	(obligatorio) El nombre del archivo que se va a eliminar.
packagefullname	(*obligatorio si knownfolderid* == LocalAppData**) Nombre completo del paquete de la aplicación que te interesa.
path	(opcional) El subdirectorio dentro de la carpeta o el paquete especificado anteriormente.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Ninguno

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar. Se elimina el archivo.
404	Archivo no encontrado
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
HoloLens
Xbox
IoT

Cargar un archivo

Solicitud

Carga un archivo en una carpeta. Esto sobrescribirá cualquier archivo existente que tenga el mismo nombre, pero no creará carpetas nuevas.

Método	URI de solicitud
POST	/api/filesystem/apps/file

Parámetros de URI

Parámetro de URI	Descripción
knownfolderid	(obligatorio) El directorio de nivel superior donde quieres cargar los archivos. Usa LocalAppData para obtener acceso a las aplicaciones transferidas localmente.
packagefullname	(*obligatorio si knownfolderid* == LocalAppData**) Nombre completo del paquete de la aplicación que te interesa.
extract	(obligatorio) True o false. Esto indica si el archivo se debe extraer después de la carga.
path	(opcional) El subdirectorio dentro de la carpeta o el paquete especificado anteriormente.

Encabezados de solicitud

Ninguno

Cuerpo de la solicitud

Ninguno

Respuesta

Código de estado

Esta API tiene los siguientes códigos de estado previstos.

Código de estado HTTP	Descripción
200	Aceptar. El archivo se carga.
4XX	Códigos de error
5XX	Códigos de error

Familias de dispositivos disponibles

Windows Mobile
Escritorio de Windows
HoloLens
Xbox
IoT

Referencia de las API de REST principales del Portal de dispositivos Windows

Implementación de la aplicación

Instalar una aplicación

Instalar un conjunto relacionado

Registrar una aplicación en una carpeta dinámica

Registrar un conjunto relacionado en carpetas de archivos dinámicos

Obtener el estado de instalación de la aplicación

Desinstalar una aplicación

Obtener aplicaciones instaladas

Bluetooth

Obtener las radios Bluetooth en la máquina

Activar o desactivar la radio Bluetooth

Obtener una lista de dispositivos Bluetooth emparejados

Obtener una lista de dispositivos Bluetooth disponibles

Conectar un dispositivo Bluetooth

Desconectar un dispositivo Bluetooth

Administrador de dispositivos

Obtener los dispositivos instalados en la máquina

Obtener datos sobre dispositivos o concentradores USB conectados

Colección de volcados de memoria

Obtener la lista de todos los volcados de memoria de aplicaciones

Obtener la configuración de la colección de volcado de memoria de una aplicación

Eliminar un volcado de memoria de una aplicación transferida localmente

Deshabilitar volcados de memoria de una aplicación transferida localmente

Descargar el volcado de memoria de una aplicación transferida localmente

Habilitar los volcados de memoria de una aplicación transferida localmente

Obtener la lista de archivos de comprobación de errores

Descargar un archivo de volcado de memoria de comprobación de errores

Obtener la configuración de control de bloqueo de comprobación de errores

Obtener un volcado de memoria de kernel dinámico

Obtener un volcado de memoria de un proceso de usuario dinámico

Establecer la configuración de control de bloqueo de comprobación de errores

ETW

Crear una sesión ETW en tiempo real a través de un WebSocket

Comandos de ETW WebSocket

Enumerar los proveedores de ETW registrados

Enumerar los proveedores de ETW personalizados expuestos por la plataforma.

Ubicación

Obtener el modo de invalidación de ubicación

Establecer el modo de invalidación de ubicación

Obtener la posición inyectada

Establecer la posición inyectada

Información del SO

Obtener el nombre de la máquina

Obtener la información del sistema operativo

Obtén la familia de dispositivos.

Establecer el nombre de la máquina

Información de usuario

Obtener el usuario activo

Datos de rendimiento

Obtener la lista de procesos en ejecución

Obtener las estadísticas de rendimiento del sistema

Potencia

Obtener el estado actual de la batería

Obtener el plan de energía activo

Obtener el subvalor de un plan de energía

Obtener el estado de energía del sistema

Establecer el plan de energía activo

Establecer el subvalor de un plan de energía

Obtener un informe de estudio de suspensión

Enumerar los informes de estudio de suspensión disponibles

Obtener la transformación de estudio de suspensión

Control remoto

Reiniciar el equipo de destino

Apagar el equipo de destino

Administrador de tareas

Iniciar una aplicación moderna

Detener una aplicación moderna

Eliminar el proceso por PID

Funciones de red

Obtener la configuración IP actual

Establecer una dirección IP estática (configuración de IPV4)

Enumerar las interfaces de red inalámbrica

Enumerar redes inalámbricas

Conectar y desconectar en una red Wi-Fi.

Eliminar un perfil de Wi-Fi

Informe de errores de Windows (WER)

Descargar un archivo de Informe de errores de Windows (WER)

Enumerar archivos en un Informe de errores de Windows (WER)

Enumerar en una lista los Informes de errores de Windows (WER)