GET api/Reports/{reportIdentity}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
reportIdentity

string

Required

Body Parameters

None.

Response Information

Resource Description

ReportStatus
NameDescriptionTypeAdditional 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": "8e8f903f-36cd-4b0d-b565-d33844ba00e9",
  "Started": "2024-11-21T08:36:38.8542964+00:00",
  "Completed": "2024-11-21T08:36:38.8542964+00:00",
  "IsReady": true,
  "ReportTypeName": "sample string 5",
  "RequestedBy": "sample string 6",
  "DownloadLinkUri": "http://webapihelppage7.com",
  "DownloadToken": "3bd49796-7e2b-4f28-a287-7defd46f9b54",
  "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>2024-11-21T08:36:38.8542964Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </Completed>
  <DownloadLinkUri>http://webapihelppage7.com/</DownloadLinkUri>
  <DownloadToken>3bd49796-7e2b-4f28-a287-7defd46f9b54</DownloadToken>
  <Identity>8e8f903f-36cd-4b0d-b565-d33844ba00e9</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>2024-11-21T08:36:38.8542964Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </Started>
</ReportStatus>