POST api/v{version}/laboratory/{laboratoryId}/report/execute

Request Information

URI Parameters

NameDescriptionTypeAdditional information
laboratoryId

integer

Required

version

string

None.

Body Parameters

ReportExecutionModel
NameDescriptionTypeAdditional information
id

globally unique identifier

None.

format

integer

Range: inclusive between 0 and 6

Request Formats

application/json, text/json

Sample:
{
  "id": "3a039e5c-46fa-4b11-b106-7d8bc673e5c6",
  "format": 2
}

application/xml, text/xml

Sample:
<ReportExecutionModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CancerBytesAPI.Models">
  <Format>2</Format>
  <Id>3a039e5c-46fa-4b11-b106-7d8bc673e5c6</Id>
</ReportExecutionModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfReportListModel
NameDescriptionTypeAdditional information
Data

ReportListModel

None.

StatusCode

Gets or sets the status code.

HttpStatusCode

None.

StatusDescription

Gets or sets the status description.

string

None.

Errors

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "data": {
    "id": "sample string 1",
    "name": "sample string 2"
  },
  "statusCode": 100,
  "statusDescription": "sample string 1",
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<ResponseOfReportListModeluskxzdf5 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CancerBytesAPI.Response">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <StatusCode>Continue</StatusCode>
  <StatusDescription>sample string 1</StatusDescription>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/CancerBytesAPI.Models">
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:id>sample string 1</d2p1:id>
  </Data>
</ResponseOfReportListModeluskxzdf5>