Job

The Results Job Resource represents Jobs that can be uploaded or downloaded from labPortal

APIDescription
GET api-v1/results/job?pageNumber={pageNumber}&pageSize={pageSize}

Return all Jobs, paginated by and

GET api-v1/results/job/{id}

Return job with labPortal Id

GET api-v1/results/job?limsid={limsid}

Return job with LIMS Id

DELETE api-v1/results/job/{id}

Delete Job with labPortal id

POST api-v1/results/job/{id}/attachment

Attachment, When documents have been uploaded to labPortal the Job record can be marked with an attachment so that the user can query for the documents Use this api to update the attachment attribute of a Job The body must container a Multipart Form data with the content as: attachment=true

POST api-v1/results/job

Post a new or existing job, if job does not exist you will receive a HttpCreated, else the job will be updated and the response will be HttpOk Jobs use the property LimsId, to check for existence

Sample

Results-Sample Resource Represents a labPortal sample, properties and nested results and result metadata

APIDescription
GET api-v1/results/sample/{id}

This is the basic request to get a Sample representation.

GET api-v1/results/sample?limsid={limsid}

This is the basic request to get a Sample representation. The message format

GET api-v1/results/sample?property={property}&value={value}&pageNumber={pageNumber}&pageSize={pageSize}

A basic search function to retrieve samples. Supports pagination so that large datasets can be traversed. Samples returned in the order that they have been uploaded to labPortal. Therefore the first sample will be the most recently updated Sample.

GET api-v1/results/sample?searchId={searchId}&pageNumber={pageNumber}&pageSize={pageSize}&grid={grid}

Returns a list of Samples based on a Saved Search

POST api-v1/results/sample/{id}/attachment

Attachment, When documents have been uploaded to labPortal the Sample record can be marked with an attachment so that the user can query for the documents Use this api to update the attachment attribute of a sample The body must container a Multipart Form data with the content as: attachment=true

Document

Document Controller is used to Upload documents to labPortal

APIDescription
POST api-v1/library/documents

Uploads the posted document to labPortal

GET api-v1/library/documents/{id}

Returns a DocumentMessage (details about the document and a download link) for the document with the given Id

Order

Commerce Module - Orders Order is a represenation of a batch of samples that have been registered on labPortal. Using this API you can retrieve Orders that have been submitted to labPortal.

APIDescription
GET api-v1/commerce/orders/{id}

Get an order by the order id

GET api-v1/commerce/orders/{status}

Get an order by order status

POST api-v1/commerce/orders/submitted

Marks the order specified by Id within the post body as submitted (downloaded and imported into a laboratory LIMS system)

The API which calls the jobs and samples re-indexing services

APIDescription
GET api-v1/search/Index

Tells the job indexing service to re-index the jobs

GET api-v1/search/ReIndexSamples

Tells the sample indexing service to re-index the samples