Exports
Exports API documentation
Download Exports OpenAPI Document
End Points
Export History
Delete exported report
Send Export via Email
Download Exported File
Attribute
id
string
Unique id for the export
name
string
display name for the export
format
string
Type of the export file
started_time
string
Started time of th export
status
string
Status of the export job
Available export status
Available export status
- started
- scheduled
- failed
- exporting
- completed
- cancelling
- stopped
- initializing
total_objects
string
total count of the export file
{
"id": 2090900001000,
"name": "Active User Sessions",
"format": "csv",
"started_time": "2020-02-08T09:30:26.000Z",
"status": "completed",
"total_objects": 1007
}
Export History
Retrieves a list of all export jobs, with options to filter by status and paginate results.
Query Parameters
status
Filter exports by their status.
limit
The maximum number of export records to return.
from
The starting index of the export records to return.
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/exports"
type: GET
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://id360.manageengine.com/api/v1/exports")
.get()
.build();
Response response = client.newCall(request).execute();
const options = {method: 'GET'};
fetch('https://id360.manageengine.com/api/v1/exports', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("id360.manageengine.com")
conn.request("GET", "/api/v1/exports")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "id360.manageengine.com",
"port": null,
"path": "/api/v1/exports",
"headers": {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url https://id360.manageengine.com/api/v1/exports
{
"data": [
{
"id": 2090900001000,
"name": "Active User Sessions",
"format": "csv",
"started_time": "2020-02-08T09:30:26.000Z",
"status": "completed",
"total_objects": 1007
}
],
"meta": {
"start_index": 1,
"limit": 50,
"total_no_of_objects": 1
}
}
Delete exported report
Deletes a specific exported report.
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/exports/2000000146357"
type: DELETE
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://id360.manageengine.com/api/v1/exports/2000000146357")
.delete(null)
.build();
Response response = client.newCall(request).execute();
const options = {method: 'DELETE'};
fetch('https://id360.manageengine.com/api/v1/exports/2000000146357', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("id360.manageengine.com")
conn.request("DELETE", "/api/v1/exports/2000000146357")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "DELETE",
"hostname": "id360.manageengine.com",
"port": null,
"path": "/api/v1/exports/2000000146357",
"headers": {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request DELETE \
--url https://id360.manageengine.com/api/v1/exports/2000000146357
Send Export via Email
Sends an exported report via email using a specified template.
Query Parameters
template_id
(Required)
The ID of the email template to use for sending the export.
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/exports/2000000146357/send-email?template_id=12345"
type: POST
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://id360.manageengine.com/api/v1/exports/2000000146357/send-email?template_id=12345")
.post(null)
.build();
Response response = client.newCall(request).execute();
const options = {method: 'POST'};
fetch('https://id360.manageengine.com/api/v1/exports/2000000146357/send-email?template_id=12345', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("id360.manageengine.com")
conn.request("POST", "/api/v1/exports/2000000146357/send-email?template_id=12345")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "id360.manageengine.com",
"port": null,
"path": "/api/v1/exports/2000000146357/send-email?template_id=12345",
"headers": {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request POST \
--url 'https://id360.manageengine.com/api/v1/exports/2000000146357/send-email?template_id=12345'
Download Exported File
Downloads the file for a completed export job.
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/exports/2000000146357/download"
type: GET
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://id360.manageengine.com/api/v1/exports/2000000146357/download")
.get()
.build();
Response response = client.newCall(request).execute();
const options = {method: 'GET'};
fetch('https://id360.manageengine.com/api/v1/exports/2000000146357/download', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("id360.manageengine.com")
conn.request("GET", "/api/v1/exports/2000000146357/download")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "id360.manageengine.com",
"port": null,
"path": "/api/v1/exports/2000000146357/download",
"headers": {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url https://id360.manageengine.com/api/v1/exports/2000000146357/download
"file-content"