GET api/Reports/{reportIdentity}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| reportIdentity | string |
Required |
Body Parameters
None.
Response Information
Resource Description
ReportStatus| Name | Description | Type | Additional information |
|---|---|---|---|
| Identity | globally unique identifier |
None. |
|
| Started | date |
None. |
|
| Completed | date |
None. |
|
| IsReady | boolean |
None. |
|
| ReportTypeName | string |
None. |
|
| RequestedBy | string |
None. |
|
| DownloadLinkUri | URI |
None. |
|
| DownloadToken | globally unique identifier |
None. |
|
| Parameters | Dictionary of string [key] and Object [value] |
None. |
|
| ReportProgress | ReportProgress |
None. |
Response Formats
application/json, text/json
Sample:
{
"Identity": "b7fc8be3-1e6e-4622-ba28-189dfbe3583c",
"Started": "2025-11-02T00:58:18.4722429+00:00",
"Completed": "2025-11-02T00:58:18.4722429+00:00",
"IsReady": true,
"ReportTypeName": "sample string 5",
"RequestedBy": "sample string 6",
"DownloadLinkUri": "http://webapihelppage7.com",
"DownloadToken": "765745ff-4aa5-488e-8c33-3efd94229cd2",
"Parameters": {
"sample string 1": {},
"sample string 3": {}
},
"ReportProgress": 0
}
application/xml, text/xml
Sample:
<ReportStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
<Completed xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2025-11-02T00:58:18.4722429Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</Completed>
<DownloadLinkUri>http://webapihelppage7.com/</DownloadLinkUri>
<DownloadToken>765745ff-4aa5-488e-8c33-3efd94229cd2</DownloadToken>
<Identity>b7fc8be3-1e6e-4622-ba28-189dfbe3583c</Identity>
<IsReady>true</IsReady>
<Parameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringanyType>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value />
</d2p1:KeyValueOfstringanyType>
<d2p1:KeyValueOfstringanyType>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value />
</d2p1:KeyValueOfstringanyType>
</Parameters>
<ReportProgress>InProgress</ReportProgress>
<ReportTypeName>sample string 5</ReportTypeName>
<RequestedBy>sample string 6</RequestedBy>
<Started xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2025-11-02T00:58:18.4722429Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</Started>
</ReportStatus>