Infoworks Tables API

The Tables API from Infoworks — 37 operation(s) for tables.

Documentation GitHub OpenAPI

Operations 54

POST /sources/{source_id}/tables/{table_id}/configurations/file-mapping Creates the file mapping (table) of the csv source. #

PUT /sources/{source_id}/tables/{table_id}/configurations/file-mapping Modifies the file mapping (table) of the csv source. #

PATCH /sources/{source_id}/tables/{table_id}/configurations/file-mapping Updates the file mapping (table) of the csv source. #

PUT /sources/{source_id}/metadata update source metadata

GET /sources/{source_id}/metadata get source metadata

GET /sources/{source_id}/edit-staging-fields get whether staging fields can be edited

GET /sources/{source_id}/tables/{table_id}/jobs/{job_id}/reports/sourceFilesPath Get the list of Source Files paths of the table

GET /sources/{source_id}/meta-crawled-table-count Get meta crawled table count

GET /sources/{source_id}/source_tables/excluded-tables Get List of excluded tables

GET /sources/{source_id}/source_tables/schema-for-source Get Source schema

GET /sources/{source_id}/tables list all the tables in the source #

POST /sources/{source_id}/tables Add tables to a File Source

POST /sources/{source_id}/fetch-tables list all the tables in the source #

GET /sources/{source_id}/tables/{table_id} Get Table Info

PATCH /sources/{source_id}/tables/{table_id} Update the Table

DELETE /sources/{source_id}/tables/{table_id} Delete Table for a source #

GET /sources/{source_id}/tables/{table_id}/crawl-schema Crawl Table Schema

POST /sources/{source_id}/tables/source_tables add the tables to a source and crawl metadata of those added tables #

PUT /sources/{source_id}/tables/{table_id}/configurations/ingestion Updates and configures the table for Ingestion

GET /sources/{source_id}/tables/{table_id}/configurations/ingestion Get ingestion configuration of table

GET /sources/{source_id}/tables/{table_id}/configurations/advance Get list of Entity advance configuration

POST /sources/{source_id}/tables/{table_id}/configurations/advance Add advance configuration for a table

GET /sources/{source_id}/tables/{table_id}/configurations/advance/{key} Get table advance configuration

PUT /sources/{source_id}/tables/{table_id}/configurations/advance/{key} update advance configuration for a table

DELETE /sources/{source_id}/tables/{table_id}/configurations/advance/{key} Delete advance configuration for a table

PUT /sources/{source_id}/tables/{table_id}/configurations/export update table export configuration

GET /sources/{source_id}/tables/{table_id}/configurations/export get table export configuration

PATCH /sources/{source_id}/tables/{table_id}/column-order update table column order

PUT /sources/{source_id}/tables/{table_id}/metadata update table metadata

GET /sources/{source_id}/tables/{table_id}/metadata get table metadata

GET /sources/{source_id}/tables/{table_id}/configurations/export/connection Get table export configuration connection properties

PUT /sources/{source_id}/tables/{table_id}/configurations/export/connection update table export configuration Connection properties

POST /sources/{source_id}/tables/{table_id}/segmentation/start Start Segmentation on a Table #

POST /sources/{source_id}/tables/{table_id}/segmentation/crawl Crawl Segments Metadata on a Table #

GET /sources/{source_id}/tables/{table_id}/segmentation Get Table Segments of a Table #

POST /sources/{source_id}/tables/{table_id}/segmentation/end End Segmentation on a Table #

POST /sources/{source_id}/tables/{table_id}/segmentation/cancel Cancel Segmentation on a Table #

GET /sources/{source_id}/tables/{table_id}/configurations/schema Get the schema of the table

PUT /sources/{source_id}/tables/{table_id}/configurations/schema Update the schema of the table

GET /sources/{source_id}/tables/{table_id}/configurations

GET /sources/{source_id}/tables/{table_id}/segments Get a list of all table segments.

GET /sources/{source_id}/tables/{table_id}/validation-specs Gets Validation Specs for a Table.

POST /sources/{source_id}/tables/{table_id}/validation-specs Add Validation Specs to a Table.

PATCH /sources/{source_id}/tables/{table_id}/validation-specs/{validation_spec_id} Updates the Validation Specs for a table. #

DELETE /sources/{source_id}/tables/{table_id}/validation-specs/{validation_spec_id} Delete Validation Specs for a Table #

GET /sources/{source_id}/table/{source_table_id}/get-preview Get table preview.

GET /sources/{source_id}/table/{source_table_id}/generate-preview Generate table preview.

GET /sources/{source_id}/query_table/generate-preview Generate query table preview.

GET /sources/{source_id}/query_table/get-preview Get query table preview.

GET /sources/{source_id}/tables/{table_id}/generateQueries Get Preview Queries.

GET /tables/ Get multiple table Ids

PATCH /tables/{table_id}/metadata update table metadata

GET /tables/{table_id}/metadata get table metadata

GET /tables/{table_id}/lineage get table lineage

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/infoworks-tables-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  contact: {}
  title: Infoworks Rest API V3 Tables API
  version: '1.0'
  description: Infoworks Rest API V3
servers:
- url: '{protocol}://{host}:{port}/v3'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    host:
      default: localhost
    port:
      default: '3001'
tags:
- name: Tables
  description: ''
