API docs by Redocly

reporting API (develop:c14720)

Download OpenAPI specification:

License: None

Automatically generated swagger spec for the reporting stack.

ReportingService

ReportingService_DeleteJdbcConnection

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{ }

ReportingService_GetAdditionalReportings

path Parameters
accountId
required
string <int64>

Responses

Response samples

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

ReportingService_GetBuildingRentReports2

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": [
    ]
}

ReportingService_GetBuildingRentReports

path Parameters
buildingIds
required
Array of strings non-empty

Responses

Response samples

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

ReportingService_GetDefaultReportings

Responses

Response samples

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

ReportingService_GetJdbcConnections

Responses

Response samples

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

ReportingService_GetMyReportings

Responses

Response samples

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

ReportingService_GetPropertyRentReports

path Parameters
propertyIds
required
Array of strings non-empty

Responses

Response samples

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

ReportingService_GetReportingUrls

path Parameters
accountId
required
string <int64>

Responses

Response samples

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

ReportingService_HasJdbcConnection

path Parameters
accountId
required
string <int64>

Responses

Response samples

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

ReportingService_SetAdditionalReportings

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
{ }

ReportingService_SetDefaultReportings

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
{ }

ReportingService_SetJdbcConnection

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
{ }

ReportingService_SetReportingPermissions

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
{ }

ReportingService_SetReportingUrls

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
{ }