Get information about an existing scheduled email in your project.

Response body parameters

• deprecated (boolean) specifies whether the scheduled email is hidden from the GoodData Portal (1) or visible and listed in the existed scheduled emails (0).

• recurrency (string) specifies the schedule for the email to be sent in Date::Manip format. Example: 0:0:0:1*12:0:0

• timezone (string) specifies the canonical name of the time zone for the email schedule. Example: Europe/Prague

• pageOrientation (string, optional) specifies page orientation of the PDF file produced. Can be set to portrait (default) or landscape.

• optimalColumnWidth (boolean, optional) specifies whether the column width should be uniform (no; default) or adjusted according to the actual column data (yes). Applies to both portrait and landscape orientations.

• pageScalePercentage (number, optional) specifies a percentage to scale the output PDF file for a report. Applies to both portrait and landscape orientations. Cannot be used with the scaleToPages, scaleToPagesX, and scaleToPagesY parameters. If not set, defaults to 100.

• scaleToPages (number, optional) specifies a maximum number of pages for the output PDF file for a report. Applies to both portrait and landscape orientations. Cannot be used with the pageScalePercentage, scaleToPagesX and scaleToPagesY parameters.

• scaleToPagesX (number, optional) shrinks the horizontal content of the output PDF file for a report to a maximum of this number of pages. Often used with the scaleToPagesY parameter. Applies to both portrait and landscape orientations. Cannot be used with the pageScalePercentage or scaleToPages parameters.

• scaleToPagesY (number, optional) shrinks the vertical content of the output PDF file for a report to a maximum of this number of pages. Often used with the scaleToPagesX parameter. Applies to both portrait and landscape orientations. Cannot be used with the pageScalePercentage or scaleToPages parameters.

• allTabs (boolean, optional) specifies whether to export all tabs of a dashboard (1) or just specific ones (0).

• tabs (only when allTabs set to 0, array of strings) specifies the identifiers of the dashboard tabs to export. Example: [ "l1upg65jgp0je","f7qgm4m3dmb8v" ]

• executionContext (string, optional) applies a predefined set of filters (execution context) to the dashboard to export.

{
  "scheduledMail": {
    "meta": {
      "title": "Some title",
      "category": "metadataType",
      "tags": "tag1 tag2",
      "author": "/gdc/account/profile/p123",
      "created": "2020-01-08 15:44:23",
      "contributor": "/gdc/account/profile/p123",
      "updated": "2020-01-08 15:44:23",
      "identifier": "identifier123",
      "summary": "Object summary"
    },
    "content": {
      "when": {
        "recurrency": "recurrence_in_Date::Manip_format"
      },
      "lastSuccessfull": "2020-01-08 15:44:23",
      "attachments": [
        {
          "exportOptions": {
            "pageOrientation": "landscape|portrait"
          },
          "formats": [
            "pdf",
            "xlsx",
            "csv",
            "html"
          ],
          "uri": "/gdc/md/{project_id}/obj/{report_id}"
        }
      ]
    }
  }
}