Folders

This chapter focuses on services for the folders.

get Get folder

A GET to /folders/{id} returns the folder with the given id.

Path parameters

Table 1. /api/rest/latest/folders/{id}
Parameter Description

id

the id of the folder

HTTP request

GET /api/rest/latest/folders/44 HTTP/1.1
Accept: application/json
Host: localhost:8080

Request parameters

Parameter Description

fields

which fields of the elements should be returned (optional)

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 70

{
  "entity_type" : "FOLDER",
  "id" : 44,
  "name" : "First folder"
}

Response fields

Path Type Description

entity_type

String

the type of the entity

id

Number

the id of the folder

name

String

the name of the folder

Snippet links not found for operation::RestReportingControllerIT/get-folder

delete Delete folders

A DELETE to /folders/{ids} deletes one or several folder(s) with the given id(s).

Path parameters

Table 1. /api/rest/latest/folders/{ids}
Parameter Description

ids

the list of ids of the folders

HTTP request

DELETE /api/rest/latest/folders/169,189 HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: localhost:8080