GET Device Fleet Configuration

GET 
/workspaces/:workspaceId/device-fleet-configurations/:configurationName

Get an Device Fleet Configuration.

Request

Path Parameters

workspaceId uuidrequired
configurationName stringrequired

Responses

200

Device Fleet Configuration.

application/json

Schema

Schema

name string
createdTime date-time
lastUpdatedTime date-time
priority int32
targetCondition string
desiredPropertyPath string
desiredProperty

systemMetrics

object

targetedCount int64nullable

appliedCount int64nullable
contentVersion int64

Example (from schema)

{
  "name": "string",
  "createdTime": "2024-09-10T19:24:15.213Z",
  "lastUpdatedTime": "2024-09-10T19:24:15.213Z",
  "priority": 0,
  "targetCondition": "string",
  "desiredPropertyPath": "string",
  "desiredProperty": {},
  "systemMetrics": {
    "targetedCount": 0,
    "appliedCount": 0
  },
  "contentVersion": 0
}

example-1

{
  "name": "device-fleet-configuration-1",
  "priority": 1,
  "targetCondition": "properties.reported.test1.test2 = 'value'",
  "desiredPropertyPath": "mySettings.general",
  "desiredProperty": {
    "updateSettings": {
      "interval": 10
    }
  },
  "systemMetrics": {
    "targetedCount": 10,
    "appliedCount": 9
  },
  "createdTime": "2021-09-08T14:00:00+00:00",
  "lastUpdatedTime": "2021-09-08T14:00:00+00:00",
  "contentVersion": 1
}

404

Device Fleet Configuration or workspace not found.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

423

Workspace disabled.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...