Wegalvanize Tables API

openapi: 3.2.0
info:
  title: HighBond API Reference Tables API
  version: 1.1.0
  description: Welcome to the API documentation for HighBond.
  x-logo:
    url: ./assets/logo.png
    altText: HighBond Logo
servers:
- url: '{protocol}://{server}/v1'
  variables:
    protocol:
      default: https
    server:
      default: apis-us.highbond.com
      enum:
      - apis-us.highbond.com
      - apis-ca.highbond.com
      - apis-eu.highbond.com
      - apis-ap.highbond.com
      - apis-au.highbond.com
      - apis-af.highbond.com
      - apis-sa.highbond.com
      - apis-jp.highbond.com
security:
- bearerToken: []
tags:
- name: Tables
  description: Tables store records of data in rows and columns.
paths:
  /orgs/{org_id}/analyses/{analysis_id}/tables:
    get:
      tags:
      - Tables
      operationId: getTables
      summary: Get tables
      description: Get all data analytic, reference, and assessment tables for analysis.
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/analysisIdParam'
      responses:
        '200':
          description: OK.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/GetTablesResponse'
        '400':
          $ref: '#/components/responses/MissingOrgId'
        '401':
          $ref: '#/components/responses/BadCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '415':
          $ref: '#/components/responses/NotJsonapiMediaType'
    post:
      tags:
      - Tables
      operationId: createTable
      summary: Create a table
      description: 'Create a new, empty table in an existing analysis.


        Limitations:

        * Your organization can have a maximum of 5,000 tables.'
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/analysisIdParam'
      requestBody:
        description: The data required to create a table.
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/CreateTablePayload'
      responses:
        '201':
          description: Created.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/SingleTableResponse'
        '400':
          $ref: '#/components/responses/ResourceTypeMismatch'
        '401':
          $ref: '#/components/responses/BadCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '415':
          $ref: '#/components/responses/NotJsonapiMediaType'
        '422':
          description: 'Unprocessable entity.

            '
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                - status: 422
                  source:
                    pointer: /data/attributes/name
                  code: invalid_resource
                  detail: can't be blank
                - status: 422
                  code: unprocessable_entity
                  detail: Maximum number of 5,000 Tables reached.
  /orgs/{org_id}/tables/{id}:
    get:
      tags:
      - Tables
      operationId: getTable
      summary: Get a table
      description: Get information about a table.
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/resourceIdParam'
      responses:
        '200':
          description: OK.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/SingleTableResponse'
        '400':
          $ref: '#/components/responses/MissingResourceId'
        '401':
          $ref: '#/components/responses/BadCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '415':
          $ref: '#/components/responses/NotJsonapiMediaType'
    put:
      tags:
      - Tables
      operationId: updateTable
      summary: Update a table
      description: Make changes to a table, like renaming it. You do not need to update tables for them to reflect changes in data.
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/resourceIdParam'
      requestBody:
        description: The data required to update a table.
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/UpdateTablePayload'
      responses:
        '200':
          description: OK.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/SingleTableResponse'
        '400':
          $ref: '#/components/responses/ResourceIdConflict'
        '401':
          $ref: '#/components/responses/BadCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '415':
          $ref: '#/components/responses/NotJsonapiMediaType'
        '422':
          description: 'Unprocessable entity.

            '
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                - status: 422
                  source:
                    pointer: /data/attributes/name
                  code: invalid_resource
                  detail: is too long (maximum is 255 characters)
    delete:
      tags:
      - Tables
      operationId: deleteTable
      summary: Delete a table
      description: 'Permanently delete a table.


        > **Caution —**

        Deleting a table also permanently removes associated records, interpretations, metrics, and triggers.


        Limitations: Generally, you cannot delete tables that were created in HighBond to support the operation of another feature (for example, Certifications and Control Performance generates their own data structures). You can delete these tables by deleting the project that generated them in the Projects app.'
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/resourceIdParam'
      responses:
        '202':
          $ref: '#/components/responses/Accepted'
        '400':
          $ref: '#/components/responses/MissingOrgId'
        '401':
          $ref: '#/components/responses/BadCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '415':
          $ref: '#/components/responses/NotJsonapiMediaType'
