RDEReportTemplate

This type is used to create RDE report generators that can generate reports either one time, periodically, or on invoice issue event.

Schema

The considered APS type (download) looks as follows:

{
  "name": "RDEReportTemplate",
  "id": "http://www.odin.com/rde/report-template/1.2",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/abstract/types/unlimited-resource/1.0"
  ],
  "relations": {
    "reportFiles": {
      "type": "http://www.odin.com/rde/report-file/1.2",
      "collection": true
    },
    "tenant": {
      "type": "http://www.odin.com/rde/tenant/2.0"
    },
    "customization": {
      "type": "http://www.odin.com/rde/report-customization/1.0"
    }
  },
  "properties": {
    "commonName": {
      "type": "string"
    },
    "parameters": {
      "type": "ReportTemplateParameters"
    },
    "format": {
      "type": "string",
      "enum": [
        "CSV",
        "XML",
        "XLSX",
        "JSON"
      ]
    },
    "notifyByEmail": {
      "type": "boolean"
    },
    "eventType": {
      "type": "string",
      "enum": [
        "PERIODIC",
        "ONETIME",
        "ON_INVOICE"
      ]
    },
    "periodicTask": {
      "type": "string"
    },
    "lastReportDate": {
      "type": "string",
      "format": "date-time"
    },
    "nextReportDate": {
      "type": "string",
      "format": "date-time"
    },
    "reportApsActorId": {
      "type": "string"
    },
    "reportApsIdentityId": {
      "type": "string"
    }
  },
  "operations": {
    "runScheduledTask": {
      "path": "run-scheduled-task",
      "verb": "GET",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "id": {
          "kind": "path",
          "type": "string"
        }
      }
    }
  },
  "structures": {
    "ReportTemplateParameters": {
      "type": "object",
      "properties": {
        "period": {
          "type": "string",
          "enum": [
            "P1D",
            "P1M"
          ]
        },
        "startDay": {
          "type": "integer"
        },
        "startDate": {
          "type": "string",
          "format": "date-time"
        },
        "endDate": {
          "type": "string",
          "format": "date-time"
        }
      }
    }
  }
}

Properties

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
commonName	String	Not Required		Human readable description of report template type, such as “Daily report template”, “Monthly report template” or “On invoice report template”.
eventType		Not Required		Report event type that can be either PERIODIC, ONETIME, or ON_INVOICE.
format		Not Required		Report file format that can be either JSON, XML, XLSX, CSV.
lastReportDate	Date	Not Required		Last date of report creation, only for periodical report or report by invoice.
nextReportDate	Date	Not Required		Intended next date of report creation, only for periodical report.
notifyByEmail	Boolean	Not Required		If it’s true an email with a short-lived link to a report file will be sent.
parameters	ReportTemplateParameters	Not Required		Parameters for report creation specific to report type.
periodicTask	String	Not Required		36-character internal UUID of a periodic task used to generate RDE reports.
reportApsActorId	String	Not Required		36-character APS ID of the user that created the report generator.
reportApsIdentityId	String	Not Required		APS ID of an APS resource representing a report generator.

Relationship

NAME	TYPE	REQUIRED	DESCRIPTION
customization	RDEReportCustomization	No	Link to report customization APS resource.
reportFiles	Collection of RDEReportFile	No	Collection of links to APS resources presenting the RDE reports generated by this report generator.
tenant	RDETenant	No	Link to an internal tenant APS resource bound with an account.

Custom Operations

OPERATION	VERB	PATH	RETURNS	Description
runScheduledTask	GET	run-scheduled-task

runScheduledTask

HTTP Request

GET /aps/2/resources/{aps-id}/run-scheduled-task

Description

Returns

Structures

ReportTemplateParameters

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
endDate	Date	Not Required		Onetime report “date to” limitation.
period		Not Required		Periodical report type that can be either P1D or P1M (daily or monthly).
startDate	Date	Not Required		One time report “date from” limitation.
startDay	Integer	Not Required		Day of Month for monthly periodical report.

Examples

Please find general description of create-read-update-delete (CRUD) operations with resources, properties, and structures respectively at:

• Provisioning Resources
• Getting Resource List
• Resource Configuration
• Unprovisioning Resources

Since the considered APS type contains custom operations, refer to Custom Operations for the general explanation of their structure and examples of operation calls.

← RDEReportFile

RDETenant →