Infoworks

Infoworks File Mappings API

The File Mappings API from Infoworks — 7 operation(s) for file mappings.

GitHub OpenAPI

Operations 10

GET /sources/{source_id}/file-mappings Get File Mappings for JSON source #
POST /sources/{source_id}/file-mappings Create File Mapping For JSON Source #
GET /sources/{source_id}/file-mappings/{file_mapping_id} Get File Mappings for JSON source by id #
DELETE /sources/{source_id}/file-mappings/{file_mapping_id} Delete File Mapping For JSON Source #
PATCH /sources/{source_id}/file-mappings/{file_mapping_id} Update File Mapping For JSON Source #
GET /sources/{source_id}/file-mappings/{file_mapping_id}/preview Get File Mapping Data Preview #
GET /sources/{source_id}/file-mappings/{file_mapping_id}/crawl-schema Crawl Schema For File Mapping #
GET /sources/{source_id}/file-mappings/{file_mapping_id}/table-schema Get Table Schema From Mapping #
POST /sources/{source_id}/file-mappings/{file_mapping_id}/tables Create JSON Source Table #
GET /sources/{source_id}/file-mappings/{file_mapping_id}/tables/{table_id} Get JSON Source Table #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/authentication/infoworks-authentication.yml
📖
Documentation
https://docs.infoworks.io/developer-resources/rest-api
📖
APIReference
https://docs.infoworks.io/infoworks-rest-api-v3/ref

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/openapi/infoworks-file-mappings-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/errors/infoworks-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/conventions/infoworks-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/data-model/infoworks-data-model.yml

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-file-mappings-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

infoworks-file-mappings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact: {}
  title: Infoworks Rest API V3 File Mappings 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: File Mappings
  description: ''
