RDEStat¶

In this document:

Schema
Properties
Structures
Examples

Schema ¶

The considered APS type (download) looks as follows:

{
  "name": "RDEStat",
  "id": "http://www.odin.com/rde/statistics/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/abstract/types/unlimited-resource/1.0"
  ],
  "properties": {
    "isAzure": {
      "type": "boolean"
    },
    "rdeVersion": {
      "type": "string"
    },
    "numberOfSimplifiedSataSets": {
      "type": "integer"
    },
    "numberOfAvailableReports": {
      "type": "integer"
    },
    "dataSets": {
      "type": "array",
      "items": {
        "type": "DatasetStat"
      }
    },
    "simpleReportsByDataset": {
      "type": "array",
      "items": {
        "type": "SimplePerSetStat"
      }
    },
    "reportsWithSimplifiedDataset": {
      "type": "integer"
    },
    "format": {
      "type": "array",
      "items": {
        "type": "ReportFormatStat"
      }
    },
    "eventType": {
      "type": "array",
      "items": {
        "type": "EventTypeStat"
      }
    },
    "reportType": {
      "type": "array",
      "items": {
        "type": "ReportTypeStat"
      }
    },
    "status": {
      "type": "array",
      "items": {
        "type": "ReportStatusStat"
      }
    },
    "usersByReport": {
      "type": "array",
      "items": {
        "type": "UserByReportStat"
      }
    },
    "invoiceReportsDisabledByParent": {
      "type": "InvoiceDisabledStat"
    },
    "invoiceReportsDisabledForResellers": {
      "type": "InvoiceDisabledStat"
    },
    "numberOfAccounts": {
      "type": "array",
      "items": {
        "type": "AccountStat"
      }
    },
    "statusByUser": {
      "type": "array",
      "items": {
        "type": "StatusByUserStat"
      }
    },
    "notification": {
      "type": "array",
      "items": {
        "type": "NotificationStat"
      }
    },
    "reportFileRecord": {
      "type": "integer"
    },
    "sourceType": {
      "type": "SourceTypeStat"
    },
    "reportCountByAccountLevel": {
      "type": "array",
      "items": {
        "type": "AccountLevelStat"
      }
    },
    "datasetMappingStats": {
      "type": "array",
      "items": {
        "type": "DatasetMappingStat"
      }
    }
  },
  "structures": {
    "DatasetStat": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "reportFileEnabled": {
          "type": "integer"
        },
        "reportFileRecord": {
          "type": "integer"
        }
      }
    },
    "SimplePerSetStat": {
      "type": "object",
      "properties": {
        "dataSetType": {
          "type": "string"
        },
        "count": {
          "type": "integer"
        }
      }
    },
    "ReportFormatStat": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "count": {
          "type": "integer"
        }
      }
    },
    "EventTypeStat": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "count": {
          "type": "integer"
        }
      }
    },
    "ReportTypeStat": {
      "type": "object",
      "properties": {
        "reportType": {
          "type": "string"
        },
        "count": {
          "type": "integer"
        }
      }
    },
    "ReportStatusStat": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string"
        },
        "count": {
          "type": "integer"
        }
      }
    },
    "UserByReportStat": {
      "type": "object",
      "properties": {
        "reportType": {
          "type": "string"
        },
        "count": {
          "type": "integer"
        }
      }
    },
    "InvoiceDisabledStat": {
      "type": "object",
      "properties": {
        "disabled": {
          "type": "integer"
        },
        "enabled": {
          "type": "integer"
        }
      }
    },
    "AccountStat": {
      "type": "object",
      "properties": {
        "isEnabled": {
          "type": "boolean"
        },
        "reportType": {
          "type": "string"
        },
        "count": {
          "type": "integer"
        }
      }
    },
    "StatusByUserStat": {
      "type": "object",
      "properties": {
        "reportType": {
          "type": "string"
        },
        "reportStatus": {
          "type": "string"
        },
        "count": {
          "type": "integer"
        }
      }
    },
    "NotificationStat": {
      "type": "object",
      "properties": {
        "eventType": {
          "type": "string"
        },
        "isEnabled": {
          "type": "boolean"
        },
        "count": {
          "type": "integer"
        }
      }
    },
    "SourceTypeStat": {
      "type": "object",
      "properties": {
        "countReportFileAPI": {
          "type": "integer"
        },
        "countReportFileUX1": {
          "type": "integer"
        },
        "countReportTemplateAPI": {
          "type": "integer"
        },
        "countReportTemplateUX1": {
          "type": "integer"
        }
      }
    },
    "AccountLevelStat": {
      "type": "object",
      "properties": {
        "accountLevel": {
          "type": "string"
        },
        "counter": {
          "type": "integer"
        }
      }
    },
    "DatasetMappingStat": {
      "type": "object",
      "properties": {
        "dataSetType": {
          "type": "string"
        },
        "numberOfSimplifiedSataSets": {
          "type": "integer"
        },
        "numberOfAvailableReports": {
          "type": "integer"
        },
        "simpleReportsByDataset": {
          "type": "array",
          "items": {
            "type": "SimplePerSetStat"
          }
        },
        "reportsWithSimplifiedDataset": {
          "type": "integer"
        },
        "format": {
          "type": "array",
          "items": {
            "type": "ReportFormatStat"
          }
        },
        "eventType": {
          "type": "array",
          "items": {
            "type": "EventTypeStat"
          }
        },
        "reportType": {
          "type": "array",
          "items": {
            "type": "ReportTypeStat"
          }
        },
        "status": {
          "type": "array",
          "items": {
            "type": "ReportStatusStat"
          }
        },
        "usersByReport": {
          "type": "array",
          "items": {
            "type": "UserByReportStat"
          }
        },
        "numberOfAccounts": {
          "type": "array",
          "items": {
            "type": "AccountStat"
          }
        },
        "statusByUser": {
          "type": "array",
          "items": {
            "type": "StatusByUserStat"
          }
        },
        "notification": {
          "type": "array",
          "items": {
            "type": "NotificationStat"
          }
        },
        "reportFileRecord": {
          "type": "integer"
        },
        "sourceType": {
          "type": "SourceTypeStat"
        },
        "reportCountByAccountLevel": {
          "type": "array",
          "items": {
            "type": "AccountLevelStat"
          }
        },
        "invoiceReportsDisabledByParent": {
          "type": "InvoiceDisabledStat"
        },
        "invoiceReportsDisabledForResellers": {
          "type": "InvoiceDisabledStat"
        }
      }
    }
  }
}

