Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reporting
    Usage
    Computation
    Smart Functions
    Entitlement
      Values for all public entitlements.getValues for requested public entitlements.postGet EntitlementsgetGet Entitlementget
    Reporting - Settings
    Cache usage
    LLM Endpoints
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Entitlement (3.51)

Endpoint:/

Values for all public entitlements.

GET
/api/v1/actions/resolveEntitlements

Resolves values of available entitlements for the organization.

Values for all public entitlements. › Responses

OK

  • namestring · enum · required
    Enum values:
    CacheStrategy
    Contract
    CustomTheming
    ExtraCache
    Hipaa
    PdfExports
    UiLocalization
    Tier
  • expirystring · date
  • valuestring
GET /api/v1/actions/resolveEntitlements

Values for requested public entitlements.

POST
/api/v1/actions/resolveEntitlements

Resolves values for requested entitlements in the organization.

Values for requested public entitlements. › Request Body

  • entitlementsNamestring[] · unique · required
    Enum values:
    CacheStrategy
    Contract
    CustomTheming
    ExtraCache
    Hipaa
    PdfExports
    UiLocalization
    Tier

Values for requested public entitlements. › Responses

OK

  • namestring · enum · required
    Enum values:
    CacheStrategy
    Contract
    CustomTheming
    ExtraCache
    Hipaa
    PdfExports
    UiLocalization
    Tier
  • expirystring · date
  • valuestring
POST /api/v1/actions/resolveEntitlements

Get Entitlements

GET
/api/v1/entities/entitlements

Space of the shared interest

Get Entitlements › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • pageinteger

    Zero-based page index (0..N)

    Default: 0
  • sizeinteger

    The size of the page to be returned

    Default: 20
  • sortstring[]

    Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    page
    all
    ALL

Get Entitlements › Responses

Request successfully processed

  • dataobject[] · unique · required
  • linksobject
  • metaobject
GET /api/v1/entities/entitlements

Get Entitlement

GET
/api/v1/entities/entitlements/{id}

Space of the shared interest

Get Entitlement › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Get Entitlement › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Get Entitlement › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of entitlement entity.

  • linksobject
GET /api/v1/entities/entitlements/{id}
Smart FunctionsReporting - Settings