Benchling Review Change API

openapi: 3.2.0
info:
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  title: Benchling Review Change API
  version: 2.0.0
  description: 'Represents a single action taken within a review. ReviewChanges form an ordered

    history of all changes made to a review, including status transitions,

    reviewer assignments, and comments. Each ReviewChange records the action taken,

    any associated comment, whether it was electronically signed, and an optional

    point-in-time snapshot.'
servers:
- url: /api/v3
security:
- oAuth: []
- basicApiKeyAuth: []
tags:
- description: 'Represents a single action taken within a review. ReviewChanges form an ordered

    history of all changes made to a review, including status transitions,

    reviewer assignments, and comments. Each ReviewChange records the action taken,

    any associated comment, whether it was electronically signed, and an optional

    point-in-time snapshot.'
  name: ReviewChange
  x-bnch-organization: Benchling
paths:
  /review-change/items:
    get:
      description: List ReviewChange items.
      operationId: ReviewChange.List
      parameters:
      - $ref: '#/components/parameters/createdAt.gt'
      - $ref: '#/components/parameters/createdAt.gte'
      - $ref: '#/components/parameters/createdAt.lt'
      - $ref: '#/components/parameters/createdAt.lte'
      - $ref: '#/components/parameters/id.anyOf'
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/omit'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/review.eq'
      - $ref: '#/components/parameters/reviewId.anyOf'
      - $ref: '#/components/parameters/reviewableId.anyOf'
      - description: 'Method by which to order results. Valid sorts are: createdAt (created time, oldest first). Use :asc or :desc to specify ascending or descending order. Default is createdAt:desc.'
        in: query
        name: sort
        schema:
          default: createdAt:desc
          enum:
          - createdAt:asc
          - createdAt:desc
          type: string
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewChangePaginatedList'
          description: OK
          headers: {}
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: List ReviewChange items
      tags:
      - ReviewChange
      x-bnch-rate-limit-tier: 4
  /review-change/{review_change_id}:
    get:
      description: Get a single ReviewChange by ID.
      operationId: ReviewChange.Get
      parameters:
      - description: ID of the ReviewChange.
        in: path
        name: review_change_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/omit'
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewChange'
          description: OK
          headers: {}
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get ReviewChange by ID
      tags:
      - ReviewChange
      x-bnch-rate-limit-tier: 5
components:
  schemas:
    ReviewChangePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ReviewChange'
          type: array
        nextToken:
          type: string
      type: object
    ReviewRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ReviewChange:
      description: 'Represents a single action taken within a review. ReviewChanges form an ordered

        history of all changes made to a review, including status transitions,

        reviewer assignments, and comments. Each ReviewChange records the action taken,

        any associated comment, whether it was electronically signed, and an optional

        point-in-time snapshot.'
      properties:
        __typename:
          type: string
        action:
          description: The action taken
          enum:
          - SEND_FOR_REVIEW
          - REQUEST_CHANGES
          - APPROVE
          - REJECT
          - RETRACT
          - ACCEPT
          - COMPLETE
          - SIGN
          - REVIEW
          - WITNESS
          - SELF_REVIEW
          - COMMENT
          - REASSIGN
          - null
          type:
          - 'null'
          - string
        comment:
          description: Optional comment associated with this change
          type:
          - 'null'
          - string
        createdAt:
          description: When this change occurred
          format: datetime
          type: string
        eSigned:
          description: Whether this change was electronically signed
          type:
          - 'null'
          - boolean
        id:
          description: ID of the review change
          type: string
        review:
          $ref: '#/components/schemas/ReviewRef'
          description: The review this change belongs to
        snapshot:
          description: A point-in-time snapshot of the reviewable item taken at the time of this action
          oneOf:
          - $ref: '#/components/schemas/ReviewSnapshot'
          - type: 'null'
      type: object
    InternalServerError:
      properties:
        detail:
          type:
          - 'null'
          - string
          - object
        errorId:
          type: string
        instance:
          type: string
        status:
          type: integer
        title:
          type:
          - 'null'
          - string
        type:
          type: string
      required:
      - type
      - title
      - detail
      - status
      - instance
      type: object
    ReviewSnapshot:
      description: 'A point-in-time snapshot of a reviewable item (e.g. an Entry) captured when a

        review action was taken. Snapshots are a configurable feature enabled via

        ENABLE_ELN_REVIEW_SNAPSHOTS. When status is SUCCEEDED, a time-limited downloadUrl is available.'
      properties:
        __typename:
          type: string
        downloadUrl:
          description: URL to download the snapshot export. Only present when status is SUCCEEDED.
          type:
          - 'null'
          - string
        size:
          description: Size of the snapshot export in bytes. Only present when status is SUCCEEDED.
          type:
          - 'null'
          - integer
        status:
          description: Status of the snapshot export
          enum:
          - PENDING
          - RUNNING
          - SUCCEEDED
          - FAILED
          - null
          type:
          - 'null'
          - string
      type: object
    GeneralError:
      properties:
        detail:
          type:
          - 'null'
          - string
          - object
        instance:
          type: string
        status:
          type: integer
        title:
          type:
          - 'null'
          - string
        type:
          type: string
      required:
      - type
      - title
      - detail
      - status
      - instance
      type: object
  parameters:
    pageSize:
      description: Number of results to return. Defaults to 50, maximum of 100.
      in: query
      name: pageSize
      schema:
        type: integer
    createdAt.gte:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created at or after the specified time. e.g. >= 2017-04-30.
      in: query
      name: createdAt.gte
      schema:
        format: datetime
        type: string
    reviewableId.anyOf:
      description: Restricts results to review changes for items with any of the specified reviewable item IDs (e.g. entry IDs like etr_...). Comma-separated list.
      explode: false
      in: query
      name: reviewableId.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    review.eq:
      description: ID of a Review.
      in: query
      name: review.eq
      schema:
        type: string
    id.anyOf:
      description: Restricts results to those matching any of the specified IDs. Comma-separated list.
      explode: false
      in: query
      name: id.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    reviewId.anyOf:
      description: Restricts results to review changes for any of the specified Review API IDs. Comma-separated list.
      explode: false
      in: query
      name: reviewId.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    createdAt.gt:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created after the specified time. e.g. > 2017-04-30.
      in: query
      name: createdAt.gt
      schema:
        format: datetime
        type: string
    createdAt.lt:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created before the specified time. e.g. < 2017-04-30.
      in: query
      name: createdAt.lt
      schema:
        format: datetime
        type: string
    returning:
      description: Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.
      explode: false
      in: query
      name: returning
      schema:
        items:
          type: string
        type: array
    nextToken:
      description: Token for pagination
      in: query
      name: nextToken
      schema:
        type: string
    omit:
      description: Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.
      explode: false
      in: query
      name: omit
      schema:
        items:
          type: string
        type: array
    createdAt.lte:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created at or before the specified time. e.g. <= 2017-04-30.
      in: query
      name: createdAt.lte
      schema:
        format: datetime
        type: string
  responses:
    NotFound:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Not Found
    TooManyRequests:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Too Many Requests
    BadRequest:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Bad Request
    Forbidden:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Forbidden
    InternalServerError:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/InternalServerError'
      description: Internal Server Error
  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: /oauth/token
      type: oauth2