Configurer un appareil

Cette page explique comment configurer un ou plusieurs appareils via les endpoints de l'API Pulse MDM.

Settings

Ci-dessous sont listés les champs que vous pouvez modifier dans la configuration:

{
  "isOfflineEnabled": boolean, // true
  "isContentDownloadAllowed": boolean, // true
  "isLanDiscoveryEnabled": boolean, // true
  "isScreensharingEnabled": boolean, // true
  "isLanIntercomEnabled": boolean, // true
  "expirationDate": Date, // null
  "kioskMode": {
    "isActive": boolean,
    "packageName": string
  },
  "volume": number,
  "developerSettingsAllowed": boolean,
  "applications": [Application],
  "videos": [
    {
      "id": string,
      "idDetailContent": string | null,
      "title": string,
      "url": string,
      "posterUrl": string,
      "vignetteUrl": string,
      "isStereoscopic": boolean,
      "projectionType": "flat" | "sphere" | "dome" | "full_dome" | "cube",
      "formatType": "2D" | "3D_Side_By_Side" | "3D_Over_Under",
      "synopsis": string,
      "description": string
    }
  ],
  "files": [
    {
      "url": string,
      "name": string
    }
  ],
  "packages": [
    string
  ],
  "batteryInfo": {
    "level": number, 
    "isCharging": boolean, 
    "health": [
      "Good", "Overheat", "Dead", "Over Voltage", "Unknown"
    ], 
    "temperature": number, 
    "voltage": number
  },
  "storages": [
    {
      "volumeDescription": string,
      "totalSpace": number,
      "freeSpace": number, 
      "usedSpace": number,
      "isRemovable": boolean
    }
  ],
  "wifi": [
    {
      "ssid": string,
      "password": string,
      "hidden": boolean, 
      "priority": number, 
      "proxySettings": {
        "use": boolean,
        "host": string,
        "port": number,
        "byPass": string
      }
    }
  ]
}

Supprimer une entrée des tableaux videos[], files[] ou applications[] supprimera l'entrée de l'appareil.

Modifier le code de version de l'application réinstallera l'application sur l'appareil avec l'url présent.

Un même packageName ne peut pas désigner deux binaires Android différents dans le tableau envoyé. L'identité prend notamment en compte id, idDetailContent, url, codeVersion et obbUrl. En cas de conflit, toute la requête est refusée avec le statut 422 et le code stable PACKAGE_NAME_CONFLICT ; aucune configuration partielle n'est appliquée. Lorsque plusieurs entrées sont strictement identiques, la dernière est retenue afin que les métadonnées les plus récentes, comme expirationDate, soient appliquées.

Sur un appareil

PUT /devices/{id}/configure

Configure les paramètres d'un appareil

Headers

Name	Value
Content-Type	`application/json`
Authorization	`Bearer <token>`

Body

Name	Type	Description
settings	object	Envoyer directement l'objet de settings à appliquer sur l'appareil

Response

{
  "device": Device,
  "success": bool
}

{
  "error": "Device not found"
}

{
  "code": "PACKAGE_NAME_CONFLICT",
  "message": "Plusieurs applications différentes utilisent le même package Android : com.example.player",
  "conflicts": [
    {
      "packageName": "com.example.player",
      "applications": [
        { "id": "app-a", "packageName": "com.example.player", "codeVersion": 12 },
        { "id": "app-b", "packageName": "com.example.player", "codeVersion": 14 }
      ]
    }
  ]
}

{
  "message": error.message
}

Sur plusieurs appareils

PUT /devices/configure

Configure les paramètres sur plusieurs appareils