GET api-v1/results/job?limsid={limsid}
Return job with LIMS Id
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| limsid |
The LIMSID of the Job to return |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
The job with the specified LIMSID
JobMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The Job's Id (inherited into 's Id field from ) |
integer |
None. |
| Filter |
The Job's Filter (inherited into 's Filter field from ) |
string |
None. |
| LimsId |
The Job's LIMS Id () |
string |
None. |
| OrderId |
The Job's Order Id () |
integer |
None. |
| Status |
The Job's Status () |
string |
None. |
| Attachment |
if the Job has an attachment, otherwise () |
boolean |
None. |
| Data |
A set of extra fields on the job (name to data) taken from the |
Dictionary of string [key] and Object [value] |
None. |
Response Formats
application/json,text/json
Sample:
{
"Id": 1,
"Filter": "sample string 2",
"LimsId": "sample string 3",
"OrderId": 4,
"Status": "sample string 5",
"Attachment": true,
"Data": {
"sample string 1": {},
"sample string 3": {}
}
}
application/xml,text/xml
Sample:
<JobMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/labPortal2.Web.Api.v1.Results.Messages">
<Attachment>true</Attachment>
<Data 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>
</Data>
<Filter>sample string 2</Filter>
<Id>1</Id>
<LimsId>sample string 3</LimsId>
<OrderId>4</OrderId>
<Status>sample string 5</Status>
</JobMessage>