Reporting Folders

This chapter focuses on services for the reporting folders.

get Get reporting folder

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

Path parameters

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

id

the id of the reporting folder

HTTP request

GET /api/rest/latest/reporting-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: 184

{
  "entity_type" : "FOLDER",
  "id" : 44,
  "name" : "First folder",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/custom-exports/44"
    }
  }
}

Response fields

Path Type Description

entity_type

String

the type of the entity

id

Number

the id of the reporting folder

name

String

the name of the reporting folder

_links

Object

related links

Relation Description

self

link to this reporting folder

delete Delete reporting folders

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

Path parameters

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

ids

the list of ids of the reporting folders

HTTP request

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