Zum Hauptinhalt springen

Create Report REST

Creating a Report via REST

You can create a report from third-party systems by sending an HTTP POST request to brixxbox.

We have created a Postman solution to demonstrate the call, since you need to log in first. Run in Postman

In Postman, 3 environment variables must be set: "UserEmail" and "UserPassword" for the login call, and "Workspace" for the URL part of the CreatePdf call.

You can specify in the POST parameters whether the report should be archived or not:

// POST call to https://app.brixxbox.net/w/{{Workspace}}/c/default/reporting/CreatePdf
{
"reportName": "addresslist",

//optional parameters
"archive": false, //optional, false is default
"configName": "address", //optional, only if you want to archive
"documentTypeId": 1, //optional, only valid if configName and parameter 'id' are set and archive is true
"culture": "de-DE", //optional, report has its default values
"parameters": { //optional
"id": 1
}
}