GET reports?customerID={customerID}

Get all reports in the scope of CustomerID. Roles: ApiRole

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerID

Customer ID

integer

Required

Body Parameters

None.

Response Information

Resource Description

Returns all reports in customer scope

Collection of Report
NameDescriptionTypeAdditional information
ReportGUID

Report Guid

globally unique identifier

None.

Name

Report name

string

None.

Description

Report description

string

None.

OwnerName

Report Owner name

string

None.

OwnerScope

Report Owner Scope

string

None.

TypeString

Report type

string

None.

Fields

Report View Fields

Collection of ViewSetupField

None.

DataSources

Report DataSources

string

None.

RequiredViewRole

Report viewer role

string

None.

Accounts

Report accounts

Collection of ReportAccount

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ReportGUID": "f481c047-d400-4b7a-b239-367536e0c08e",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "OwnerName": "sample string 4",
    "OwnerScope": "sample string 5",
    "TypeString": "sample string 6",
    "Fields": [
      {
        "Key": 1,
        "FieldID": 2,
        "DataPeriod": "Start",
        "Formatting": "None",
        "Format": "sample string 3",
        "HeaderUser": "sample string 4",
        "Ordering": 5,
        "Field": {
          "ViewDataFieldID": 1,
          "DefaultHeader": "sample string 2",
          "Description": "sample string 3",
          "IsOnlyCurrentValue": true,
          "RequiredRole": "AdminRole",
          "DontPrint": true
        },
        "Key2": 1,
        "ColumnName": "CV-1-1",
        "Header": "sample string 4"
      },
      {
        "Key": 1,
        "FieldID": 2,
        "DataPeriod": "Start",
        "Formatting": "None",
        "Format": "sample string 3",
        "HeaderUser": "sample string 4",
        "Ordering": 5,
        "Field": {
          "ViewDataFieldID": 1,
          "DefaultHeader": "sample string 2",
          "Description": "sample string 3",
          "IsOnlyCurrentValue": true,
          "RequiredRole": "AdminRole",
          "DontPrint": true
        },
        "Key2": 1,
        "ColumnName": "CV-1-1",
        "Header": "sample string 4"
      }
    ],
    "DataSources": "sample string 7",
    "RequiredViewRole": "sample string 8",
    "UserViewID": 1,
    "ViewType": "DeviceView",
    "ReportType": "NotAssigned",
    "Accounts": [
      {
        "AccountID": 1,
        "AccountName": "sample string 2"
      },
      {
        "AccountID": 1,
        "AccountName": "sample string 2"
      }
    ]
  },
  {
    "ReportGUID": "f481c047-d400-4b7a-b239-367536e0c08e",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "OwnerName": "sample string 4",
    "OwnerScope": "sample string 5",
    "TypeString": "sample string 6",
    "Fields": [
      {
        "Key": 1,
        "FieldID": 2,
        "DataPeriod": "Start",
        "Formatting": "None",
        "Format": "sample string 3",
        "HeaderUser": "sample string 4",
        "Ordering": 5,
        "Field": {
          "ViewDataFieldID": 1,
          "DefaultHeader": "sample string 2",
          "Description": "sample string 3",
          "IsOnlyCurrentValue": true,
          "RequiredRole": "AdminRole",
          "DontPrint": true
        },
        "Key2": 1,
        "ColumnName": "CV-1-1",
        "Header": "sample string 4"
      },
      {
        "Key": 1,
        "FieldID": 2,
        "DataPeriod": "Start",
        "Formatting": "None",
        "Format": "sample string 3",
        "HeaderUser": "sample string 4",
        "Ordering": 5,
        "Field": {
          "ViewDataFieldID": 1,
          "DefaultHeader": "sample string 2",
          "Description": "sample string 3",
          "IsOnlyCurrentValue": true,
          "RequiredRole": "AdminRole",
          "DontPrint": true
        },
        "Key2": 1,
        "ColumnName": "CV-1-1",
        "Header": "sample string 4"
      }
    ],
    "DataSources": "sample string 7",
    "RequiredViewRole": "sample string 8",
    "UserViewID": 1,
    "ViewType": "DeviceView",
    "ReportType": "NotAssigned",
    "Accounts": [
      {
        "AccountID": 1,
        "AccountName": "sample string 2"
      },
      {
        "AccountID": 1,
        "AccountName": "sample string 2"
      }
    ]
  }
]