components:
  schemas:
    Errors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
    RelationshipObject:
      type: object
      description: The object related to the resource.
      required:
      - data
      properties:
        data:
          type: object
          description: The data associated with the related object.
          required:
          - id
          - type
          properties:
            id:
              type: string
              description: The ID of the related object.
              example: 1
            type:
              type: string
              description: The classification of the related object.
              example: collection
    CreateTablePayload:
      type: object
      description: The data associated with the resource.
      required:
      - data
      properties:
        data:
          type: object
          description: The data associated with the resource.
          required:
          - type
          - attributes
          properties:
            type:
              type: string
              description: The classification of the object (`"tables"`).
              example: tables
            attributes:
              type: object
              description: The attributes associated with the resource.
              required:
              - name
              properties:
                name:
                  type: string
                  description: The name of the table.
                  maxLength: 255
                  example: My first Table
                description:
                  type: string
                  description: The description of the table.
                  example: Description of My first Table
                script_name:
                  type: string
                  description: The name of the script, or process, used to generate the result set.
                  maxLength: 255
                  example: Sec01_Wknd_Unauth_Access_Point
                publish_platform_reporting_sync:
                  type: boolean
                  description: The flag that indicates whether the table is synchronizing with activity center.
                  example: true
                table_type:
                  type: string
                  description: Table type; this cannot be updated once table is created.
                  enum:
                  - data_analytic
                  - assessment_table
                  default: data_analytic
                  example: data_analytic
                questionnaire_id:
                  type: string
                  description: The id of the single questionnaire associated with this table (assessment tables only).
                  example: '1'
    Error:
      type: object
      required:
      - status
      properties:
        status:
          type: string
          description: The HTTP status code.
        source:
          type: object
          description: Indicates which part of the request document caused the error.
          required:
          - pointer
          properties:
            pointer:
              type: string
              description: 'A JSON Pointer <a href="https://tools.ietf.org/html/rfc6901" target="_blank">(RFC6901)</a> to the associated entity

                in the request document.

                '
        code:
          type: string
          description: Application-specific error code, expressed as a string value.
        title:
          type: string
          description: A short, human-readable summary of the problem.
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
    GetTablesResponse:
      type: object
      description: The data associated with the resource.
      required:
      - data
      properties:
        data:
          type: array
          description: Tables data.
          items:
            type: object
            description: The data associated with the resource.
            required:
            - id
            - type
            - attributes
            - relationships
            properties:
              id:
                type: string
                description: The ID of the table.
                example: '300'
              type:
                type: string
                description: The classification of the object (`"tables"`).
                example: tables
              attributes:
                type: object
                description: The attributes associated with the resource.
                properties:
                  name:
                    type: string
                    description: The name of the table.
                    maxLength: 255
                    example: My first Table
                  description:
                    type: string
                    description: The description of the table.
                    example: Description of My first Table
                  script_name:
                    type: string
                    description: The name of the script, or process, used to generate the result set.
                    maxLength: 255
                    example: Sec01_Wknd_Unauth_Access_Point
                  publish_platform_reporting_sync:
                    type: boolean
                    description: The flag that indicates whether the table is synchronizing with activity center.
                    example: true
                  table_type:
                    type: string
                    description: Table type; this cannot be updated once table is created.
                    enum:
                    - data_analytic
                    - assessment_table
                    default: data_analytic
                    example: data_analytic
                  questionnaire_id:
                    type: string
                    description: The id of the single questionnaire associated with this table (assessment tables only).
                    example: '1'
                  primary_key:
                    type:
                    - string
                    - 'null'
                    description: Field that uniquely identifies a record. Specifying a primary key field allows uploads of records sharing the same primary key to be merged rather than duplicated.
                    maxLength: 255
                    default: null
                    example: primary_key
                  record_identifiers:
                    type: array
                    items:
                      type: string
                    description: 'Select a few non-sensitive fields that identify a record. You can select any imported data, Results metadata fields, and questionnaire fields. These fields will be displayed in emails sent to recipients and when they fill out questionnaires. In sequential certifications, recipients always see previous answers.

                      * You can select values from `user_fields` (user-created columns in the table)

                      * You can select values from `metadata_fields`, which can be one or more of the following: `record_id`, `position`, `priority`, `status`, `publish_date`, `publisher`, `assignee`, `group`, `updated_at`, `closed_at`

                      '
                    default:
                    - :record_id
                    example:
                    - :record_id
                  data_table_id:
                    type: integer
                    description: The data table ID of the table.
                    example: 123
                    format: int64
                  created_at:
                    type: string
                    description: The date the table was created.
                    example: '2019-02-09T13:17:26Z'
                    format: date-time
                  updated_at:
                    type: string
                    description: The date the table was updated.
                    example: '2019-03-18T22:02:05Z'
                    format: date-time
              relationships:
                type: object
                description: The relationships associated with the resource.
                properties:
                  analysis:
                    $ref: '#/components/schemas/RelationshipObject'
                example:
                  analysis:
                    data:
                      id: '20'
                      type: analyses
    SingleTableResponse:
      type: object
      description: The data associated with the resource.
      required:
      - data
      properties:
        data:
          type: object
          description: The data associated with the resource.
          required:
          - id
          - type
          - attributes
          - relationships
          properties:
            id:
              type: string
              description: The ID of the table.
              example: '300'
            type:
              type: string
              description: The classification of the object (`"tables"`).
              example: tables
            attributes:
              type: object
              description: The attributes associated with the resource.
              properties:
                name:
                  type: string
                  description: The name of the table.
                  maxLength: 255
                  example: My first Table
                description:
                  type: string
                  description: The description of the table.
                  example: Description of My first Table
                script_name:
                  type: string
                  description: The name of the script, or process, used to generate the result set.
                  maxLength: 255
                  example: Sec01_Wknd_Unauth_Access_Point
                publish_platform_reporting_sync:
                  type: boolean
                  description: The flag that indicates whether the table is synchronizing with activity center.
                  example: true
                table_type:
                  type: string
                  description: Table type; this cannot be updated once table is created.
                  enum:
                  - data_analytic
                  - assessment_table
                  default: data_analytic
                  example: data_analytic
                questionnaire_id:
                  type: string
                  description: The id of the single questionnaire associated with this table (assessment tables only).
                  example: '1'
                primary_key:
                  type:
                  - string
                  - 'null'
                  description: Field that uniquely identifies a record. Specifying a primary key field allows uploads of records sharing the same primary key to be merged rather than duplicated.
                  maxLength: 255
                  default: null
                  example: primary_key
                record_identifiers:
                  type: array
                  items:
                    type: string
                  description: 'Select a few non-sensitive fields that identify a record. You can select any imported data, Results metadata fields, and questionnaire fields. These fields will be displayed in emails sent to recipients and when they fill out questionnaires. In sequential certifications, recipients always see previous answers.

                    * You can select values from `user_fields` (user-created columns in the table)

                    * You can select values from `metadata_fields`, which can be one or more of the following: `record_id`, `position`, `priority`, `status`, `publish_date`, `publisher`, `assignee`, `group`, `updated_at`, `closed_at`

                    '
                  default:
                  - :record_id
                  example:
                  - :record_id
                data_table_id:
                  type: integer
                  description: The data table ID of the table.
                  example: 123
                  format: int64
                created_at:
                  type: string
                  description: The date the table was created.
                  example: '2019-02-09T13:17:26Z'
                  format: date-time
                updated_at:
                  type: string
                  description: The date the table was updated.
                  example: '2019-03-18T22:02:05Z'
                  format: date-time
            relationships:
              type: object
              description: The relationships associated with the resource.
              properties:
                analysis:
                  $ref: '#/components/schemas/RelationshipObject'
              example:
                analysis:
                  data:
                    id: '20'
                    type: analyses
    UpdateTablePayload:
      type: object
      description: The data associated with the resource.
      required:
      - data
      properties:
        data:
          type: object
          description: The data associated with the resource.
          required:
          - id
          - type
          - attributes
          properties:
            id:
              type: string
              description: The ID of the table.
              example: '300'
            type:
              type: string
              description: The classification of the object (`"tables"`).
              example: tables
            attributes:
              type: object
              description: The attributes associated with the resource.
              properties:
                name:
                  type: string
                  description: The name of the table.
                  maxLength: 255
                  example: My first Table
                description:
                  type: string
                  description: The description of the table.
                  example: Description of My first Table
                script_name:
                  type: string
                  description: The name of the script, or process, used to generate the result set.
                  maxLength: 255
                  example: Sec01_Wknd_Unauth_Access_Point
                publish_platform_reporting_sync:
                  type: boolean
                  description: The flag that indicates whether the table is synchronizing with activity center.
                  example: true
                primary_key:
                  type:
                  - string
                  - 'null'
                  description: Field that uniquely identifies a record. Specifying a primary key field allows uploads of records sharing the same primary key to be merged rather than duplicated.
                  maxLength: 255
                  default: null
                  example: primary_key
                record_identifiers:
                  type: array
                  items:
                    type: string
                  description: 'Select a few non-sensitive fields that identify a record. You can select any imported data, Results metadata fields, and questionnaire fields. These fields will be displayed in emails sent to recipients and when they fill out questionnaires. In sequential certifications, recipients always see previous answers.

                    * You can select values from `user_fields` (user-created columns in the table)

                    * You can select values from `metadata_fields`, which can be one or more of the following: `record_id`, `position`, `priority`, `status`, `publish_date`, `publisher`, `assignee`, `group`, `updated_at`, `closed_at`

                    '
                  default:
                  - :record_id
                  example:
                  - :record_id
  responses:
    MissingResourceId:
      description: Bad request.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/Errors'
          example:
            errors:
            - status: 400
              code: parameter_missing
              title: Parameter missing
              detail: The required parameter, id, is missing.
    ResourceTypeMismatch:
      description: Bad request.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/Errors'
          example:
            errors:
            - status: 400
              code: resource_type_mismatch
              title: Resource type mismatch
              detail: 'The requested data type, a-bad-type, is incompatible with the endpoint.

                '
    NotFound:
      description: Not found.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/Errors'
          example:
            errors:
            - status: '404'
              title: Not Found
              detail: The requested resource does not exist.
    ResourceIdConflict:
      description: Bad request.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/Errors'
          example:
            errors:
            - status: 400
              code: resource_id_conflict
              title: Resource ID conflict
              detail: 'The id specified in the request body, 1, conflicts with

                the id specified in the path, 101.

                '
    Accepted:
      description: Accepted.
    NotJsonapiMediaType:
      description: Unsupported media type.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/Errors'
          example:
            errors:
            - status: 415
              code: unsupported_media_type
              title: Unsupported media type
              detail: 'The endpoint supports only the application/vnd.api+json Content-Type. This request specified application/json.

                '
    Forbidden:
      description: Forbidden.
    MissingOrgId:
      description: Bad request.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/Errors'
          example:
            errors:
            - status: 400
              code: parameter_missing
              title: Parameter missing
              detail: The required parameter, org_id, is missing.
    BadCredentials:
      description: Bad credentials.
  parameters:
    analysisIdParam:
      in: path
      name: analysis_id
      description: The ID of the analysis where the requested table will be created.
      required: true
      schema:
        type: integer
        example: 20
    resourceIdParam:
      in: path
      name: id
      description: The ID of the requested resource.
      required: true
      schema:
        type: string
        example: 9999
    orgIdParam:
      in: path
      name: org_id
      description: The ID of the HighBond instance.
      required: true
      schema:
        type: string
        example: 1
  securitySchemes:
    bearerToken:
      description: 'HighBond offers the industry-standard OAuth 2.0 flow for connecting to the HighBond platform. OAuth 2.0 provides a

        safe and secure way to access data, while protecting your account credentials.

        '
      type: http
      scheme: bearer
      bearerFormat: oauth2
