Help Page Home

GET api/reports

Get a list of report definitions for the GET /api/assessments/{id}/report endpoint.

Required Scopes

Assessment.Detail+ImageAccess

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A list of all possible report definitions.

Collection of ReportDefinition
NameDescriptionTypeAdditional information
Description

string

None.

ReportCode

string

None.

Response Formats

[
  {
    "Description": "sample string 1",
    "ReportCode": "sample string 2"
  },
  {
    "Description": "sample string 1",
    "ReportCode": "sample string 2"
  }
]
<ArrayOfReportDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Audatex.NextGen.Services.AssessmentReporting.Interface.v1.DataContracts">
  <ReportDefinition>
    <Description>sample string 1</Description>
    <ReportCode>sample string 2</ReportCode>
  </ReportDefinition>
  <ReportDefinition>
    <Description>sample string 1</Description>
    <ReportCode>sample string 2</ReportCode>
  </ReportDefinition>
</ArrayOfReportDefinition>