POST environment/settings

Sets the default settings for the Environment of current API consumer.

Remarks

C4M Error Code returned:

  • EnvironmentNotFound

    The specified environment does not exist.

  • ///
  • GroupNotFound

    The specified group does not exist.

HTTP Status returned:
  • 403 - Forbidden

    The authenticated user doesn't have permission to access the resource.

Request Information

Parameters

NameDescriptionAdditional information
settingsRequest
Settings of the environment.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "defaultGroupId": 1,
  "deviceInactivityThreshold": 1
}

Response Information

Information about the authorized Environment as EnvironmentResponseDto.

Response body formats

application/json, text/json

Sample:
{
  "defaultGroup": {
    "enrollCode": "sample string 1",
    "fullName": "sample string 2",
    "id": 3,
    "name": "sample string 4",
    "parentFullName": "sample string 5",
    "parentGroupId": 1
  },
  "defaultGroupId": 1,
  "deviceInactivityThreshold": 1
}