[]
        
(Showing Draft Content)

Reporting-CachingSettings

Reporting-CachingSettings

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

Parameters

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

Gets caching settings for the report.

Responses

[200] Success

CachingSettingsResponse

Type: [application/json]

[400] Bad Request

ReportingPluginError

Type: [application/json]

[403] Forbidden

ReportingPluginError

Type: [application/json]

[404] Not Found

ReportingPluginError

Type: [application/json]

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

Parameters

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

Sets caching settings for the report.

Request Body

Description: Caching settings request model.

Type: application/json

CachingSettingsUpdateRequest

Responses

[204] No Content

[400] Bad Request

ReportingPluginError

Type: [application/json]

[403] Forbidden

ReportingPluginError

Type: [application/json]

[404] Not Found

ReportingPluginError

Type: [application/json]

Models

Ƭ CachingSettingsResponse

Caching settings response model.

Name Type Description
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
codeNullable string error code
messageNullable string error message
contextNullable string error context

Ƭ CachingSettingsUpdateRequest

Caching settings request model.

Name Type Description Example
reportCacheEnabledRequired Boolean Enables or disables caching for the report. true
valueRequired int32 Caching interval value. 1
intervalRequired CachingInterval
typeRequired CachingType