POST 1.0/{InstanceId}/Groups

Creates a new group

Request Information

URI Parameters

API Parameter Details
NameDescriptionTypeAdditional information
InstanceId

The instance ID relating to a specific ADM database

 string

Required

Body Parameters

Contains details of the document group to be created

CreateUpdateGroupRequest
API Parameter Details
NameDescriptionTypeAdditional information
Name

The name of this document group

 string

Required
Description

The description of this document group

 string

Required

Request Formats

application/json, text/json

Sample: 
{
  "Name": "sample string 1",
  "Description": "sample string 2"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreateUpdateGroupRequest'.

Response Information

Resource Description

Returns "Created" and the id / uri if the document group was created successfully, otherwise an appropriate error message

CreatedResourceResponse
API Parameter Details
NameDescriptionTypeAdditional information
Id

The id of the newly created resource

 integer

None.
Uri

The Uri location of the newly created resource

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "Uri": "sample string 2"
}