paths:
  /sources/{source_id}/tables/{table_id}/configurations/file-mapping:
    parameters:
    - name: Content-Type
      in: header
      description: Http content type
      required: true
      schema:
        type: string
    - name: source_id
      in: path
      description: Source Id.
      required: true
      schema:
        type: string
    - name: table_id
      in: path
      description: Table Id.
      required: true
      schema:
        type: string
    post:
      security:
      - BearerAuth: []
      tags:
      - Tables
      summary: Creates the file mapping (table) of the csv source.
      description: Creates the previously configured file mapping (table) of the csv source.
      operationId: createFileMappingForTable
      requestBody:
        description: This is the JSON body of request containing configured Table object.
        content:
          application/json:
            schema:
              type: object
              properties:
                header_rows_count:
                  type: integer
                  format: int64
                column_separator:
                  type: string
                column_enclosed_by:
                  type: string
                escape_character:
                  type: string
                encoding:
                  type: string
                enable_pk_chunk:
                  type: boolean
                record_width_type:
                  type: string
                record_separator:
                  type: string
                columns_configuration:
                  type: array
                  items:
                    allOf:
                    - allOf:
                      - type: object
                        properties:
                          column_width:
                            type: integer
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      status:
                        type: string
                        example: success
                      id:
                        type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    put:
      security:
      - BearerAuth: []
      tags:
      - Tables
      summary: Modifies the file mapping (table) of the csv source.
      description: Modifies the previously configured file mapping (table) of the csv source.
      operationId: modifyFileMappingForTable
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                header_rows_count:
                  type: integer
                  format: int64
                column_separator:
                  type: string
                column_enclosed_by:
                  type: string
                escape_character:
                  type: string
                encoding:
                  type: string
                enable_pk_chunk:
                  type: boolean
                record_width_type:
                  type: string
                record_separator:
                  type: string
                columns_configuration:
                  type: array
                  items:
                    allOf:
                    - allOf:
                      - type: object
                        properties:
                          column_width:
                            type: integer
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      status:
                        type: string
                        example: success
                      id:
                        type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    patch:
      security:
      - BearerAuth: []
      tags:
      - Tables
      summary: Updates the file mapping (table) of the csv source.
      description: Updates the previously configured file mapping (table) of the csv source.
      operationId: updateFileMappingForTable
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                header_rows_count:
                  type: integer
                  format: int64
                column_separator:
                  type: string
                column_enclosed_by:
                  type: string
                escape_character:
                  type: string
                encoding:
                  type: string
                enable_pk_chunk:
                  type: boolean
                record_width_type:
                  type: string
                record_separator:
                  type: string
                columns_configuration:
                  type: array
                  items:
                    allOf:
                    - allOf:
                      - type: object
                        properties:
                          column_width:
                            type: integer
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      status:
                        type: string
                        example: success
                      id:
                        type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/metadata:
    parameters:
    - name: Content-Type
      in: header
      description: Http content type
      required: true
      schema:
        type: string
    - name: table_id
      in: path
      description: Table Id.
      required: true
      schema:
        type: string
    - name: source_id
      in: path
      description: Source Id.
      required: true
      schema:
        type: string
    put:
      security:
      - BearerAuth: []
      tags:
      - Tables
      summary: update source metadata
      description: update source metadata
      requestBody:
        description: Source Metadata
        content:
          application/json:
            schema:
              type: object
              properties:
                tags_to_add:
                  type: array
                  items:
                    type: string
                    example: sales
                tags_to_remove:
                  type: array
                  items:
                    type: string
                    example: engg
                is_favorite:
                  type: boolean
                  example: true
                description:
                  type: string
                  example: description
            examples:
              EntityMetadata:
                value:
                  tags_to_add:
                  - sales
                  tags_to_remove:
                  - engg
                  is_favorite: true
                  description: description
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Successfully updated metadata
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    get:
      security:
      - BearerAuth: []
      tags:
      - Tables
      summary: get source metadata
      description: get source metadata
      responses:
        '200':
          description: get source metadata
          content:
            application/json:
              schema:
                type: object
                properties:
                  tags:
                    type: array
                    items:
                      type: string
                      example: sales
                  is_favorite:
                    type: boolean
                    example: true
                  description:
                    type: string
                    example: description
              examples:
                EntityMetadata:
                  value:
                    tags:
                    - sales
                    is_favorite: true
                    description: description
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/edit-staging-fields:
    parameters:
    - name: Content-Type
      in: header
      description: Http content type
      required: true
      schema:
        type: string
    - name: source_id
      in: path
      description: Source Id.
      required: true
      schema:
        type: string
    get:
      security:
      - BearerAuth: []
      tags:
      - Tables
      summary: get whether staging fields can be edited
      description: get whether staging fields can be edited
      responses:
        '200':
          description: get whether staging fields can be edited
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: 'Fetched result. '
                  result:
                    type: boolean
                    example: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/jobs/{job_id}/reports/sourceFilesPath:
    parameters:
    - name: Content-Type
      in: header
      description: Http content type
      required: true
      schema:
        type: string
    - name: table_id
      in: path
      description: Table Id.
      required: true
      schema:
        type: string
    - name: source_id
      in: path
      description: Source Id.
      required: true
      schema:
        type: string
    - name: job_id
      in: path
      description: Job Id
      required: true
      schema:
        type: string
    get:
      security:
      - BearerAuth: []
      tags:
      - Tables
      summary: Get the list of Source Files paths of the table
      description: Get the list of Source Files paths of the table
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    result:
                      type: array
                      items:
                        type: object
                        properties:
                          result:
                            type: array
                            items:
                              type: string
                - type: object
                  properties:
                    limit:
                      type: integer
                      example: 10
                    offset:
                      type: integer
                      example: 0
                    links:
                      type: object
                      properties:
                        base:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                        self:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                        next:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                    total_count:
                      type: integer
                      example: 10
                  x-examples:
                    example-1: {}
        '400':
          description: Bad Request
 

# --- truncated at 32 KB (414 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/openapi/infoworks-tables-api-openapi.yml