Mabl Variable Table API

openapi: 3.2.0
info:
  title: mabl Variable Table API
  description: APIs for interacting with mabl services
  version: 0.599.3.1792436330
  x-readme-id: 62c896636916ce01d2ff4f5a
servers:
- url: /
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: VariableTable
paths:
  /variables/tables:
    get:
      tags:
      - VariableTable
      summary: Query VariableTables
      description: Used to query variabletables
      operationId: queryVariableTables
      parameters:
      - name: organization_id
        in: query
        description: ID of the organization for which to query variableTables
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The limit to use for pagination
        required: false
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          format: int32
      - name: cursor
        in: query
        description: The cursor to use for pagination
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Results of the query
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariableTableQueryResult'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::DataTable
    post:
      tags:
      - VariableTable
      summary: Create VariableTable
      operationId: createVariableTable
      parameters:
      - name: organization_id
        in: query
        description: ID of the organization in which to create the variable table
        required: true
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VariableTableCreationRequest'
      responses:
        '201':
          description: The VariableTable that was created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariableTable'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Create::DataTable
  /variables/tables/{variable_table_id}:
    get:
      tags:
      - VariableTable
      summary: Get VariableTable
      description: Used to get a variabletable
      operationId: getVariableTable
      parameters:
      - name: variable_table_id
        in: path
        description: ID of desired variabletable
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Results of the query
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariableTable'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::DataTable
    delete:
      tags:
      - VariableTable
      summary: Remove Table
      description: Used to remove a Variable Table
      operationId: removeVariableTable
      parameters:
      - name: variable_table_id
        in: path
        description: The ID of the VariableTable to remove
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: The variable table that was removed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariableTable'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Environment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Delete::DataTable
    patch:
      tags:
      - VariableTable
      summary: Update VariableTable
      description: Used to update existing an existing variable table
      operationId: updateVariableTable
      parameters:
      - name: variable_table_id
        in: path
        description: The ID of the variable table to update
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: If-Match
        in: header
        description: If-Match header according to http/1.1 spec section 14.24
        required: false
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: The update to apply
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VariableTableUpdateRequest'
        required: true
      responses:
        '200':
          description: The updated VariableTable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariableTable'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Environment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Edit::DataTable
  /variables/tables/{variable_table_id}/rows:
    get:
      tags:
      - VariableTable
      summary: Query VariableRows
      description: Used to query VariableRows
      operationId: queryVariableRowsForTable
      parameters:
      - name: variable_table_id
        in: path
        description: ID of the variabletable for which to query variable rows
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: limit
        in: query
        description: The limit to use for pagination
        required: false
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          format: int32
      - name: cursor
        in: query
        description: The cursor to use for pagination
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Results of the query
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariableRowQueryResult'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::DataTable
components:
  responses:
    ErrorResponse401:
      description: User not authenticated
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse400:
      description: Invalid or missing parameter
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse403:
      description: User not authorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse:
      description: Unknown error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
  schemas:
    Variable:
      type: object
      properties:
        name:
          type: string
          description: The variable name
          x-mabl-scope: public
        value:
          type: string
          description: The value associated with the variable defined in the "name" field
          x-mabl-scope: public
      x-mabl-scope: public
      x-implements-interface:
      - HasName
    VariableTable:
      type: object
      properties:
        id:
          type: string
        organization_id:
          type: string
          description: The ID of the organization associated with this VariableTable
        name:
          type: string
          description: The display name for the VariableTable
        description:
          maxLength: 255
          type:
          - string
          - 'null'
          description: The description for the VariableTable
        row_ids:
          type: array
          description: The ordered IDs of the rows in the Variable table
          items:
            type: string
        created_time:
          type: integer
          description: Time at which the entity was created
          format: int64
        created_by_id:
          type: string
          description: The ID of the user who created this entity
        last_updated_time:
          type: integer
          description: Time at which the entity was last updated
          format: int64
        last_updated_by_id:
          type: string
          description: The ID of the user who last updated this entity
        resource_groups:
          type: array
          description: Resource groups this resource belongs to
          items:
            $ref: '#/components/schemas/DerivedResourceGroup'
          x-dao-derived: true
      x-implements-interface:
      - ActivityTrackingBaseEntity
      - HasName
      - HasOrganizationId
    DerivedResourceGroup:
      type: object
      properties:
        resource_group_id:
          type: string
          description: ID of the resource group
        short_name:
          type: string
          description: Name of the resource group
        parent_id:
          type: string
          description: ID of the parent to which this ResourceGroup belongs
        parent_namespace:
          $ref: '#/components/schemas/ResourceGroupParentNamespace'
    VariableTableQueryResult:
      type: object
      properties:
        cursor:
          type: string
          description: Cursor used for pagination
          readOnly: true
        variableTables:
          type: array
          description: All tables that matched the query
          readOnly: true
          items:
            $ref: '#/components/schemas/VariableTable'
    GuardrailApprovalKind:
      type: string
      description: Who decides a guardrail approval. SELF is decided by the person the agent acts for; WORKSPACE, for an agent acting for an API key, by a workspace owner or editor.
      enum:
      - SELF
      - WORKSPACE
    GuardrailRefusal:
      type: object
      properties:
        id:
          type: string
          description: The id of the guardrail policy that decided the refusal.
        reason:
          type: string
          description: Why the policy refuses the request, written for the person the agent acts for.
        decision_id:
          type: string
          description: The id of this decision in the guardrail decision log.
        action:
          type: string
          description: The action the request was evaluated as, written Verb::Resource (for example Delete::Test), as declared by the operation's x-mabl-action extension.
        policy_source:
          type: string
          description: 'Who set the deciding policy: workspace for a rule the workspace''s owners wrote, account for a rule set for the workspace''s account, mabl_agent_type for the agent type''s ceiling, and mabl_default for mabl''s own defaults.'
        approval:
          description: The approval for this request; present when error_code is approval_required and the approval could be recorded. Without it the request cannot be approved.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalRef'
      description: The guardrail policy that refused an agent request.
    ResourceGroupParentNamespace:
      type: string
      description: Namespace of the parent to which this ResourceGroup belongs
      enum:
      - workspaces
    GuardrailApprovalState:
      type: string
      description: Where a guardrail approval stands. PENDING awaits a decision and expires undecided after 24 hours; APPROVED lets the agent repeat the request, as often as it does, for 20 minutes; DENIED refuses the same request for 20 minutes after the decision, after which asking again opens a new approval; CANCELLED means a person withdrew it while pending or revoked it while approved. EXPIRED and CANCELLED are final.
      enum:
      - PENDING
      - APPROVED
      - DENIED
      - EXPIRED
      - CANCELLED
    VariableTableCreationRequest:
      type: object
      properties:
        prototype:
          $ref: '#/components/schemas/VariableTable'
        mappings:
          type: array
          items:
            $ref: '#/components/schemas/VariableRow'
    VariableRowQueryResult:
      type: object
      properties:
        cursor:
          type: string
          description: Cursor used for pagination
          readOnly: true
        variableRows:
          type: array
          description: All rows that matched the query
          readOnly: true
          items:
            $ref: '#/components/schemas/VariableRow'
    GuardrailApprovalRef:
      type: object
      properties:
        id:
          type: string
          description: The approval's id.
        state:
          description: Where the approval stands.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalState'
        kind:
          description: Who decides the approval.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalKind'
        request_expires_time:
          type: integer
          description: When the approval expires if nobody decides it, in epoch milliseconds.
          format: int64
        url:
          type: string
          description: The mabl app page where a person reviews the approval.
      description: 'An approval a guardrail policy asks for. While it is PENDING, stop: give the person the url, tell them the request is waiting for approval, and do not repeat the request or poll in a loop. Once a person tells you it is APPROVED, repeat the identical request with the header X-Mabl-Approval set to id. DENIED means a person said no, so do not work around it.'
    VariableTableUpdateRequest:
      type: object
      properties:
        prototype:
          $ref: '#/components/schemas/VariableTable'
        updatedRows:
          type: array
          items:
            $ref: '#/components/schemas/VariableRow'
        deletedRowIds:
          type: array
          items:
            type: string
        addedRows:
          type: array
          items:
            $ref: '#/components/schemas/VariableRow'
    VariableRow:
      type: object
      properties:
        id:
          type: string
          description: The ID of the VariableRow
        table_id:
          type: string
          description: The ID of the VariableRow's parent table
        row:
          type: array
          items:
            $ref: '#/components/schemas/Variable'
        created_time:
          type: integer
          description: Time at which the VariableRow was created
          format: int64
        created_by_id:
          type: string
          description: The ID of the user who created this VariableRow
        last_updated_time:
          type: integer
          description: Time at which the VariableRow was last updated
          format: int64
        last_updated_by_id:
          type: string
          description: The ID of the user who last updated this VariableRow
        organization_id:
          type: string
          description: The ID of the organization associated with this VariableRow
        scenario_id:
          type: string
          description: The ID of the particular scenario to differentiate between rows in a VariableTable
      x-implements-interface:
      - ActivityTrackingBaseEntity
      - HasOrganizationId
    ErrorResponseGeneric:
      type: object
      properties:
        id:
          type: string
          x-mabl-scope: public
        code:
          maximum: 599
          minimum: 100
          type: integer
          format: int32
          x-mabl-scope: public
        message:
          type: string
          x-mabl-scope: public
        error_code:
          type: string
          description: Machine-readable reason for the error, present only when the API names one. Values are guardrail_blocked (a guardrail policy refused an agent request), approval_required (a guardrail policy requires a person to approve the request first).
        guardrail:
          description: The guardrail policy that refused the request; present only when error_code is guardrail_blocked or approval_required.
          allOf:
          - $ref: '#/components/schemas/GuardrailRefusal'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header