Benchling Printers API

List printers.

Documentation

Specifications

Other Resources

OpenAPI Specification

benchling-printers-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  title: Benchling AA Sequences Printers API
  version: 2.0.0
  description: 'AA Sequences are the working units of cells that make everything run (they help make structures, catalyze reactions and allow for signaling - a kind of internal cell communication). On Benchling, these are comprised of a string of amino acids and collections of other attributes, such as annotations.

    '
servers:
- url: /api/v2
security:
- oAuth: []
- basicApiKeyAuth: []
tags:
- description: List printers.
  name: Printers
paths:
  /registries/{registry_id}/label-printers:
    get:
      description: List printers
      operationId: listPrinters
      parameters:
      - description: ID of the registry to list the printers for.
        in: path
        name: registry_id
        required: true
        schema:
          type: string
      - description: Name of a printer. Restricts results to those with the specified name.
        in: query
        name: name
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrintersList'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
      summary: List printers
      tags:
      - Printers
components:
  schemas:
    BadRequestError:
      properties:
        error:
          allOf:
          - $ref: '#/components/schemas/BaseError'
          - properties:
              type:
                enum:
                - invalid_request_error
                type: string
      type: object
    NotFoundError:
      properties:
        error:
          allOf:
          - $ref: '#/components/schemas/BaseError'
          - properties:
              invalidId:
                type: string
              type:
                enum:
                - invalid_request_error
                type: string
      type: object
    BaseError:
      properties:
        message:
          type: string
        type:
          type: string
        userMessage:
          type: string
      type: object
    Printer:
      properties:
        address:
          description: Web address of the printer (either IP address or URL).
          type: string
        description:
          description: Short description of the printer.
          nullable: true
          type: string
        id:
          description: ID of the printer.
          type: string
        name:
          description: Name of the printer.
          type: string
        port:
          description: Port to reach the printer at.
          nullable: true
          type: integer
        registryId:
          description: ID of the registry associated with this printer.
          type: string
      type: object
    PrintersList:
      properties:
        labelPrinters:
          items:
            $ref: '#/components/schemas/Printer'
          type: array
      type: object
  securitySchemes:
    basicApiKeyAuth:
      description: Use issued API key for standard access to the API
      scheme: basic
      type: http
    basicClientIdSecretAuth:
      description: Auth used as part of client credentials OAuth flow prior to receiving a bearer token.
      scheme: basic
      type: http
    oAuth:
      description: OAuth2 Client Credentials flow intended for service access
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: /api/v2/token
      type: oauth2
externalDocs:
  description: Additional API Documentation
  url: https://docs.benchling.com