Table Of Contents

Previous topic

Rated Data Export

Next topic

RDEReportFile

Application Packaging Standard

Last updated 18-Mar-2019

RDEReportCustomization

In this document:

Schema

The considered APS type (download) extends the Resource APS type(s) and looks as follows:

{
  "name": "RDEReportCustomization",
  "id": "http://www.odin.com/rde/report-customization/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "access": {
    "global": true
  },
  "properties": {
    "name": {
      "type": "http://aps-standard.org/types/core/i18n/1.0#MLString",
      "required": true
    },
    "columns": {
      "type": "array",
      "items": {
        "type": "ReportColumnCustomization"
      }
    },
    "resellerAccountAttributes": {
      "type": "array",
      "items": {
        "type": "ReportColumnCustomization"
      }
    },
    "customerAccountAttributes": {
      "type": "array",
      "items": {
        "type": "ReportColumnCustomization"
      }
    },
    "resellerOrderAttributes": {
      "type": "array",
      "items": {
        "type": "ReportColumnCustomization"
      }
    },
    "customerOrderAttributes": {
      "type": "array",
      "items": {
        "type": "ReportColumnCustomization"
      }
    }
  },
  "structures": {
    "ReportColumnCustomization": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "pattern": "[a-zA-Z][0-9a-zA-Z_]*"
        },
        "alias": {
          "type": "string",
          "pattern": "[a-zA-Z][0-9a-zA-Z_]*"
        }
      }
    }
  }
}

Properties

NAME TYPE ATTRIBUTES DEFAULT DESCRIPTION
columns ReportColumnCustomization array Not Required   Columns in the report.
customerAccountAttributes ReportColumnCustomization array Not Required   Customer’s custom attributes to be included into the report as separate columns instead of original column with all attributes in JSON format.
customerOrderAttributes ReportColumnCustomization array Not Required   Customer’s order custom attributes to be included into the report as separate columns instead of original column with all attributes in JSON format.
name key-value pairs of String Required   Report name.
resellerAccountAttributes ReportColumnCustomization array Not Required   Reseller’s custom attributes to be included into the report as separate columns instead of original column with all attributes in JSON format.
resellerOrderAttributes ReportColumnCustomization array Not Required   Reseller’s order custom attributes to be included into the report as separate columns instead of original column with all attributes in JSON format.

Structures

ReportColumnCustomization

Column customization in report.

NAME TYPE ATTRIBUTES DEFAULT DESCRIPTION
alias String Not Required   Column alias be used in report.
name String Not Required   Some name identifying column in report (e.g. original column name or custom attribute name)

Examples

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