Report Services
Request Body
{
"name": "PurchaseOrder",
"cantaraVersion": "5.1",
"tenantId": "",
"apiKey": "",
"parameter": [],
"criteriaParameter": [
{
"criteriaLiteral": [
""
],
"name": "Documentorderinvoice"
},
{
"criteriaLiteral": [
""
],
"name": "StatusCodeNext"
}
],
"printImmediate": false,
"batchQueue": "QBATCH",
"createCSV": false
}
Request Body Parameters
Path | Description |
---|---|
name | Report service name |
cantaraVersion | Cantara platform version |
tenantId | Cantara Tenant ID (The Tenant ID and API Key can be retrieved from the customer portal.) |
apiKey | Cantara Tenant API Key (The Tenant ID and API Key can be retrieved from the customer portal.) |
Parameter/criteria parameter | Report request parameters |
printImmediate | To print reports |
batchQueue | Override JDE batch execution queue |
createCSV | To create CSV file |
Execute Reports
Example for executing Reports service - PurchaseOrder Report
Example Endpoint: https://us.cantara.cloud/cantara/serivce/50/report/E1DEV
In this example we will call the Purchase Order print UBE (R43500).
Before building our payload we need to view the required parameters and criteria parameters for the purchase order print UBE. By looking at the reports definition in the Cantara console we can see that one of the criteria parameters is the StatusCodeNext and one of the parameters is the Documentorderinvoice.
With this information we can now call the report service.
Reports Request
{
"name": "PurchaseOrder",
"cantaraVersion": "5.1",
"tenantId": "",
"apiKey": "",
"parameter": [],
"criteriaParameter": [
{
"criteriaLiteral": [
"12345"
],
"name": "Documentorderinvoice"
},
{
"criteriaLiteral": [
"999"
],
"name": "StatusCodeNext"
}
],
"printImmediate": false,
"batchQueue": "QBATCH",
"createCSV": false
}
Reports Response
{
"Message": {
"value": "Transaction Successful",
"origin": "Worker7@6c101b96c994",
"type": 0,
"sessionId": "",
"cantaraSid": "0a7eb2d5-baef-4dd2-9a39-d6d691e1f8e9"
},
"name": "PurchaseOrder",
"jobId": 152,
"reportName": "R43500",
"reportVersion": "XJDE0001"
}