PUT groups/{id}

Updates an existing group.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The identifier of the group.

integer

Required

Body Parameters

The model containing the information to update the group.

GroupViewModel
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

Filterable

Settable

Description

string

Settable

Type

GroupTypeViewModel

Filterable

Settable

Chief

BaseViewModel

Includable

Users

IGenericPaginatedListViewModelOfBaseViewModel

Includable

SelfUrl

string

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "name": "sample string 2",
  "description": "sample string 3",
  "type": {
    "name": "sample string 1",
    "displayName": "sample string 2",
    "selfUrl": "sample string 3"
  },
  "chief": {
    "selfUrl": "sample string 1"
  },
  "users": null,
  "selfUrl": "sample string 4"
}

Response Information

Resource Description

GroupViewModel
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

Filterable

Settable

Description

string

Settable

Type

GroupTypeViewModel

Filterable

Settable

Chief

BaseViewModel

Includable

Users

IGenericPaginatedListViewModelOfBaseViewModel

Includable

SelfUrl

string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "name": "sample string 2",
  "description": "sample string 3",
  "type": {
    "name": "sample string 1",
    "displayName": "sample string 2",
    "selfUrl": "sample string 3"
  },
  "chief": {
    "selfUrl": "sample string 1"
  },
  "users": null,
  "selfUrl": "sample string 4"
}