Properties ¶

NAME	TYPE	ATTRIBUTES
isAzure	Boolean	Not Required
rdeVersion	String	Not Required
numberOfSimplifiedSataSets	Integer	Not Required
numberOfAvailableReports	Integer	Not Required
dataSets	Array of DatasetStat	Not Required
simpleReportsByDataset	Array of SimplePerSetStat	Not Required
reportsWithSimplifiedDataset	Integer	Not Required
format	Array of ReportFormatStat	Not Required
eventType	Array of EventTypeStat	Not Required
reportType	Array of ReportTypeStat	Not Required
status	Array of ReportStatusStat	Not Required
usersByReport	Array of UserByReportStat	Not Required
invoiceReportsDisabledByParent	InvoiceDisabledStat	Not Required
invoiceReportsDisabledForResellers	InvoiceDisabledStat	Not Required
numberOfAccounts	Array of AccountStat	Not Required
statusByUser	Array of StatusByUserStat	Not Required
notification	Array of NotificationStat	Not Required
reportFileRecord	Integer	Not Required
sourceType	SourceTypeStat	Not Required
reportCountByAccountLevel	Array of AccountLevelStat	Not Required
datasetMappingStats	Array of DatasetMappingStat	Not Required

Structures ¶

DatasetStat¶

NAME	TYPE	ATTRIBUTES
name	String	Not Required
reportFileEnabled	Integer	Not Required
reportFileRecord	Integer	Not Required