x-tagGroups:
- name: Core resources
  tags:
  - Robots Agents
  - Robots
  - Robot Tasks
  - Robot Jobs
  - Robot Apps
  - Robot Script Versions
  - Robot Activations
  - Robot Files
  - Robot Working Files
  - Robot Collaborators
  - Robots Folders Collaborators
  - Robot Users
  - Robots Folders
  - Storyboards
  - Collections
  - Questionnaires
  - Analyses
  - Surveys
  - Event Reports
  - Tables
  - Table columns
  - Records
  - Record columns
  - Record statuses
  - Interpretations
  - Metrics
  - Workflow Groups
  - Results Users
  - Results Triggers
  - Project types
  - Custom attributes
  - Request item statuses
  - Projects
  - Projects Admin
  - Planning files
  - Results files
  - Objectives
  - Narratives
  - Risks
  - Controls
  - Control performance schedules
  - Mitigations
  - Control test plans
  - Control tests
  - Attachments
  - Walkthroughs
  - Issues
  - Actions
  - Collaborators
  - Request Items
  - To-dos
  - Sign-offs
  - Entities
  - Scheduler Filters
  - Frameworks
  - Handlers
  - Workflows in Asset Inventory/Asset Manager
  - Asset types
  - Asset record types
  - Attribute types
  - Assets
  - Asset Relationships
  - Asset records
  - Asset Record Relationships
  - Events
  - Template Toolkits
  - Toolkits
  - Roles
  - Role Deletion
  - Compliance Maps
  - Time entries
  - Non-project time categories
  - Timesheets
  - Importer
  - System Users
  - Organizations
  - Impact Reports
  - Activities
  - Users
  - Groups
  - Scheduled Users
  - Scheduled Projects
  - Scheduled Hours
  - Extract
  - Strategy