Reports

This chapter focuses on services for the reports.

get Get report

A GET to /reports/{id} returns the report with the given id.

Path parameters

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

id

the id of the report

HTTP request

GET /api/rest/latest/reports/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" : "REPORT",
  "id" : 44,
  "name" : "First report",
  "_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 report

name

String

the name of the report

_links

Object

related links

Relation Description

self

link to this report

delete Delete reports

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

Path parameters

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

ids

the list of ids of the reports

HTTP request

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