SimplePerSetStat¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
dataSetType	String	Not Required
count	Integer	Not Required

ReportFormatStat¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
name	String	Not Required
count	Integer	Not Required

EventTypeStat¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
name	String	Not Required
count	Integer	Not Required

ReportTypeStat¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
reportType	String	Not Required
count	Integer	Not Required

ReportStatusStat¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
status	String	Not Required
count	Integer	Not Required

UserByReportStat¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
reportType	String	Not Required
count	Integer	Not Required

InvoiceDisabledStat¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
disabled	Integer	Not Required
enabled	Integer	Not Required

AccountStat¶

NAME	TYPE	ATTRIBUTES
isEnabled	Boolean	Not Required
reportType	String	Not Required
count	Integer	Not Required

StatusByUserStat¶

NAME	TYPE	ATTRIBUTES
reportType	String	Not Required
reportStatus	String	Not Required
count	Integer	Not Required

NotificationStat¶

NAME	TYPE	ATTRIBUTES
eventType	String	Not Required
isEnabled	Boolean	Not Required
count	Integer	Not Required

SourceTypeStat¶

NAME	TYPE	ATTRIBUTES
countReportFileAPI	Integer	Not Required
countReportFileUX1	Integer	Not Required
countReportTemplateAPI	Integer	Not Required
countReportTemplateUX1	Integer	Not Required

AccountLevelStat¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
accountLevel	String	Not Required
counter	Integer	Not Required

DatasetMappingStat¶

NAME	TYPE	ATTRIBUTES
dataSetType	String	Not Required
numberOfSimplifiedSataSets	Integer	Not Required
numberOfAvailableReports	Integer	Not Required
simpleReportsByDataset	Array of SimplePerSetStat	Not Required
reportsWithSimplifiedDataset	Integer	Not Required
format	Array of ReportFormatStat	Not Required
eventType	Array of EventTypeStat	Not Required
reportType	Array of ReportTypeStat	Not Required
status	Array of ReportStatusStat	Not Required
usersByReport	Array of UserByReportStat	Not Required
numberOfAccounts	Array of AccountStat	Not Required
statusByUser	Array of StatusByUserStat	Not Required
notification	Array of NotificationStat	Not Required
reportFileRecord	Integer	Not Required
sourceType	SourceTypeStat	Not Required
reportCountByAccountLevel	Array of AccountLevelStat	Not Required
invoiceReportsDisabledByParent	InvoiceDisabledStat	Not Required
invoiceReportsDisabledForResellers	InvoiceDisabledStat	Not Required

Examples ¶

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

← RDEResellerReportCustomization

RDETenant →

CloudBlue Commerce API

Previous topic

Next topic

RDEStat¶

Schema ¶

Properties ¶

Structures ¶

DatasetStat¶

SimplePerSetStat¶

ReportFormatStat¶

EventTypeStat¶

ReportTypeStat¶

ReportStatusStat¶

UserByReportStat¶

InvoiceDisabledStat¶

AccountStat¶

StatusByUserStat¶

NotificationStat¶

SourceTypeStat¶

AccountLevelStat¶

DatasetMappingStat¶

Examples ¶

CloudBlue Commerce API

Previous topic

Next topic

RDEStat¶

Schema¶

Properties¶

Structures¶

DatasetStat¶

SimplePerSetStat¶

ReportFormatStat¶

EventTypeStat¶

ReportTypeStat¶

ReportStatusStat¶

UserByReportStat¶

InvoiceDisabledStat¶

AccountStat¶

StatusByUserStat¶

NotificationStat¶

SourceTypeStat¶

AccountLevelStat¶

DatasetMappingStat¶

Examples¶

Schema ¶

Properties ¶

Structures ¶

Examples ¶