Custom export

This chapter focuses on services for the custom exports.

get Get custom export

A GET to /custom-exports/{id} returns the custom export with the given id.

Path parameters

Table 1. /api/rest/latest/custom-exports/{id}
Parameter Description

id

the id of the custom export

HTTP request

GET /api/rest/latest/custom-exports/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: 84

{
  "entity_type" : "CUSTOM_EXPORT",
  "id" : 44,
  "name" : "First custom export"
}

Response fields

Path Type Description

entity_type

String

the type of the entity

id

Number

the id of the custom export

name

String

the name of the custom export

Snippet links not found for operation::RestReportingControllerIT/get-custom-export

delete Delete custom exports

A DELETE to /custom-exports/{ids} deletes one or several custom export(s) with the given id(s).

Path parameters

Table 1. /api/rest/latest/custom-exports/{ids}
Parameter Description

ids

the list of ids of the custom exports

HTTP request

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