paths:
  /sources/{source_id}/file-mappings:
    parameters:
    - name: source_id
      in: path
      description: Source Id.
      required: true
      schema:
        type: string
    get:
      security:
      - BearerAuth: []
      operationId: getFileMappingsForJSONSource
      tags:
      - File Mappings
      parameters:
      - name: offset
        in: query
        description: The number of items to skip before starting to collect the result set
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: The numbers of items to return
        schema:
          type: integer
          default: 10
      - name: sort_by
        in: query
        description: Sort result on field
        schema:
          type: string
      - name: order_by
        in: query
        description: order  ascending | descending
        schema:
          type: string
          default: asc
          enum:
          - asc
          - desc
      - name: filter
        in: query
        description: Filter results query
        schema:
          type: string
      - name: resolve_ref
        in: query
        description: To get entity details and created by user name
        schema:
          type: boolean
      summary: Get File Mappings for JSON source
      description: Get File Mappings for JSON source
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                properties:
                  total_count:
                    type: integer
                    minimum: 0
                    description: Total count of file mappings
                    example: 10
                  result:
                    type: array
                    items:
                      allOf:
                      - type: object
                        allOf:
                        - type: object
                          properties:
                            created_at:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
                        - type: object
                          properties:
                            created_by:
                              type: string
                              example: 6RkfybTRQQByEey3v
                        - type: object
                          properties:
                            modified_at:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
                        - type: object
                          properties:
                            modified_by:
                              type: string
                              example: 6RkfybTRQQByEey3v
                      - properties:
                          name:
                            type: string
                            example: file_mapping_1
                          configuration:
                            properties:
                              source_relative_path:
                                type: string
                                example: /opt/infoworks/temp_file_sources/json_automation_saas/datatypes
                              record_scope:
                                type: string
                                example: file
                                enum:
                                - file
                                - line
                              include_subdirectories:
                                type: boolean
                                example: true
                              character_encoding:
                                type: string
                                example: UTF-8
                              include_filename_regex:
                                type: string
                                example: .*
                              exclude_filename_regex:
                                type: string
                                example: .*4.*
                      properties:
                        id:
                          type: string
                          example: e77850ad5127a2d7dab870ff
                        json_schema:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: integer
                                example: 1
                              name:
                                type: string
                                example: del
                              properties:
                                type: object
                                properties:
                                  sql_type:
                                    type: integer
                                    example: 1
                                  target_sql_type:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: struct
                        table_details:
                          type: array
                          items:
                            properties:
                              id:
                                type: string
                                example: d04a89ca9d4e9af1b86fdc3e
                              name:
                                type: string
                                example: tableName
                              state:
                                type: string
                                example: ready
        '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
    post:
      security:
      - BearerAuth: []
      operationId: createFileMappingForSource
      tags:
      - File Mappings
      summary: Create File Mapping For JSON Source
      description: Create File Mapping For JSON Source
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  type: string
                  example: file_mapping_1
                configuration:
                  properties:
                    source_relative_path:
                      type: string
                      example: /opt/infoworks/temp_file_sources/json_automation_saas/datatypes
                    record_scope:
                      type: string
                      example: file
                      enum:
                      - file
                      - line
                    include_subdirectories:
                      type: boolean
                      example: true
                    character_encoding:
                      type: string
                      example: UTF-8
                    include_filename_regex:
                      type: string
                      example: .*
                    exclude_filename_regex:
                      type: string
                      example: .*4.*
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      type: string
                      example: e77850ad5127a2d7dab870ff
        '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}/file-mappings/{file_mapping_id}:
    parameters:
    - name: source_id
      in: path
      description: Source Id.
      required: true
      schema:
        type: string
    - name: file_mapping_id
      in: path
      description: File Mapping Id.
      required: true
      schema:
        type: string
    get:
      security:
      - BearerAuth: []
      operationId: getFileMappingsForJSONSourceById
      tags:
      - File Mappings
      summary: Get File Mappings for JSON source by id
      description: Get File Mappings for JSON source by id
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                properties:
                  result:
                    allOf:
                    - type: object
                      allOf:
                      - type: object
                        properties:
                          created_at:
                            type: string
                            example: '2019-11-21T12:54:05.875Z'
                      - type: object
                        properties:
                          created_by:
                            type: string
                            example: 6RkfybTRQQByEey3v
                      - type: object
                        properties:
                          modified_at:
                            type: string
                            example: '2019-11-21T12:54:05.875Z'
                      - type: object
                        properties:
                          modified_by:
                            type: string
                            example: 6RkfybTRQQByEey3v
                    - properties:
                        name:
                          type: string
                          example: file_mapping_1
                        configuration:
                          properties:
                            source_relative_path:
                              type: string
                              example: /opt/infoworks/temp_file_sources/json_automation_saas/datatypes
                            record_scope:
                              type: string
                              example: file
                              enum:
                              - file
                              - line
                            include_subdirectories:
                              type: boolean
                              example: true
                            character_encoding:
                              type: string
                              example: UTF-8
                            include_filename_regex:
                              type: string
                              example: .*
                            exclude_filename_regex:
                              type: string
                              example: .*4.*
                    properties:
                      id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      json_schema:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: integer
                              example: 1
                            name:
                              type: string
                              example: del
                            properties:
                              type: object
                              properties:
                                sql_type:
                                  type: integer
                                  example: 1
                                target_sql_type:
                                  type: integer
                                  example: 1
                                type:
                                  type: string
                                  example: struct
                      table_details:
                        type: array
                        items:
                          properties:
                            id:
                              type: string
                              example: d04a89ca9d4e9af1b86fdc3e
                            name:
                              type: string
                              example: tableName
                            state:
                              type: string
                              example: ready
        '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
    delete:
      security:
      - BearerAuth: []
      operationId: deleteFileMapping
      tags:
      - File Mappings
      summary: Delete File Mapping For JSON Source
      description: Delete File Mapping For JSON Source
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      type: string
                      example: e77850ad5127a2d7dab870ff
        '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: []
      operationId: updateFileMappingForSource
      tags:
      - File Mappings
      summary: Update File Mapping For JSON Source
      description: Update File Mapping For JSON Source
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  type: string
                  example: file_mapping_1
                configuration:
                  properties:
                    source_relative_path:
                      type: string
                      example: /opt/infoworks/temp_file_sources/json_automation_saas/datatypes
                    record_scope:
                      type: string
                      example: file
                      enum:
                      - file
                      - line
                    include_subdirectories:
                      type: boolean
                      example: true
                    character_encoding:
                      type: string
                      example: UTF-8
                    include_filename_regex:
                      type: string
                      example: .*
                    exclude_filename_regex:
                      type: string
                      example: .*4.*
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      type: string
                      example: e77850ad5127a2d7dab870ff
        '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}/file-mappings/{file_mapping_id}/preview:
    parameters:
    - name: source_id
      in: path
      description: Source Id.
      required: true
      schema:
        type: string
    - name: file_mapping_id
      in: path
      description: File Mapping Id.
      required: true
      schema:
        type: string
    get:
      security:
      - BearerAuth: []
      operationId: getFileMappingPreview
      tags:
      - File Mappings
      summ

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