API docs by Redocly

reporting API (develop:84871a)

Download OpenAPI specification:

License: None

Automatically generated swagger spec for the reporting stack.

ReportingService

Delete JDBC connection for an account

Deletes the JDBC connection configured for the given account.

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{ }

Get additional reportings for an account

Returns the additional reporting URLs configured for the given account.

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "additionalReportings": [
    ]
}

Get building rent reports

Returns rent reports for the given building IDs, including gross and net target, actual, and overall rents per year.

Request Body schema: application/json
required
buildingIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "buildingIds": [
    ]
}

Response samples

Content type
application/json
{
  • "reports": [
    ]
}

Get building rent reports

Returns rent reports for the given building IDs, including gross and net target, actual, and overall rents per year.

path Parameters
buildingIds
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{
  • "reports": [
    ]
}

Get default reportings

Returns the global default reporting URLs for owner, asset, admin, market, and finance base categories. The request has no parameters.

Responses

Response samples

Content type
application/json
{
  • "adminBase": [
    ],
  • "assetBase": [
    ],
  • "financeBase": [
    ],
  • "marketBase": [
    ],
  • "ownerBase": [
    ]
}

List JDBC connections

Returns all configured JDBC connections. The request has no parameters.

Responses

Response samples

Content type
application/json
{
  • "connections": [
    ]
}

Get reportings for the current caller

Returns default and additional reporting URLs available to the authenticated caller. The request has no parameters.

Responses

Response samples

Content type
application/json
{
  • "additionalReportings": [
    ],
  • "defaultReportings": [
    ]
}

Get property rent reports

Returns rent reports for the given property IDs, including gross and net target, actual, and overall rents per year.

path Parameters
propertyIds
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{
  • "reports": [
    ]
}

Get reporting URLs for an account

Returns the reporting URL configuration for the given account, including overview and category-specific URL lists.

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "reportingUrls": {
    }
}

Check if account has JDBC connection

Returns whether a JDBC connection is configured for the given account.

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "hasJdbcConnection": true
}

Set additional reportings for an account

Sets the additional reporting URLs for the given account.

path Parameters
accountId
required
string <int64>
Request Body schema: application/json
required
Array of objects (reportingReportingUrl)

Responses

Request samples

Content type
application/json
{
  • "additionalReportings": [
    ]
}

Response samples

Content type
application/json
{ }

Set default reportings

Sets the global default reporting URLs for owner, asset, admin, market, and finance base categories.

Request Body schema: application/json
required
required
Array of objects (reportingReportingUrl)
required
Array of objects (reportingReportingUrl)
required
Array of objects (reportingReportingUrl)
required
Array of objects (reportingReportingUrl)
required
Array of objects (reportingReportingUrl)

Responses

Request samples

Content type
application/json
{
  • "adminBase": [
    ],
  • "assetBase": [
    ],
  • "financeBase": [
    ],
  • "marketBase": [
    ],
  • "ownerBase": [
    ]
}

Response samples

Content type
application/json
{ }

Set JDBC connection for an account

Stores JDBC connection details (host, username, password, client) for the given account.

path Parameters
accountId
required
string <int64>
Request Body schema: application/json
required
client
string
host
string
password
string
username
string

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "host": "string",
  • "password": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{ }

Set reporting URL permissions

Sets the allowed user IDs for a reporting URL on the given account.

Request Body schema: application/json
required
accountId
required
string <int64>
allowedUserIds
required
Array of strings
url
required
string

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "allowedUserIds": [
    ],
  • "url": "string"
}

Response samples

Content type
application/json
{ }

Set reporting URLs for an account

Sets reporting URL collections for the given account across overview, role-specific overview, administration, marketing, accounting, tenant list, and publish history categories.

path Parameters
accountId
required
string <int64>
Request Body schema: application/json
required
Array of objects (reportingReportingUrl)
Array of objects (reportingReportingUrl)
Array of objects (reportingReportingUrl)
Array of objects (reportingReportingUrl)
Array of objects (reportingReportingUrl)
Array of objects (reportingReportingUrl)
Array of objects (reportingReportingUrl)
Array of objects (reportingReportingUrl)
Array of objects (reportingReportingUrl)
Array of objects (reportingReportingUrl)
Array of objects (reportingReportingUrl)

Responses

Request samples

Content type
application/json
{
  • "accounting": [
    ],
  • "accountingOverview": [
    ],
  • "adminOverview": [
    ],
  • "administration": [
    ],
  • "assetOverview": [
    ],
  • "marketing": [
    ],
  • "marketingOverview": [
    ],
  • "overview": [
    ],
  • "ownerOverview": [
    ],
  • "publishHistory": [
    ],
  • "tenantList": [
    ]
}

Response samples

Content type
application/json
{ }