[]
        
(Showing Draft Content)

Reporting-CachingSettings

Reporting-CachingSettings

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

Parameters

Name Type Located In
reportIdRequired string path

Response

Status Code: 200

Success

CachingSettingsResponse

Status Code: 400

Bad Request

ReportingPluginError

Status Code: 404

Not Found

ReportingPluginError

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

Parameters

Name Type Located In
reportIdRequired string path

Request Schema

CachingSettingsUpdateRequest

Response

Status Code: 204

Success

Status Code: 400

Bad Request

ReportingPluginError

Status Code: 404

Not Found

ReportingPluginError

Models

Ƭ CachingSettingsResponse

Name Type Description Example
reportCacheEnabled Boolean
value int32
interval CachingInterval
type CachingType
allowUserToChangeExpiry Boolean
allowUserToChangeType Boolean
cacheEnabled Boolean

Ƭ CachingInterval

Enum:

  • Hour
  • Day
  • Week
  • Month

Enumeration of caching interval.

* 'Hour' - 0 - Hourly caching interval.
* 'Day' - 1 - Daily caching interval.
* 'Week' - 2 - Weekly caching interval.
* 'Month' - 3 - Monthly caching interval

Ƭ CachingType

Enum:

  • Preview
  • Full

The caching type.

* 'Preview' - 0 - Preview caching type.
* 'Full' - 1 - Full caching type.

Ƭ ReportingPluginError

Name Type Description Example
codeNullable string
messageNullable string
contextNullable string

Ƭ CachingSettingsUpdateRequest

Name Type Description Example
reportCacheEnabled Boolean
value int32
interval CachingInterval
type CachingType