Benchling Review Process Stage API

openapi: 3.2.0
info:
  title: Benchling Review Process Stage API
  version: 2.0.0
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  description: 'Operations tagged ReviewProcessStage across 2 of this provider''s published API definitions: benchling-openapi.yml, benchling-v3-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v3
security:
- oAuth: []
- basicApiKeyAuth: []
tags:
- description: 'A single stage within a ReviewProcess that defines a required step in the review

    workflow. Each stage specifies what action reviewers must take (see

    `ReviewProcessActionType`), who is eligible to be a reviewer (see `ReviewerType`),

    and optionally a specific Team. For sequential review processes, stages have a

    position index determining their order. Stages can be configured to allow or

    disallow authors and senders as reviewers, and can permit team member reassignment.


    The list endpoint returns stages from the current version of each accessible review

    process. To retrieve stages scoped to a specific review process, use

    `GET /benchling/review-process/{review_process_id}` and inspect `currentVersion.reviewStages`.'
  name: ReviewProcessStage
  x-bnch-organization: Benchling
  x-displayName: Review Process Stage
paths:
  /review-process-stage/items:
    get:
      description: 'List ReviewProcessStage items from the current version of each accessible review process.


        Stages of archived review processes are omitted but can still be retrieved by ID.'
      operationId: ReviewProcessStage.List
      parameters:
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/omit'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/returning'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewProcessStagePaginatedList'
          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 ReviewProcessStage items
      tags:
      - ReviewProcessStage
    servers:
    - url: /api/v3
  /review-process-stage/{review_process_stage_id}:
    get:
      description: Get a single ReviewProcessStage by ID.
      operationId: ReviewProcessStage.Get
      parameters:
      - description: ID of the ReviewProcessStage.
        in: path
        name: review_process_stage_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/omit'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewProcessStage'
          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 ReviewProcessStage by ID
      tags:
      - ReviewProcessStage
    servers:
    - url: /api/v3
components:
  schemas:
    GeneralError:
      properties:
        detail:
          type:
          - 'null'
          - string
          - object
        instance:
          type: string
        invalidId:
          type: string
        status:
          type: integer
        title:
          type:
          - 'null'
          - string
        type:
          type: string
      required:
      - type
      - title
      - detail
      - status
      - instance
      type: object
    TeamRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      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
    TooManyRequestsError:
      properties:
        detail:
          type:
          - 'null'
          - string
          - object
        instance:
          type: string
        invalidId:
          type: string
        status:
          type: integer
        title:
          type:
          - 'null'
          - string
        type:
          type: string
      required:
      - type
      - title
      - detail
      - status
      - instance
      type: object
    ReviewProcessStage:
      description: 'A single stage within a ReviewProcess that defines a required step in the review

        workflow. Each stage specifies what action reviewers must take (see

        `ReviewProcessActionType`), who is eligible to be a reviewer (see `ReviewerType`),

        and optionally a specific Team. For sequential review processes, stages have a

        position index determining their order. Stages can be configured to allow or

        disallow authors and senders as reviewers, and can permit team member reassignment.


        The list endpoint returns stages from the current version of each accessible review

        process. To retrieve stages scoped to a specific review process, use

        `GET /benchling/review-process/{review_process_id}` and inspect `currentVersion.reviewStages`.'
      properties:
        __typename:
          type: string
        action:
          description: Action to be taken by the reviewer for this review process stage
          enum:
          - APPROVE
          - COMPLETE
          - ACCEPT
          - REVIEW
          - WITNESS
          - SELF_REVIEW
          - null
          type:
          - 'null'
          - string
        allowAuthorReviewers:
          description: Whether authors can review this review process stage
          type: boolean
        allowSenderReviewer:
          description: Whether the sender can review this review process stage
          type: boolean
        createdAt:
          description: Timestamp when this review process stage was created
          format: datetime
          type: string
        description:
          description: Description of the review process stage
          type:
          - 'null'
          - string
        id:
          description: ID of the review process stage
          type: string
        isTeamReassignable:
          description: Whether team members can reassign this review stage to other team members
          type:
          - 'null'
          - boolean
        name:
          description: Title of the review process stage
          type:
          - 'null'
          - string
        reviewerType:
          description: Type of reviewer that is valid for the review process stage
          enum:
          - AUTHOR
          - TEAM
          - PROJECT_MEMBERS
          - null
          type:
          - 'null'
          - string
        selectedTeam:
          description: Team that is selected to review this review process stage
          oneOf:
          - $ref: '#/components/schemas/TeamRef'
          - type: 'null'
        sequentialPositionIndex:
          description: Position of this stage in the review process
          type:
          - 'null'
          - integer
      type: object
    ReviewProcessStagePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ReviewProcessStage'
          type: array
        nextToken:
          type:
          - string
          - 'null'
      type: object
    GeneralError_2:
      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
    ReviewProcessStagePaginatedList_2:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ReviewProcessStage'
          type: array
        nextToken:
          type: string
      type: object
  parameters:
    pageSize:
      description: Number of results to return. Defaults to 50, maximum of 100.
      in: query
      name: pageSize
      schema:
        type: integer
    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
    nextToken:
      description: Token for pagination
      in: query
      name: nextToken
      schema:
        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
  responses:
    Forbidden:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Forbidden
    BadRequest:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Bad Request
    TooManyRequests:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/TooManyRequestsError'
      description: Too Many Requests
      headers:
        Retry-After:
          description: Minimum number of seconds to wait before retrying. Only included when the request exceeded a rate limit specific to the caller. Limits shared with other callers, such as tenant-wide limits, omit this header because the wait depends on their traffic.
          required: false
          schema:
            minimum: 1
            type: integer
    NotFound:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Not Found
    InternalServerError:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/InternalServerError'
      description: Internal Server Error
    TooManyRequests_2:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError_2'
      description: Too Many Requests
  securitySchemes:
    BearerAuth:
      description: Use a short-lived V3 API Explorer token.
      scheme: bearer
      type: http
      x-fern-playground-description: Copy a short-lived V3 API Explorer token from the user's settings page
    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
x-refined-from:
- benchling-openapi.yml
- benchling-v3-openapi.yaml