Folders

Update Folder

Folders give the ability to the user to organize and find better their reports.

Notes

  • A Folder can not have the same name.
  • A Folder may have a parent or may not.
  • A Folder can not have as parent_id himself.
  • The max level of nested folders is 3. Below there is an example of the max level allowed.
Financial
│
└───Bar
    │
    └───Food

put/datainsights/v1.1/folders/{id}

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Path parameters

idinteger required

Folder Id

Headers

X-PROPERTY-IDinteger required

Property id of the client

Request body

idinteger required

Folder Id

namestring required

Folder Name

descriptionstring

Folder description

parent_idinteger nullable required

Id of the Parent Folder

Example request

{
  "name": "My Reports",
  "description": "Contains all my reports"
}

Response

OK

idinteger required

Folder Id

namestring required

Folder Name

descriptionstring

Folder description

parent_idinteger nullable required

Id of the Parent Folder

Example response

{
  "name": "My Reports",
  "description": "Contains all my reports"
}

Changes

No recorded changes to this operation across all 1 revision of this API.