Thermo Fisher Scientific Entities API

openapi: 3.2.0
info:
  title: Thermo Fisher SampleManager LIMS REST Entities API
  description: The Thermo Scientific SampleManager LIMS REST API enables secure connection between software applications and the SampleManager Laboratory Information Management System for simplified data exchange. Provides access to sample data, workflows, entity browsing, results, and laboratory operations. Supports token-based authentication with hardened session handling.
  version: 21.3.0
  contact:
    name: Thermo Fisher Scientific Digital Solutions
    url: https://www.thermofisher.com/us/en/home/digital-solutions/lab-informatics.html
  license:
    name: Proprietary
    url: https://www.thermofisher.com
servers:
- url: https://{server}:{port}/smpwcfrestvgsm
  description: SampleManager LIMS REST API Server
  variables:
    server:
      description: The hostname of your SampleManager LIMS server.
      default: localhost
    port:
      description: The port the SampleManager WCF service runs on.
      default: '56105'
security:
- bearerAuth: []
tags:
- name: Entities
  description: Browse entity data from SampleManager.
paths:
  /mobile/browses/{entity}:
    get:
      operationId: browseEntity
      summary: Browse Entity
      description: Returns a list of records for the specified SampleManager entity (e.g., SAMPLE, TEST, RESULT, CUSTOMER). Supports filtering and sorting.
      tags:
      - Entities
      parameters:
      - name: entity
        in: path
        required: true
        schema:
          type: string
        description: The SampleManager entity name (e.g., SAMPLE, TEST, RESULT, CUSTOMER, BATCH_HEADER, ANALYSIS).
      - name: criteria
        in: query
        required: false
        schema:
          type: string
        description: Filter criteria using SampleManager query syntax (e.g., STATUS='A' AND SAMPLED_DATE > '2026-01-01').
      - name: orderby
        in: query
        required: false
        schema:
          type: string
        description: Field name to sort results by.
      - name: ascending
        in: query
        required: false
        schema:
          type: boolean
          default: true
        description: Sort direction.
      - name: pagesize
        in: query
        required: false
        schema:
          type: integer
          default: 50
        description: Number of records per page.
      - name: page
        in: query
        required: false
        schema:
          type: integer
          default: 1
        description: Page number (1-based).
      responses:
        '200':
          description: Entity records returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrowseResponse'
        '401':
          description: Unauthorized.
        '404':
          description: Entity not found.
  /mobile/browses/{entity}/{id}:
    get:
      operationId: getEntityById
      summary: Get Entity By ID
      description: Returns a single record for the specified entity and record identity.
      tags:
      - Entities
      parameters:
      - name: entity
        in: path
        required: true
        schema:
          type: string
        description: The SampleManager entity name.
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: The record identity (primary key value).
      responses:
        '200':
          description: Entity record returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityRecord'
        '401':
          description: Unauthorized.
        '404':
          description: Record not found.
components:
  schemas:
    BrowseResponse:
      type: object
      properties:
        total:
          type: integer
          description: Total number of matching records.
        page:
          type: integer
          description: Current page number.
        pagesize:
          type: integer
          description: Records per page.
        records:
          type: array
          items:
            $ref: '#/components/schemas/EntityRecord'
    EntityRecord:
      type: object
      description: A generic SampleManager entity record. Field names depend on the entity type.
      additionalProperties: true
      properties:
        identity:
          type: string
          description: The primary key of the record.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Session token obtained from the /mobile/login endpoint. Pass as "Bearer {token}" in the Authorization header.