POST 1.0/{InstanceId}/Folders

Creates a new Folder and its corresponding permission entries

Request Information

URI Parameters

API Parameter Details
NameDescriptionTypeAdditional information
InstanceId

The instance ID relating to a specific ADM database

string

Required

Body Parameters

Object containing the folder details and permission entries

CreateUpdateFolderRequest
API Parameter Details
NameDescriptionTypeAdditional information
Name

Folder name

string

Required

NodeType

Folder Type

FolderNodeType

Required

ParentId

Folder Parent Id

integer

Required

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "NodeType": "FilingRoot",
  "ParentId": 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 'CreateUpdateFolderRequest'.

Response Information

Resource Description

Returns "Created" and the id / uri if the folder 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"
}