openapi: 3.2.0 info: contact: {} title: Infoworks Rest API V3 Table Groups 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: Table Groups description: '' paths: /sources/{source_id}/table-groups: 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 post: security: - BearerAuth: [] tags: - Table Groups summary: Add a `Table Group`. description: Add a `Table Group`. requestBody: content: application/json: schema: allOf: - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - type: object properties: source: type: string example: e77850ad5127a2d7dab870ff environment_compute_template: properties: environment_compute_template_id: type: string example: e77850ad5127a2d7dab870ff name: type: string max_connections: type: integer example: 1 max_parallel_entities: type: integer example: 1 tables: type: array items: properties: table_id: type: string example: e77850ad5127a2d7dab870ff connection_quota: type: integer example: 100 sync_type: type: string example: Incremental state: type: string example: ready schema_name_at_source: type: string example: APEX_040000 compute_cluster_name: type: string example: Persistent Cluster responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Table Group Successfully Created result: properties: id: type: string example: c70822c5a88e5521a8153c7c '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: - Table Groups summary: Gets `Table Group` list. description: Gets `Table Group` list. 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 responses: '200': description: Success content: application/json: schema: allOf: - 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: {} - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: array items: allOf: - allOf: - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - type: object properties: source: type: string example: e77850ad5127a2d7dab870ff environment_compute_template: properties: environment_compute_template_id: type: string example: e77850ad5127a2d7dab870ff name: type: string max_connections: type: integer example: 1 max_parallel_entities: type: integer example: 1 tables: type: array items: properties: table_id: type: string example: e77850ad5127a2d7dab870ff connection_quota: type: integer example: 100 sync_type: type: string example: Incremental state: type: string example: ready schema_name_at_source: type: string example: APEX_040000 compute_cluster_name: type: string example: Persistent Cluster '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}/table-groups/{table_group_id}: 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_group_id in: path description: Table Group Id required: true schema: type: string get: security: - BearerAuth: [] tags: - Table Groups summary: Gets `Table Group` object for given id. description: Gets `Table Group` object for given id. parameters: - name: resolve_ref in: query description: To get entity details and created by user name schema: type: boolean responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - allOf: - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - type: object properties: source: type: string example: e77850ad5127a2d7dab870ff environment_compute_template: properties: environment_compute_template_id: type: string example: e77850ad5127a2d7dab870ff name: type: string max_connections: type: integer example: 1 max_parallel_entities: type: integer example: 1 tables: type: array items: properties: table_id: type: string example: e77850ad5127a2d7dab870ff connection_quota: type: integer example: 100 sync_type: type: string example: Incremental state: type: string example: ready schema_name_at_source: type: string example: APEX_040000 compute_cluster_name: type: string example: Persistent Cluster '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: - Table Groups summary: Update `Table Group` object for given id. description: Update `Table Group` object for given id. requestBody: content: application/json: schema: allOf: - type: object properties: environment_compute_template: properties: environment_compute_template_id: type: string example: e77850ad5127a2d7dab870ff name: type: string max_connections: type: integer example: 1 max_parallel_entities: type: integer example: 1 query_tag: type: string example: table_group_tag tables: type: array items: properties: table_id: type: string example: e77850ad5127a2d7dab870ff connection_quota: type: integer example: 100 responses: '200': description: Success content: application/json: schema: type: object properties: result: type: object properties: message: type: string example: Successfully updated table group result: properties: id: type: string example: c70822c5a88e5521a8153c7c '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: [] tags: - Table Groups responses: '200': description: Success content: application/json: schema: properties: message: type: string example: Table Group Successfully Created result: properties: id: type: string example: c70822c5a88e5521a8153c7c '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}/table-groups/{table_group_id}/configurations: 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_group_id in: path description: Table Group Id required: true schema: type: string post: security: - BearerAuth: [] tags: - Table Groups summary: This will Configure particular `Table Group` with `tableGroupId`. description: This will Configure particular `Table Group` with `tableGroupId`. requestBody: description: This is the JSON body of request containing configured Table group object. content: application/json: schema: type: object properties: tables: type: array items: type: object properties: table_id: type: string connection_quota: type: integer example: 15 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 /sources/{source_id}/table-groups/{table_group_id}/audit-logs: 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_group_id in: path description: Table Group Id required: true schema: type: string get: security: - BearerAuth: [] tags: - Table Groups summary: This will fetch array of audit logs for table group with `tableGroupId`. description: This will fetch array of audit logs for table group with `tableGroupId`. responses: '200': description: Success content: application/json: schema: allOf: - 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: {} - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: array items: allOf: - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - type: object properties: entity_type: type: string example: table_group - type: object properties: entity_id: type: string example: e77850ad5127a2d7dab870ff - properties: modification: type: string example: Changed connection type to tpt from jdbc - type: object properties: modified_at: type: string example: '2019-11-21T12:54:05.875Z' - type: object properties: modified_by: type: string example: 6RkfybTRQQByEey3v '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-to-table-groups-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 get: security: - BearerAuth: [] tags: - Table Groups summary: Gets `Table to Table Group` Mapping. description: Gets `Table to Table Group` Mapping list. 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 responses: '200': description: Success content: application/json: schema: allOf: - 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: {} - type: object properties: message: type: string example: Example Success Message - type: object properties: result: allOf: - type: object properties: tableId: type: array items: type: object properties: id: type: string example: 62963b9a3009222c5d12f48e name: type: string example: demo connection_mode: type: string example: JDBC connection_url: type: string example: jdbc:oracle:thin:@10.17.3.199:1521:xe username: type: string example: automation_db password: type: string example: '********' driver_name: type: string example: oracle.jdbc.driver.OracleDriver driver_version: type: string example: v2 database: type: string example: ORACLE enable_log_based_cdc: type: boolean example: false '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 components: securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT BasicAuth: type: http scheme: basic