[]
v8.1
(Showing Draft Content)

Reporting-CachingSettings

Reporting-CachingSettings

[GET] /api/v2/reporting/caching-settings/{reportId}

Gets caching settings for the report.

Parameters

Name Type Located In Description
reportIdRequired string path Report id. For example: 998118f9-40b2-4d28-87b3-ac0bf51397f9

Response

Status Code: 200

Success

CachingSettingsResponse

Status Code: 400

Bad Request

ReportingPluginError

Status Code: 403

Forbidden

ReportingPluginError

Status Code: 404

Not Found

ReportingPluginError

[PUT] /api/v2/reporting/caching-settings/{reportId}

Sets caching settings for the report.

Parameters

Name Type Located In Description
reportIdRequired string path Report id. For example: 998118f9-40b2-4d28-87b3-ac0bf51397f9

Request Schema

CachingSettingsUpdateRequest

Response

Status Code: 204

No Content

Status Code: 400

Bad Request

ReportingPluginError

Status Code: 403

Forbidden

ReportingPluginError

Status Code: 404

Not Found

ReportingPluginError

Models

Ƭ CachingSettingsResponse

Caching settings response model.

Name Type Description Example
reportCacheEnabled Boolean Caching is enabled for the report.
value int32 Caching interval value.
interval CachingInterval
type CachingType
allowUserToChangeExpiry Boolean Allow user to change caching interval and value.
allowUserToChangeType Boolean Allow user to change caching type.
cacheEnabled Boolean System caching is enabled.

Ƭ CachingInterval

Enum:

  • Hour
  • Day
  • Week
  • Month

Enumeration of possible caching intervals.

* Hour - 0 - Hour
* Day - 1 - Day
* Week - 2 - Week
* Month - 3 - Month

Ƭ CachingType

Enum:

  • Preview
  • Full

Enumeration of possible caching type.

* Preview - 0 - Preview
* Full - 1 - Full

Ƭ ReportingPluginError

Reporting plugin error

Name Type Description Example
codeNullable string error code
messageNullable string error message
contextNullable string error context

Ƭ CachingSettingsUpdateRequest

Caching settings request model.

Name Type Description Example
reportCacheEnabled Boolean Enables or disables caching for the report. true
value int32 Caching interval value. 1
interval CachingInterval
type CachingType