Custom export
This chapter focuses on services for the custom exports.
Get custom export
A GET
to /custom-exports/{id}
returns the custom export with the given id.
Path parameters
Parameter | Description |
---|---|
|
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 |
---|---|
|
which fields of the elements should be returned (optional) |
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 198
{
"entity_type" : "CUSTOM_EXPORT",
"id" : 44,
"name" : "First custom export",
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/custom-exports/44"
}
}
}
Response fields
Path | Type | Description |
---|---|---|
|
|
the type of the entity |
|
|
the id of the custom export |
|
|
the name of the custom export |
|
|
related links |
Links
Relation | Description |
---|---|
|
link to this custom export |
Delete custom exports
A DELETE
to /custom-exports/{ids}
deletes one or several custom export(s) with the given id(s).
Path parameters
Parameter | Description |
---|---|
|
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