GOgooddata
Fiscal Calendars

Get all Fiscal Calendars

get/api/v1/entities/workspaces/{workspaceId}/fiscalCalendars

Request

  • Base URL
    https://www.gooddata.ai
  • Auth
    none declared

Path parameters

workspaceIdstring required

Query parameters

origin'ALL' | 'PARENTS' | 'NATIVE'

Defines scope of origin of objects. All by default.

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)

sizeinteger

The size of the page to be returned

sortstring[]

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

metaIncludestring[]

Included meta objects

Include Meta objects.

Headers

X-GDC-VALIDATE-RELATIONSboolean

Response

Request successfully processed

Example response

{
  "data": [
    {
      "attributes": {
        "definition": {
          "dataSourceTables": {
            "my-postgres": {
              "path": [
                "schema1",
                "table1"
              ],
              "version": "v1"
            }
          }
        },
        "description": "Custom fiscal calendar starting in April.",
        "enabledGranularities": [
          {
            "granularity": "FISCAL_MONTH",
            "prefix": "FP"
          }
        ],
        "title": "Fiscal calendar"
      },
      "id": "id1",
      "type": "fiscalCalendar"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.