DeviceProfileSave

Realm Operations

Resource path:

/realm-config/authentication/authenticationtrees/nodes/DeviceSaveNode

Resource version: 1.0

create

Usage

am> create DeviceProfileSave --realm Realm --id id --body body

Parameters

--id

The unique identifier for the resource.

--body

The resource in JSON format, described by the following JSON schema:

{
  "type" : "object",
  "properties" : {
    "variableName" : {
      "title" : "Device Name Variable",
      "description" : "Specify an existing variable name, in shared state, that contains the value to use as this device's name.",
      "propertyOrder" : 100,
      "type" : "string",
      "exampleValue" : ""
    },
    "saveDeviceLocation" : {
      "title" : "Save Device Location",
      "description" : "Specify whether device location should be saved.",
      "propertyOrder" : 400,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "saveDeviceMetadata" : {
      "title" : "Save Device Metadata",
      "description" : "Specify whether device metadata should be saved.",
      "propertyOrder" : 300,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "maxSavedProfiles" : {
      "title" : "Maximum Saved Profiles",
      "description" : "Specify the maximum number of device profiles to save in a user's profile. When the maximum is reached, saving a new profile replaces the least-recently used profile.",
      "propertyOrder" : 200,
      "type" : "integer",
      "exampleValue" : ""
    }
  },
  "required" : [ "maxSavedProfiles", "saveDeviceMetadata", "saveDeviceLocation", "variableName" ]
}

delete

Usage

am> delete DeviceProfileSave --realm Realm --id id

Parameters

--id

The unique identifier for the resource.

getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

Usage

am> action DeviceProfileSave --realm Realm --actionName getAllTypes

getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

Usage

am> action DeviceProfileSave --realm Realm --actionName getCreatableTypes

listOutcomes

List the available outcomes for the node type.

Usage

am> action DeviceProfileSave --realm Realm --body body --actionName listOutcomes

Parameters

--body

The resource in JSON format, described by the following JSON schema:

{
  "type" : "object",
  "title" : "Some configuration of the node. This does not need to be complete against the configuration schema."
}

nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

Usage

am> action DeviceProfileSave --realm Realm --actionName nextdescendents

query

Get the full list of instances of this collection. This query only supports _queryFilter=true filter.

Usage

am> query DeviceProfileSave --realm Realm --filter filter

Parameters

--filter

A CREST formatted query filter, where "true" will query all.

read

Usage

am> read DeviceProfileSave --realm Realm --id id

Parameters

--id

The unique identifier for the resource.

update

Usage

am> update DeviceProfileSave --realm Realm --id id --body body

Parameters

--id

The unique identifier for the resource.

--body

The resource in JSON format, described by the following JSON schema:

{
  "type" : "object",
  "properties" : {
    "variableName" : {
      "title" : "Device Name Variable",
      "description" : "Specify an existing variable name, in shared state, that contains the value to use as this device's name.",
      "propertyOrder" : 100,
      "type" : "string",
      "exampleValue" : ""
    },
    "saveDeviceLocation" : {
      "title" : "Save Device Location",
      "description" : "Specify whether device location should be saved.",
      "propertyOrder" : 400,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "saveDeviceMetadata" : {
      "title" : "Save Device Metadata",
      "description" : "Specify whether device metadata should be saved.",
      "propertyOrder" : 300,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "maxSavedProfiles" : {
      "title" : "Maximum Saved Profiles",
      "description" : "Specify the maximum number of device profiles to save in a user's profile. When the maximum is reached, saving a new profile replaces the least-recently used profile.",
      "propertyOrder" : 200,
      "type" : "integer",
      "exampleValue" : ""
    }
  },
  "required" : [ "maxSavedProfiles", "saveDeviceMetadata", "saveDeviceLocation", "variableName" ]
}