GOgooddata
Fiscal Calendars

Get a Fiscal Calendar

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

Request

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

Path parameters

workspaceIdstring required
objectIdstring required

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').

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.