Report
Provides human readable rendering of data as file artifacts. This service leverages Enterprise Data to assemble datasets required for the rendering of the reports. In addition Rendering Engines and Templates are registered within this system.
- class ClientSDK.Report
Report Definition Methods
CreateDefinitionAsync
Creates a report definition.
Required Role(s): Admin, Support Admin, Super Admin
Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.
- ClientSDK.Core.CreateDefinitionAsync(ReportDefinition reportDefinition)
- Parameters
reportDefinition (ReportDefinition) – ReportDefinition object
- Return type
Task<ReportDefinition>
GetDefinitionsAsync
Gets a list of report definitions.
Required Role(s): Any
Resource Authorization: Access to the digital twin associated to the operation
- ClientSDK.Core.GetDefinitionsAsync(string operationId)
- Parameters
operationId – The unique identifier (GUID) of the operation.
- Returns
A list of Report Definitions.
- Return type
Task<List<ReportDefinition>>
GetDefinitionAsync
Gets a report definitions using its unique identifier (GUID).
Required Role(s): Any
Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.
- ClientSDK.Core.GetDefinitionAsync(string id)
- Parameters
id (string) – The unique identifier (GUID) of the report definition.
- Returns
A Report Definitions.
- Return type
Task<List<ReportDefinition>>
DeleteDefinitionAsync
Deletes a previously created report definition.
Required Role(s): Any
Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.
- ClientSDK.Core.DeleteDefinitionAsync(string id)
- Parameters
operationId – The unique identifier (GUID) of the report definition.
- Returns
Whether or not the report definition was successfully deleted.
- Return type
Task<bool>
UpdateDefinitionAsync
Updates a previously created report definition.
Required Role(s): Admin, Support Admin, Super Admin
Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.
- ClientSDK.Core.UpdateDefinitionAsync(ReportDefinition reportDefinition)
- Parameters
reportDefinition (ReportDefinition) – ReportDefinition object
- Return type
Task<ReportDefinition>
Report Methods
DownloadReportAsync
Download a report output (Report).
Required Role(s): Any
Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.
- ClientSDK.Core.DownloadReportAsync(string id, string filename)
- Parameters
id (string) – The unique identifier (GUID) of the report definition.
filename (string) – full path to the file to save
- Return type
Task<bool>
Report Template Methods
DownloadTemplateAsync
Download a report template.
Required Role(s): Any
Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.
- ClientSDK.Core.DownloadTemplateAsync(string id, string filename)
- Parameters
id (string) – The unique identifier (GUID) of the report definition.
filename (string) – full path to the file to save
- Return type
Task<bool>
UploadDefinitionTemplateAsync
Upload a report template (Excel template or spreadsheet).
Required Role(s): Admin, Support Admin, Super Admin
Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.
- ClientSDK.Core.UploadDefinitionTemplateAsync(string id, string filename)
- Parameters
id (string) – The unique identifier (GUID) of the report definition.
filename (string) – full path to the file to upload
- Return type
Task<ReportDefinition>
Report Tag Methods
CreateReportTagAsync
Validates and creates a new report definition tag.
Required Role(s): Admin, Support Admin, Super Admin
Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.
- ClientSDK.Core.CreateReportTagAsync(string reportDefinitionId, string tag)
- Parameters
reportDefinitionId (string) – The unique identifier (GUID) of the report definition.
tag (string) – tag name
- Return type
Task<ReportDefinitionTag>
DeleteReportTagAsync
Deletes a previously created report definition tag.
Required Role(s): Admin, Support Admin, Super Admin
Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.
- ClientSDK.Core.DeleteReportTagAsync(string id)
- Parameters
id (string) – The unique identifier (GUID) of the report definition tag.
- Return type
Task<bool>
GetReportTagAsync
Retrieves a list of all tags the user has access.
Required Role(s): Any
Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.
- ClientSDK.Core.GetReportTagAsync(string id)
- Parameters
id (string) – The unique identifier (GUID) of the report definition tag.
- Return type
Task<ReportDefinitionTag>
UpdateReportDefinitionTagAsync
Updates a previously created report definition tag.
Required Role(s): Admin, Support Admin, Super Admin
Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.
- ClientSDK.Core.UpdateReportDefinitionTagAsync(ReportDefinitionTag reportDefinitionTag)
- Parameters
reportDefinitionTag (ReportDefinitionTag) – The report definition tag object.
- Return type
Task<ReportDefinitionTag>