Caspio Views API

View record operations

OpenAPI Specification

caspio-views-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Caspio REST Applications Views API
  description: 'The Caspio Bridge REST API (v3) provides programmatic access to tables, views,

    records, files, users, applications, and tasks in a Caspio account. The base URL

    is account-specific (per-tenant integration URL) and authentication uses an OAuth

    2.0 client credentials flow to obtain a bearer access token. This best-effort

    OpenAPI is derived from the public help documentation at

    https://howto.caspio.com/web-services-api/rest-api/ and the demo Swagger at

    https://demo.caspio.com/integrations/rest/swagger.

    '
  version: 3.0.0
  contact:
    name: Caspio
    url: https://www.caspio.com/
servers:
- url: https://{account}.caspio.com/rest/v3
  description: Per-account Caspio Bridge REST endpoint
  variables:
    account:
      default: demo
      description: Caspio account subdomain
security:
- bearerAuth: []
tags:
- name: Views
  description: View record operations
paths:
  /views:
    get:
      tags:
      - Views
      summary: List all views in the account
      operationId: listViews
      responses:
        '200':
          description: View names
  /views/{viewName}/records:
    get:
      tags:
      - Views
      summary: Query view records
      operationId: queryViewRecords
      parameters:
      - in: path
        name: viewName
        required: true
        schema:
          type: string
      - in: query
        name: q.where
        schema:
          type: string
      - in: query
        name: q.limit
        schema:
          type: integer
      responses:
        '200':
          description: Records page
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordsPage'
components:
  schemas:
    RecordsPage:
      type: object
      properties:
        Result:
          type: array
          items:
            type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT