API docs by Redocly

Aptic API Gateway - Reports (v1.0)

Download OpenAPI specification:Download

Aptic AB: api@aptic.net URL: https://www.aptic.net Terms of Service

Reporting related API for Aptic solutions

Reports

Receive a list of produced reports.

Authorizations:
(oauth2apikey)
query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Receive a list of available adhoc reports.

Authorizations:
(oauth2apikey)
query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Receive a list of argument for specified report.

Authorizations:
(oauth2apikey)
path Parameters
name
required
string

Name of report definition

Responses

Response samples

Content type
{
  • "title": "string",
  • "arguments": [
    ]
}

Generates an adhoc report using specified arguments

Authorizations:
(oauth2apikey)
path Parameters
name
required
string

Name of the report to generate

Request Body schema:

Arguments for generating the report

reportType
string or null

Type of report:

data = return data directly in response (default is null)

pdf = produce PDF report

xls = produce Excel report in xls format (old) xlsx = produce Excel report in xlsx format (new)

offset
integer or null <int32>

Offset in data result (only for type = data)

arguments
Array of strings or null

Array of additional report arguments

Responses

Request samples

Content type
{
  • "reportType": "string",
  • "offset": 0,
  • "arguments": [
    ]
}

Response samples

Content type
{
  • "reportType": "string",
  • "headers": [
    ],
  • "data": [
    ],
  • "footer": [
    ],
  • "reportGuid": "string"
}

Receive a list of available charts.

Authorizations:
(oauth2apikey)
query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Receive data of specified chart.

Authorizations:
(oauth2apikey)
path Parameters
name
required
string

Name of the chart

Request Body schema:

Any chart arguments

object (ChartDataArguments)

Arguments for fetching chart data

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "chartType": 0,
  • "showLegend": true,
  • "showTooltip": true,
  • "showTitle": true,
  • "horizontalAlignment": true,
  • "tooltipTemplate": "string",
  • "legendPosition": 0,
  • "titlePosition": 0,
  • "barChartSeries": [
    ],
  • "pieChartSeries": [
    ],
  • "lineChartSeries": [
    ],
  • "donutChartSeries": [
    ]
}

Receive data points for finance reporting of a specific template and period

Authorizations:
(oauth2apikey)
Request Body schema:

Report template name, e.g. IFRS 9.1.1 and period of time

templateName
string or null

Request report according to specific template

clientReferenceNumber
string or null

Request report for specific client using client reference number

clientGuid
string or null

Request report for specific client using client guid

dateFrom
string or null <date-time>

Report date from

dateTo
string or null <date-time>

Report date to

Responses

Request samples

Content type
{
  • "templateName": "string",
  • "clientReferenceNumber": "string",
  • "clientGuid": "string",
  • "dateFrom": "2019-08-24T14:15:22Z",
  • "dateTo": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "currencyCode": "string",
  • "dateFrom": "2019-08-24T14:15:22Z",
  • "dateTo": "2019-08-24T14:15:22Z",
  • "dataPoints": [
    ]
}

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return code 200 and an empty json object.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }

Reportstream

Downloads a produced report using the report GUID

Authorizations:
(oauth2apikey)
path Parameters
reportGuid
required
string

Report unique id

Responses

Response samples

Content type
No sample