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 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}/meta-crawled-table-count: 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_ids in: query description: Required for getting the metacrawled table list required: true schema: type: array items: type: string get: security: - BearerAuth: [] tags: - Tables summary: Get meta crawled table count description: Get meta crawled table count responses: '200': description: OK content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: properties: count: type: number example: 546 '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}/source_tables/excluded-tables: 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 List of excluded tables description: Get List of source table which are not yet ingested responses: '200': description: OK content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: array items: type: object properties: id: type: string example: 63c7c6703eed7852977aa219 tableName: type: string example: Table2 '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}/source_tables/schema-for-source: 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 Source schema description: Get all distinct schema for a given source table responses: '200': description: OK content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: array items: type: object properties: schemaName: type: string example: Table2 '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: parameters: - name: Content-Type in: header description: Http content type required: true schema: type: string enum: - application/json - multipart/form-data - text/plain default: application/json - name: source_id in: path description: Source Id. required: true schema: type: string - name: resource_id_to_clone in: query description: Required in case of cloning Mainframe sources schema: type: string get: security: - BearerAuth: [] tags: - Tables summary: list all the tables in the source description: list all the tables in the source operationId: getTablesList parameters: - name: limit in: query description: The numbers of items to return schema: type: integer default: 10 - name: offset in: query description: The number of items to skip before starting to collect the result set schema: type: integer default: 0 - 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: successful operation 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: type: object properties: id: type: string format: hexadecimal name: type: string original_table_name: type: string topic_mapping_name: type: string file_mapping_name: type: string data_lake_schema: type: string example: kafka data_lake_path: type: string example: /iw/kafka-source meta_crawl_performed: type: boolean columns: type: array items: type: object properties: sql_type: type: integer example: 4 name: type: string example: id original_name: type: string example: id target_sql_type: type: integer example: 4 json_schema_node_key: type: integer example: 4 is_mixed_element_text_content: type: boolean example: false is_recursive_data_text_content: type: boolean example: false is_excluded_column: 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 post: security: - BearerAuth: [] tags: - Tables summary: Add tables to a File Source description: Add tables to a File Source requestBody: content: multipart/form-data: schema: oneOf: - type: object required: - name - source - main_copybook properties: name: type: string example: MainframeSourceName source: type: string example: ddedbb84b4ed5aed5ce07da6 description: It refers to the source id to which tables needs to be added configuration: type: object required: - should_flatten_fields - comment_policy_up_to_char - comment_policy_after_char - record_type - file_encoding - charset - sync_type - target_table_name - include_subdirectories - file_header_bytes - file_footer_bytes - include_filename_regex - source_relative_path properties: should_flatten_fields: type: boolean example: true comment_policy_up_to_char: type: integer example: 6 comment_policy_after_char: type: integer example: 72 record_type: type: string example: VB records_per_block: type: integer example: 3 file_header_bytes: type: integer example: 0 file_footer_bytes: type: integer example: 0 target_table_name: type: string example: Upgrade_C30 sync_type: type: string example: full-load file_encoding: type: string example: ebcdic charset: type: string example: UTF-8 source_relative_path: type: string example: /opt/infoworks/temp_file_sources/ include_filename_regex: type: string example: .* exclude_filename_regex: type: string example: .*4.* include_subdirectories: type: boolean example: true record_header_type_encoding: type: string example: big_endian block_header_type_encoding: type: string example: big_endian filter_record_value: type: string example: C20 filter_record_column: type: string example: '' target_dataset_name: type: string example: MainFrameDataset record_header_name: type: array items: type: string example: 5f0754885406f51f04a85293 description: This is required in case the recordType field is Variable Length Custom Header(VCH) or Variable Block Custom Header(VBCH) main_copybook: type: object description: Upload the main copy file custom_copybook: type: object description: This is required in case the recordType field is Variable Length Custom Header(VCH) or Variable Block Custom Header(VBCH) comment_up_to_char_array: type: array items: type: integer example: 6 description: This is required in case the recordType field is Variable Length Custom Header(VCH) or Variable Block Custom Header(VBCH) comment_after_char_array: type: array items: type: integer example: 72 description: This is required in case the recordType field is Variable Length Custom Header(VCH) or Variable Block Custom Header(VBCH) update_object: type: object description: Required only in case of patch request properties: record_header_name: type: string example: cpb1 description: Record Header Name which needs to be updated file_name: type: string example: cbp.txt comment_policy_after_char: type: integer comment_policy_up_to_char: type: integer type: type: string example: update description: Operation which needs to be performed original_record_header_name: type: string description: Needed incase the record header name is updated examples: FixedLengthRecordType: value: name: FixedLengthMainframeSourceName source: ddedbb84b4ed5aed5ce07da6 main_copybook: description: Upload the main copybook configuration: should_flatten_fields: true comment_policy_up_to_char: 6 comment_policy_after_char: 72 record_type: F file_header_bytes: 0 file_footer_bytes: 0 sync_type: full-load file_encoding: ebcdic charset: cp037 source_relative_path: /F/ include_filename_regex: .* target_table_name: MainFrameFixed ingest_subdirectories: true filter_record_value: D filter_record_column: MNTH_LIS_REC_TYPE VariableLengthCustomHeaderRecordType: value: name: VariableCustomHeaderSourceName source: ddedbb84b4ed5aed5ce07da6 main_copybook: description: Upload the main copybook custom_copybook: description: Upload the custom copybooks record_header_name: - C10 - C20 - C30 comment_up_to_char_array: - 6 - 6 - 6 comment_after_char_array: - 72 - 72 - 72 configuration: should_flatten_fields: true comment_policy_up_to_char: 6 comment_policy_after_char: 72 record_type: VCH file_header_bytes: 0 file_footer_bytes: 0 sync_type: full-load file_encoding: ebcdic charset: cp037 source_relative_path: /VCH/ include_filename_regex: .* target_table_name: MainFrameVariable ingest_subdirectories: true filter_record_value: C30 filter_record_column: '' VariableLengthRecordType: value: name: VariableLengthMainframeSourceName source: ddedbb84b4ed5aed5ce07da6 main_copybook: description: Upload the main copybook configuration: should_flatten_fields: true comment_policy_up_to_char: 6 comment_policy_after_char: 72 record_type: V record_header_type_encoding: big_endian file_header_bytes: 0 file_footer_bytes: 0 sync_type: full-load file_encoding: ebcdic charset: cp037 source_relative_path: /V/ include_filename_regex: .* target_table_name: MainFrameVariable ingest_subdirectories: true filter_record_value: D::31 filter_record_column: RECORD_TYPE::RECORD_TYPE_SEQ responses: '200': description: successful operation content: application/json: schema: type: object properties: message: type: string example: Table added Successfully. result: type: object properties: id: type: string example: fdf5c3fb3afaf1c3d286ef95 '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}/fetch-tables: parameters: - name: Content-Type in: header description: Http content type required: true schema: type: string enum: - application/json - multipart/form-data - text/plain default: application/json - name: source_id in: path description: Source Id. required: true schema: type: string - name: resource_id_to_clone in: query description: Required in case of cloning Mainframe sources schema: type: string post: security: - BearerAuth: [] tags: - Tables summary: list all the tables in the source description: list all the tables in the source operationId: fetchTablesList parameters: - name: limit in: query description: The numbers of items to return schema: type: integer default: 10 - name: offset in: query description: The number of items to skip before starting to collect the result set schema: type: integer default: 0 - 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: resolve_ref in: query description: To get entity details and created by user name schema: type: boolean - name: filter in: query description: Filter results query schema: type: string responses: '200': description: successful operation 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: type: object properties: id: type: string format: hexadecimal name: type: string original_table_name: type: string topic_mapping_name: type: string file_mapping_name: type: string data_lake_schema: type: string example: kafka data_lake_path: type: string example: /iw/kafka-source meta_crawl_performed: type: boolean columns: type: array items: type: object properties: sql_type: type: integer example: 4 name: type: string example: id original_name: type: string example: id target_sql_type: type: integer example: 4 json_schema_node_key: type: integer example: 4 is_mixed_element_text_content: type: boolean example: false is_recursive_data_text_content: type: boolean example: false is_excluded_column: 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}: 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 get: security: - BearerAuth: [] tags: - Tables summary: Get Table Info description: Get Table Info responses: '200': description: '' content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: object allOf: - type: object properties: source: type: string example: e77850ad5127a2d7dab870ff last_ingested_cdc_value: type: string example: null full_load_performed: type: boolean example: false description: type: string example: example description tags: type: array items: example: c54t456f6d5a2c4564aed schema_name_at_source: type: string example: dummy topic_mapping_id: type: string example: e77850ad5127a2d7dab870ff configuration: type: object allOf: - properties: 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 json_schema_breadcrumb: type: array items: properties: selected: type: boolean example: true name: type: string json_schema_node_key: type: integer example: 0 crawl_data_filter_enabled: type: boolean example: false crawl_filter_conditions: type: array items: example: '' max_num_of_records: type: integer example: 20000 streaming_mode: type: string example: micro_batch streaming_frequency_type: type: string example: secs streaming_frequency_number: type: integer example: 10 error_threshold: type: integer example: 5 source_file_type: type: string example: kafka natural_keys: type: array items: type: string partition_keys: type: array items: type: string target_relative_path: type: string example: abch update_strategy: type: string example: append write_supported_engines: type: array items: type: string example: SPARK read_supported_engines: type: array items: type: string example: SPARK target_table_name: type: string storage_format: type: string target_schema_name: type: string sync_type: type: string example: incremental - type: object properties: id: type: string format: hexadecimal name: type: string original_table_name: type: string topic_mapping_name: type: string file_mapping_name: type: string data_lake_schema: type: string example: kafka data_lake_path: type: string example: /iw/kafka-source meta_crawl_performed: type: boolean columns: type: array items: type: object properties: sql_type: type: integer example: 4 name: type: string example: id original_name: type: string example: id target_sql_type: type: integer example: 4 json_schema_node_key: type: integer example: 4 is_mixed_element_text_content: type: boolean example: false is_recursive_data_text_content: type: boolean example: false is_excluded_column: 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 patch: security: - BearerAuth: [] tags: - Tables summary: 'Update the Table ' description: Update the table Metadata requestBody: description: Update the table Metadata content: multipart/form-data: schema: oneOf: - type: object required: - name - source - main_copybook properties: name: type: string example: MainframeSourceName source: type: string example: ddedbb84b4ed5aed5ce07da6 description: It refers to the source id to which tables needs to be added configuration: type: object required: - should_flatten_fields - comment_policy_up_to_char - comment_policy_after_char - record_type - file_encoding - charset - sync_type - target_table_name - include_subdirectories - file_header_bytes - file_footer_bytes - include_filename_regex - source_relative_path properties: should_flatten_fields: type: boolean example: true comment_policy_up_to_char: type: integer example: 6 comment_policy_after_char: type: integer example: 72 record_type: type: string example: VB records_per_block: type: integer example: 3 file_header_bytes: type: integer example: 0 file_footer_bytes: type: integer example: 0 target_table_name: type: string example: Upgrade_C30 sync_type: type: string example: full-load file_encoding: type: string example: ebcdic charset: type: string example: UTF-8 source_relative_path: type: string example: /opt/infoworks/temp_file_sources/ include_filename_regex: type: string example: .* exclude_filename_regex: type: string example: .*4.* include_subdirectories: type: boolean example: true record_header_type_encoding: type: string example: big_endian block_header_type_encoding: type: string example: big_endian filter_record_value: type: string example: C20 filter_record_column: type: string example: '' target_dataset_name: type: string example: MainFrameDataset record_header_name: type: array items: type: string example: 5f0754885406f51f04a85293 description: This is required in case the recordType field is Variable Length Custom Header(VCH) or Variable Block Custom Header(VBCH) main_copybook: type: object description: Upload the main copy file custom_copybook: type: object description: This is required in case the recordType field is Variable Length Custom Header(VCH) or Variable Block Custom Header(VBCH) comment_up_to_char_array: type: array items: type: integer example: 6 description: This is required in case the recordType field is Variable Length Custom Header(VCH) or Variable Block Custom Header(VBCH) comment_after_char_array: type: array items: type: integer example: 72 description: This is required in case the recordType field is Variable Length Custom Header(VCH) or Variable Block Custom Header(VBCH) update_object: type: object description: Required only in case of patch request properties: record_header_name: type: string example: cpb1 description: Record Header Name which needs to be updated file_name: type: string example: cbp.txt comment_policy_after_char: type: integer comment_policy_up_to_char: type: integer type: type: string example: update description: Operation which needs to be performed original_record_header_name: type: string description: Needed incase the record header name is updated 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 delete: security: - BearerAuth: [] operationId: deleteTable tags: - Tables summary: Delete Table for a source description: Delete Table for a source responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message '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}/crawl-schema: parameters: - 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: source_sub_type in: query description: Specifying source sub type required: true schema: type: string example: mainframe get: security: - BearerAuth: [] tags: - Tables summary: Crawl Table Schema description: Crawl Table Schema responses: '200': description: '' content: application/json: schema: type: object properties: message: type: string example: Example Success Message '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/source_tables: parameters: - name: Content-Type in: header description: Http content type required: true schema: type: string enum: - application/json - multipart/form-data - text/plain default: application/json - name: source_id in: path description: Source Id. required: true schema: type: string post: security: - BearerAuth: [] tags: - Tables summary: 'add the tables to a source and crawl metadata of those added tables ' description: add the tables to a source and crawl metadata of those added tables operationId: getSourceTablesList requestBody: content: application/json: schema: oneOf: - allOf: - type: object properties: tables_to_add: type: array items: type: object properties: table_name: type: string format: string example: full_ingestion_tpt schema_name: type: string format: string example: AUTODB_PARQUET table_type: type: string format: string example: TABLE target_table_name: type: string format: string example: full_ingestion_tpt target_schema_name: type: string format: string example: AUTODB_PARQUET - allOf: - type: object properties: tables_to_add: type: array items: type: object properties: table_name: type: string format: string example: full_ingestion_tpt schema_name: type: string format: string example: AUTODB_PARQUET catalog_name: type: string format: string example: AUTODB_CATALOG table_type: type: string format: string example: TABLE target_table_name: type: string format: string example: full_ingestion_tpt target_schema_name: type: string format: string example: AUTODB_PARQUET - allOf: - type: object properties: tables_to_add: type: array items: type: object properties: table_name: type: string format: string example: full_ingestion_tpt schema_name: type: string format: string example: AUTODB_PARQUET catalog_name: type: string format: string example: AUTODB_CATALOG table_type: type: string format: string example: TABLE target_table_name: type: string format: string example: full_ingestion_tpt target_schema_name: type: string format: string example: AUTODB_PARQUET - allOf: - type: object properties: tables_to_add: type: array items: type: object properties: table_name: type: string format: string example: full_ingestion_tpt schema_name: type: string format: string example: AUTODB_PARQUET table_type: type: string format: string example: TABLE target_table_name: type: string format: string example: full_ingestion_tpt target_schema_name: type: string format: string example: AUTODB_PARQUET - allOf: - type: object properties: tables_to_add: type: array items: type: object properties: table_name: type: string format: string example: full_ingestion_tpt schema_name: type: string format: string example: AUTODB_PARQUET catalog_name: type: string format: string example: AUTODB_CATALOG table_type: type: string format: string example: TABLE target_table_name: type: string format: string example: full_ingestion_tpt target_schema_name: type: string format: string example: AUTODB_PARQUET - allOf: - type: object properties: tables_to_add: type: array items: type: object properties: table_name: type: string format: string example: full_ingestion_tpt catalog_name: type: string format: string example: AUTODB_CATALOG table_type: type: string format: string example: TABLE target_table_name: type: string format: string example: full_ingestion_tpt target_schema_name: type: string format: string example: AUTODB_PARQUET - allOf: - type: object properties: tables_to_add: type: array items: type: object properties: table_name: type: string format: string example: full_ingestion_tpt schema_name: type: string format: string example: AUTODB_PARQUET table_type: type: string format: string example: TABLE target_table_name: type: string format: string example: full_ingestion_tpt target_schema_name: type: string format: string example: AUTODB_PARQUET - allOf: - type: object properties: tables_to_add: type: array items: type: object properties: table_name: type: string format: string example: full_ingestion_tpt schema_name: type: string format: string example: AUTODB_PARQUET table_type: type: string format: string example: TABLE target_table_name: type: string format: string example: full_ingestion_tpt target_schema_name: type: string format: string example: AUTODB_PARQUET - allOf: - type: object properties: tables_to_add: type: array items: type: object properties: table_name: type: string format: string example: full_ingestion_tpt catalog_name: type: string format: string example: AUTODB_CATALOG schema_name: type: string format: string example: AUTODB_SCHEMA table_type: type: string format: string example: TABLE required: true responses: '200': description: successful operation content: application/json: schema: type: object properties: message: type: string example: Tables added and job created successfully result: type: object properties: added_tables: type: array items: type: string example: 60b52e3127aa3e338e5a2f97 job_created: type: string example: 60b52e3927aa3e338e5a2f98 '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}/configurations/ingestion: 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: Updates and configures the table for Ingestion description: Sets ingestion configuration for a table. requestBody: description: Table ingestion Configuration content: application/json: schema: oneOf: - title: TeradataOnSnowflakeConfigurationSchema allOf: - allOf: - type: object required: - sync_type - target_table_name - target_schema_name properties: sync_type: type: string enum: - full-load - cdc-ogg - cdc-timestamp-column - cdc-query - cdc-batch-id - cdc-log read_supported_engines: type: array items: type: string enum: - delta - avro - parquet - orc type: type: string subType: type: string sourceSubType: type: string target_table_name: type: string target_schema_name: type: string cdc_type: type: string query: type: string schema_name: type: string table_name: type: string exclude_legacy_audit_columns: type: string is_table_case_sensitive: type: string is_schema_case_sensitive: type: string is_database_case_sensitive: type: string watermark_column: type: string capture_table_name: type: string update_strategy: type: string fetch_mechanism: type: string use_jdbc: type: boolean use_capture_table: type: boolean is_scd2_table: type: boolean ingest_subdirectories: type: boolean is_archive_enabled: type: boolean generate_history_view: type: boolean enable_lower_bound_watermark_offset: type: boolean does_table_contain_data: type: boolean lower_bound_watermark_offset: type: object properties: sql_type: type: number days: type: number minutes: type: number hours: type: number offset_operation: type: string partition_keys: type: array items: type: object properties: partitionKeyColumn: type: string partition_column: type: boolean is_derived_partition: type: boolean parent_column: type: string derive_format: type: string - type: object - required: - is_table_user_managed - target_database_name properties: is_table_user_managed: type: boolean target_database_name: type: string - type: object - required: - data_fetch_type properties: data_fetch_type: type: string crawl_data_filter_enabled: type: boolean crawl_filter_conditions: type: array items: type: object split_by_key: type: object properties: parent_column: type: string is_derived_split: type: string derive_function: type: string derive_format: type: string split_column: type: string segmented_load_columns: type: array items: type: object properties: derive_format: type: string derive_function: type: string extract_from_column: type: boolean column: type: object properties: sql_type: type: number name: type: string original_name: type: string is_deleted: type: boolean target_sql_type: type: number is_audit_column: type: boolean is_custom_audit_column: type: boolean is_excluded_column: type: boolean target_scale: type: string col_size: type: number precision: type: number target_precision: type: number scale: type: number format: type: string is_derived_partition: type: boolean is_db_specific_column: type: boolean value: type: string - title: TeradataOnAzureConfigurationSchema allOf: - type: object required: - sync_type - target_table_name - target_schema_name properties: sync_type: type: string enum: - full-load - cdc-ogg - cdc-timestamp-column - cdc-query - cdc-batch-id - cdc-log read_supported_engines: type: array items: type: string enum: - delta - avro - parquet - orc type: type: string subType: type: string sourceSubType: type: string target_table_name: type: string target_schema_name: type: string cdc_type: type: string query: type: string schema_name: type: string table_name: type: string exclude_legacy_audit_columns: type: string is_table_case_sensitive: type: string is_schema_case_sensitive: type: string is_database_case_sensitive: type: string watermark_column: type: string capture_table_name: type: string update_strategy: type: string fetch_mechanism: type: string use_jdbc: type: boolean use_capture_table: type: boolean is_scd2_table: type: boolean ingest_subdirectories: type: boolean is_archive_enabled: type: boolean generate_history_view: type: boolean enable_lower_bound_watermark_offset: type: boolean does_table_contain_data: type: boolean lower_bound_watermark_offset: type: object properties: sql_type: type: number days: type: number minutes: type: number hours: type: number offset_operation: type: string partition_keys: type: array items: type: object properties: partitionKeyColumn: type: string partition_column: type: boolean is_derived_partition: type: boolean parent_column: type: string derive_format: type: string - type: object required: - data_fetch_type - write_supported_engines properties: write_supported_engines: type: array items: type: string enum: - delta - avro - parquet - orc crawl_data_filter_enabled: type: boolean crawl_filter_conditions: type: array items: type: object data_fetch_type: type: string split_by_key: type: object properties: parent_column: type: string is_derived_split: type: string derive_function: type: string derive_format: type: string segmented_load_columns: type: array items: type: object properties: derive_format: type: string derive_function: type: string extract_from_column: type: boolean column: type: object properties: sql_type: type: number name: type: string original_name: type: string is_deleted: type: boolean target_sql_type: type: number is_audit_column: type: boolean is_custom_audit_column: type: boolean is_excluded_column: type: boolean target_scale: type: string col_size: type: number precision: type: number target_precision: type: number scale: type: number format: type: string is_derived_partition: type: boolean is_db_specific_column: type: boolean java_type: type: string value: type: string storage_format: type: string enum: - parquet - avro - orc - title: TeradataOnAzureConfigurationSchemaForDelimited allOf: - title: TeradataOnAzureConfigurationSchema allOf: - type: object required: - sync_type - target_table_name - target_schema_name properties: sync_type: type: string enum: - full-load - cdc-ogg - cdc-timestamp-column - cdc-query - cdc-batch-id - cdc-log read_supported_engines: type: array items: type: string enum: - delta - avro - parquet - orc type: type: string subType: type: string sourceSubType: type: string target_table_name: type: string target_schema_name: type: string cdc_type: type: string query: type: string schema_name: type: string table_name: type: string exclude_legacy_audit_columns: type: string is_table_case_sensitive: type: string is_schema_case_sensitive: type: string is_database_case_sensitive: type: string watermark_column: type: string capture_table_name: type: string update_strategy: type: string fetch_mechanism: type: string use_jdbc: type: boolean use_capture_table: type: boolean is_scd2_table: type: boolean ingest_subdirectories: type: boolean is_archive_enabled: type: boolean generate_history_view: type: boolean enable_lower_bound_watermark_offset: type: boolean does_table_contain_data: type: boolean lower_bound_watermark_offset: type: object properties: sql_type: type: number days: type: number minutes: type: number hours: type: number offset_operation: type: string partition_keys: type: array items: type: object properties: partitionKeyColumn: type: string partition_column: type: boolean is_derived_partition: type: boolean parent_column: type: string derive_format: type: string - type: object required: - data_fetch_type - write_supported_engines properties: write_supported_engines: type: array items: type: string enum: - delta - avro - parquet - orc crawl_data_filter_enabled: type: boolean crawl_filter_conditions: type: array items: type: object data_fetch_type: type: string split_by_key: type: object properties: parent_column: type: string is_derived_split: type: string derive_function: type: string derive_format: type: string segmented_load_columns: type: array items: type: object properties: derive_format: type: string derive_function: type: string extract_from_column: type: boolean column: type: object properties: sql_type: type: number name: type: string original_name: type: string is_deleted: type: boolean target_sql_type: type: number is_audit_column: type: boolean is_custom_audit_column: type: boolean is_excluded_column: type: boolean target_scale: type: string col_size: type: number precision: type: number target_precision: type: number scale: type: number format: type: string is_derived_partition: type: boolean is_db_specific_column: type: boolean java_type: type: string value: type: string storage_format: type: string enum: - parquet - avro - orc - type: object properties: storage_format: type: string enum: - delimited_text_files quote_character: type: string record_separator: type: string escape_character: type: string delimiter_character: type: string compression: type: string add_header_row: type: boolean character_encoding: type: string - title: DfiOnAzureConfigurationSchema allOf: - type: object required: - sync_type - target_table_name - target_schema_name properties: sync_type: type: string enum: - full-load - cdc-ogg - cdc-timestamp-column - cdc-query - cdc-batch-id - cdc-log read_supported_engines: type: array items: type: string enum: - delta - avro - parquet - orc type: type: string subType: type: string sourceSubType: type: string target_table_name: type: string target_schema_name: type: string cdc_type: type: string query: type: string schema_name: type: string table_name: type: string exclude_legacy_audit_columns: type: string is_table_case_sensitive: type: string is_schema_case_sensitive: type: string is_database_case_sensitive: type: string watermark_column: type: string capture_table_name: type: string update_strategy: type: string fetch_mechanism: type: string use_jdbc: type: boolean use_capture_table: type: boolean is_scd2_table: type: boolean ingest_subdirectories: type: boolean is_archive_enabled: type: boolean generate_history_view: type: boolean enable_lower_bound_watermark_offset: type: boolean does_table_contain_data: type: boolean lower_bound_watermark_offset: type: object properties: sql_type: type: number days: type: number minutes: type: number hours: type: number offset_operation: type: string partition_keys: type: array items: type: object properties: partitionKeyColumn: type: string partition_column: type: boolean is_derived_partition: type: boolean parent_column: type: string derive_format: type: string - type: object required: - write_supported_engines properties: write_supported_engines: type: array items: type: string enum: - delta - avro - parquet - orc crawl_data_filter_enabled: type: boolean example: false crawl_filter_conditions: type: array items: type: object source_file_properties: type: object properties: header_rows_count: type: number 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_configurations: type: array items: type: object properties: column_width: type: number - title: DfiOnSnowflakeConfigurationSchema allOf: - allOf: - type: object required: - sync_type - target_table_name - target_schema_name properties: sync_type: type: string enum: - full-load - cdc-ogg - cdc-timestamp-column - cdc-query - cdc-batch-id - cdc-log read_supported_engines: type: array items: type: string enum: - delta - avro - parquet - orc type: type: string subType: type: string sourceSubType: type: string target_table_name: type: string target_schema_name: type: string cdc_type: type: string query: type: string schema_name: type: string table_name: type: string exclude_legacy_audit_columns: type: string is_table_case_sensitive: type: string is_schema_case_sensitive: type: string is_database_case_sensitive: type: string watermark_column: type: string capture_table_name: type: string update_strategy: type: string fetch_mechanism: type: string use_jdbc: type: boolean use_capture_table: type: boolean is_scd2_table: type: boolean ingest_subdirectories: type: boolean is_archive_enabled: type: boolean generate_history_view: type: boolean enable_lower_bound_watermark_offset: type: boolean does_table_contain_data: type: boolean lower_bound_watermark_offset: type: object properties: sql_type: type: number days: type: number minutes: type: number hours: type: number offset_operation: type: string partition_keys: type: array items: type: object properties: partitionKeyColumn: type: string partition_column: type: boolean is_derived_partition: type: boolean parent_column: type: string derive_format: type: string - type: object - required: - is_table_user_managed - target_database_name properties: is_table_user_managed: type: boolean target_database_name: type: string - type: object properties: crawl_data_filter_enabled: type: boolean example: false crawl_filter_conditions: type: array items: type: object source_file_properties: type: object properties: header_rows_count: type: number 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_configurations: type: array items: type: object properties: column_width: type: number required: true responses: '200': description: OK content: application/json: schema: type: object properties: result: type: object properties: message: type: string example: Successfully updated ingestion configuration '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 ingestion configuration of table description: Get ingestion configuration of table responses: '200': description: get the ingestion configuration of table content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: object allOf: - type: object allOf: - properties: 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 json_schema_breadcrumb: type: array items: properties: selected: type: boolean example: true name: type: string json_schema_node_key: type: integer example: 0 crawl_data_filter_enabled: type: boolean example: false crawl_filter_conditions: type: array items: example: '' max_num_of_records: type: integer example: 20000 streaming_mode: type: string example: micro_batch streaming_frequency_type: type: string example: secs streaming_frequency_number: type: integer example: 10 error_threshold: type: integer example: 5 source_file_type: type: string example: kafka natural_keys: type: array items: type: string partition_keys: type: array items: type: string target_relative_path: type: string example: abch update_strategy: type: string example: append write_supported_engines: type: array items: type: string example: SPARK read_supported_engines: type: array items: type: string example: SPARK target_table_name: type: string storage_format: type: string target_schema_name: type: string sync_type: type: string example: incremental '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}/configurations/advance: 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 get: security: - BearerAuth: [] tags: - Tables summary: Get list of Entity advance configuration description: Get list of Entity advance configuration responses: '200': description: Limitby list of all the entity advance configuration sorted on the format user provided 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: results: type: array items: allOf: - type: object required: - key - value properties: key: type: string example: keyName value: type: string example: keyValue description: type: string example: description about this configuration is_active: type: boolean example: false entity_id: type: string example: e77850ad5127a2d7dab870ff entity_type: type: string example: source - properties: parent_entity_id: type: string example: e77850ad5127a2d7dab870ff parent_entity_type: type: string example: table '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: [] tags: - Tables summary: Add advance configuration for a table description: Add advance configuration for a table requestBody: content: application/json: schema: type: object required: - key - value properties: key: type: string example: keyName value: type: string example: keyValue description: type: string example: description about this configuration is_active: type: boolean example: false entity_id: type: string example: e77850ad5127a2d7dab870ff entity_type: type: string example: source required: true responses: '200': description: OK content: application/json: schema: type: object properties: result: type: object properties: message: type: string example: Successfully added advance configuration '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}/configurations/advance/{key}: 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: key in: path description: A unique advanced configuration key required: true schema: type: string get: security: - BearerAuth: [] tags: - Tables summary: Get table advance configuration description: Get table advance configuration responses: '200': description: Ok content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: allOf: - properties: key: type: string example: keyName value: type: string example: keyValue description: type: string example: description about this configuration isActive: type: boolean example: true entityId: type: string example: e77850ad5127a2d7dab870ff entityType: type: string example: table '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: update advance configuration for a table description: update advance configuration for a table requestBody: description: Table ingestion Configuration content: application/json: schema: type: array required: - key - value - entityId - entityType items: type: object properties: key: type: string value: type: string entityId: type: string entityType: type: string enum: - table - pipeline examples: Advance Config: value: value: a description: aa isActive: true entityId: 5a6ea49ce4b00234296e37d5 entityType: table key: a required: true responses: '200': description: OK content: application/json: schema: type: object properties: result: type: object properties: message: type: string example: Successfully updated advance configuration '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: - Tables summary: Delete advance configuration for a table description: Delete advance configuration for a table responses: '200': description: OK content: application/json: schema: type: object properties: result: type: object properties: message: type: string example: Successfully deleted advance configuration '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}/configurations/export: 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 table export configuration description: update table export configuration requestBody: description: Table export Configuration content: application/json: schema: oneOf: - allOf: - type: object required: - sync_type - target_type - connection - target_configuration - columns properties: sync_type: type: string example: OVERWRITE enum: - DISABLED - OVERWRITE - APPEND - MERGE target_type: type: string example: TERADATA enum: - BIG_QUERY - AZURE_SQL_DW - SNOWFLAKE - COSMOS_DB - DELIMITED - POSTGRES - TERADATA - ORACLE - SQLSERVER columns: type: array items: type: object properties: name: type: string example: FNAME precision: type: number example: 20 scale: type: number example: 0 sql_type: type: number example: 12 target_configuration: type: object properties: schema_name: type: string example: schema_one table_name: type: string example: table_one natural_key: type: array items: type: string sync_table_schema: type: boolean example: true is_existing_schema: type: boolean example: false distribution_details: type: object properties: distribution_details: type: string example: round_robin indexing_details: type: object properties: indexing_type: type: string example: heap index_column_names: type: array items: type: string partition_details: type: object properties: partition_column_name: type: string example: FNAME partition_values: type: string example: '0' range: type: string example: left connection: oneOf: - allOf: - type: object required: - auth_type - connection_string - database - driver_name - password - table - username - schema properties: auth_type: type: string example: SQL_SERVER_DEFAULT connection_string: type: string example: connectionString database: type: string example: database driver_name: type: string example: driverName password: oneOf: - type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - infoworks_managed password: type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - secret_store secret_id: type: string example: e77850ad5127a2d7dab870ff table: type: string example: tableName username: type: string example: username schema: type: string example: schema query_tag: type: string example: test_querytag - allOf: - type: object required: - auth_type - connection_string - database - driver_name - password - table - username - schema properties: auth_type: type: string example: SQL_SERVER_DEFAULT connection_string: type: string example: connectionString database: type: string example: database driver_name: type: string example: driverName password: oneOf: - type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - infoworks_managed password: type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - secret_store secret_id: type: string example: e77850ad5127a2d7dab870ff table: type: string example: tableName username: type: string example: username schema: type: string example: schema query_tag: type: string example: test_querytag - type: object properties: staging_schema: type: string discriminator: propertyName: export_type mapping: full_load: '#/components/schemas/connectionFullExport' cdc: '#/components/schemas/connectionCDCExport' - allOf: - type: object required: - sync_type - target_type - connection - target_configuration - columns properties: sync_type: type: string example: OVERWRITE enum: - DISABLED - OVERWRITE - APPEND - MERGE target_type: type: string example: TERADATA enum: - BIG_QUERY - AZURE_SQL_DW - SNOWFLAKE - COSMOS_DB - DELIMITED - POSTGRES - TERADATA - ORACLE - SQLSERVER columns: type: array items: type: object properties: name: type: string example: FNAME precision: type: number example: 20 scale: type: number example: 0 sql_type: type: number example: 12 target_configuration: type: object properties: schema_name: type: string example: schema_one table_name: type: string example: table_one natural_key: type: array items: type: string sync_table_schema: type: boolean example: true is_existing_schema: type: boolean example: false distribution_details: type: object properties: distribution_details: type: string example: round_robin indexing_details: type: object properties: indexing_type: type: string example: heap index_column_names: type: array items: type: string partition_details: type: object properties: partition_column_name: type: string example: FNAME partition_values: type: string example: '0' range: type: string example: left connection: oneOf: - allOf: - type: object required: - auth_type - connection_string - database - driver_name - password - table - username - schema properties: auth_type: type: string example: SQL_SERVER_DEFAULT connection_string: type: string example: connectionString database: type: string example: database driver_name: type: string example: driverName password: oneOf: - type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - infoworks_managed password: type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - secret_store secret_id: type: string example: e77850ad5127a2d7dab870ff table: type: string example: tableName username: type: string example: username schema: type: string example: schema query_tag: type: string example: test_querytag - allOf: - type: object required: - auth_type - connection_string - database - driver_name - password - table - username - schema properties: auth_type: type: string example: SQL_SERVER_DEFAULT connection_string: type: string example: connectionString database: type: string example: database driver_name: type: string example: driverName password: oneOf: - type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - infoworks_managed password: type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - secret_store secret_id: type: string example: e77850ad5127a2d7dab870ff table: type: string example: tableName username: type: string example: username schema: type: string example: schema query_tag: type: string example: test_querytag - type: object properties: staging_schema: type: string discriminator: propertyName: export_type mapping: full_load: '#/components/schemas/connectionFullExport' cdc: '#/components/schemas/connectionCDCExport' examples: Export: value: columns: - name: BATCH_ID_DOUBLE original_name: BATCH_ID_DOUBLE precision: 20 scale: 0 sql_type: 12 - original_name: CITY name: CITY precision: 20 scale: 0 sql_type: 12 connection: auth_type: SQL_SERVER_DEFAULT connection_string: sefsf database: SQL Server driver_name: com.microsoft.sqlserver.jdbc.SQLServerDriver password: password_type: infoworks_managed password: pass@123 schema: sdfs table: sdfsd username: sdfsd warehouse: w1 additional_params: a1 server_name: s1 sync_type: OVERWRITE target_type: TERADATA target_configuration: database_name: d2 table_name: t1 natural_key: [] is_existing_table: false target_table_type: MULTISET partition_type: NONE indexing_column: [] is_unique_index: false sync_table_schema: true responses: '200': description: OK content: application/json: schema: type: object properties: result: type: object properties: message: type: string example: Successfully updated export configuration '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 table export configuration description: get table export configuration responses: '200': description: get table export configuration content: application/json: schema: oneOf: - allOf: - type: object required: - sync_type - target_type - connection - target_configuration - columns properties: sync_type: type: string example: OVERWRITE enum: - DISABLED - OVERWRITE - APPEND - MERGE target_type: type: string example: TERADATA enum: - BIG_QUERY - AZURE_SQL_DW - SNOWFLAKE - COSMOS_DB - DELIMITED - POSTGRES - TERADATA - ORACLE - SQLSERVER columns: type: array items: type: object properties: name: type: string example: FNAME precision: type: number example: 20 scale: type: number example: 0 sql_type: type: number example: 12 target_configuration: type: object properties: schema_name: type: string example: schema_one table_name: type: string example: table_one natural_key: type: array items: type: string sync_table_schema: type: boolean example: true is_existing_schema: type: boolean example: false distribution_details: type: object properties: distribution_details: type: string example: round_robin indexing_details: type: object properties: indexing_type: type: string example: heap index_column_names: type: array items: type: string partition_details: type: object properties: partition_column_name: type: string example: FNAME partition_values: type: string example: '0' range: type: string example: left connection: oneOf: - allOf: - type: object required: - auth_type - connection_string - database - driver_name - password - table - username - schema properties: auth_type: type: string example: SQL_SERVER_DEFAULT connection_string: type: string example: connectionString database: type: string example: database driver_name: type: string example: driverName password: oneOf: - type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - infoworks_managed password: type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - secret_store secret_id: type: string example: e77850ad5127a2d7dab870ff table: type: string example: tableName username: type: string example: username schema: type: string example: schema query_tag: type: string example: test_querytag - allOf: - type: object required: - auth_type - connection_string - database - driver_name - password - table - username - schema properties: auth_type: type: string example: SQL_SERVER_DEFAULT connection_string: type: string example: connectionString database: type: string example: database driver_name: type: string example: driverName password: oneOf: - type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - infoworks_managed password: type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - secret_store secret_id: type: string example: e77850ad5127a2d7dab870ff table: type: string example: tableName username: type: string example: username schema: type: string example: schema query_tag: type: string example: test_querytag - type: object properties: staging_schema: type: string discriminator: propertyName: export_type mapping: full_load: '#/components/schemas/connectionFullExport' cdc: '#/components/schemas/connectionCDCExport' - allOf: - type: object required: - sync_type - target_type - connection - target_configuration - columns properties: sync_type: type: string example: OVERWRITE enum: - DISABLED - OVERWRITE - APPEND - MERGE target_type: type: string example: TERADATA enum: - BIG_QUERY - AZURE_SQL_DW - SNOWFLAKE - COSMOS_DB - DELIMITED - POSTGRES - TERADATA - ORACLE - SQLSERVER columns: type: array items: type: object properties: name: type: string example: FNAME precision: type: number example: 20 scale: type: number example: 0 sql_type: type: number example: 12 target_configuration: type: object properties: schema_name: type: string example: schema_one table_name: type: string example: table_one natural_key: type: array items: type: string sync_table_schema: type: boolean example: true is_existing_schema: type: boolean example: false distribution_details: type: object properties: distribution_details: type: string example: round_robin indexing_details: type: object properties: indexing_type: type: string example: heap index_column_names: type: array items: type: string partition_details: type: object properties: partition_column_name: type: string example: FNAME partition_values: type: string example: '0' range: type: string example: left connection: oneOf: - allOf: - type: object required: - auth_type - connection_string - database - driver_name - password - table - username - schema properties: auth_type: type: string example: SQL_SERVER_DEFAULT connection_string: type: string example: connectionString database: type: string example: database driver_name: type: string example: driverName password: oneOf: - type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - infoworks_managed password: type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - secret_store secret_id: type: string example: e77850ad5127a2d7dab870ff table: type: string example: tableName username: type: string example: username schema: type: string example: schema query_tag: type: string example: test_querytag - allOf: - type: object required: - auth_type - connection_string - database - driver_name - password - table - username - schema properties: auth_type: type: string example: SQL_SERVER_DEFAULT connection_string: type: string example: connectionString database: type: string example: database driver_name: type: string example: driverName password: oneOf: - type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - infoworks_managed password: type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - secret_store secret_id: type: string example: e77850ad5127a2d7dab870ff table: type: string example: tableName username: type: string example: username schema: type: string example: schema query_tag: type: string example: test_querytag - type: object properties: staging_schema: type: string discriminator: propertyName: export_type mapping: full_load: '#/components/schemas/connectionFullExport' cdc: '#/components/schemas/connectionCDCExport' '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}/column-order: 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 patch: security: - BearerAuth: [] tags: - Tables summary: update table column order description: update table column order requestBody: description: Table Column Order content: application/json: schema: type: object properties: name: type: string example: fname target_column_position: type: number example: 4 examples: EntityMetadata: value: name: fname target_column_position: 5 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 /sources/{source_id}/tables/{table_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 table metadata description: update table metadata requestBody: description: Table 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 table metadata description: get table metadata responses: '200': description: get table 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}/tables/{table_id}/configurations/export/connection: 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 get: security: - BearerAuth: [] tags: - Tables summary: Get table export configuration connection properties description: Get table export configuration connection properties responses: '200': description: OK content: application/json: schema: type: object properties: result: type: object properties: schema: oneOf: - allOf: - type: object required: - auth_type - connection_string - database - driver_name - password - table - username - schema properties: auth_type: type: string example: SQL_SERVER_DEFAULT connection_string: type: string example: connectionString database: type: string example: database driver_name: type: string example: driverName password: oneOf: - type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - infoworks_managed password: type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - secret_store secret_id: type: string example: e77850ad5127a2d7dab870ff table: type: string example: tableName username: type: string example: username schema: type: string example: schema query_tag: type: string example: test_querytag - allOf: - type: object required: - auth_type - connection_string - database - driver_name - password - table - username - schema properties: auth_type: type: string example: SQL_SERVER_DEFAULT connection_string: type: string example: connectionString database: type: string example: database driver_name: type: string example: driverName password: oneOf: - type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - infoworks_managed password: type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - secret_store secret_id: type: string example: e77850ad5127a2d7dab870ff table: type: string example: tableName username: type: string example: username schema: type: string example: schema query_tag: type: string example: test_querytag - type: object properties: staging_schema: type: string discriminator: propertyName: export_type mapping: full_load: '#/components/schemas/ConnectionFullExport' cdc: '#/components/schemas/ConnectionCDCExport' examples: connection: value: auth_type: SQL_SERVER_DEFAULT connection_string: sefsf database: SQL Server driver_name: com.microsoft.sqlserver.jdbc.SQLServerDriver password: 0LUKoIi5BneprevHKr1+7ruXmq1NMSyr6yzlcXczTJA= schema: sdfs table: sdfsd username: sdfsd staging_schema: sfdsf '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: update table export configuration Connection properties description: update table export configuration Connection properties requestBody: description: Table export Configuration connection properties content: application/json: schema: oneOf: - allOf: - type: object required: - auth_type - connection_string - database - driver_name - password - table - username - schema properties: auth_type: type: string example: SQL_SERVER_DEFAULT connection_string: type: string example: connectionString database: type: string example: database driver_name: type: string example: driverName password: oneOf: - type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - infoworks_managed password: type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - secret_store secret_id: type: string example: e77850ad5127a2d7dab870ff table: type: string example: tableName username: type: string example: username schema: type: string example: schema query_tag: type: string example: test_querytag - allOf: - type: object required: - auth_type - connection_string - database - driver_name - password - table - username - schema properties: auth_type: type: string example: SQL_SERVER_DEFAULT connection_string: type: string example: connectionString database: type: string example: database driver_name: type: string example: driverName password: oneOf: - type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - infoworks_managed password: type: string minLength: 1 example: - passw@rd_plain - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o= - type: object properties: password_type: type: string enum: - secret_store secret_id: type: string example: e77850ad5127a2d7dab870ff table: type: string example: tableName username: type: string example: username schema: type: string example: schema query_tag: type: string example: test_querytag - type: object properties: staging_schema: type: string discriminator: propertyName: export_type mapping: full_load: '#/components/schemas/ConnectionFullExport' cdc: '#/components/schemas/ConnectionCDCExport' examples: connection: value: auth_type: SQL_SERVER_DEFAULT connection_string: sefsf database: SQL Server driver_name: com.microsoft.sqlserver.jdbc.SQLServerDriver password: 0LUKoIi5BneprevHKr1+7ruXmq1NMSyr6yzlcXczTJA= schema: sdfs table: sdfsd username: sdfsd staging_schema: sfdsf responses: '200': description: OK content: application/json: schema: type: object properties: result: type: object properties: message: type: string example: Successfully updated export configuration connection '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}/segmentation/start: post: security: - BearerAuth: [] operationId: startSegmentation parameters: - 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 tags: - Tables summary: Start Segmentation on a Table description: Start Segmentation on a Table requestBody: content: application/json: schema: properties: derive_format: type: string enum: - yyyy - MM - dd - yyyyMM - MMdd - yyyyMMdd derive_function: type: string enum: - year - month - day num in month - year month - month day - year month day extract_from_column: type: boolean column: properties: name: type: string sql_type: type: integer examples: Segmented Load Column Without Derived Value: value: extract_from_column: false column: name: CITY sql_type: 12 Segmented Load Column With Derived Value: value: derive_format: MM derive_function: month extract_from_column: true column: name: RECADDTS5 sql_type: 93 responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message '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}/segmentation/crawl: post: security: - BearerAuth: [] operationId: crawlSegments parameters: - 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 tags: - Tables summary: Crawl Segments Metadata on a Table description: Crawl Segments Metadata on a Table responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message '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}/segmentation: get: security: - BearerAuth: [] operationId: getTableSegments parameters: - 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 - in: query name: crawl_segments schema: type: string example: 'false' description: if true, crawls Segments Metadata if they haven't been already crawled, default is `false` tags: - Tables summary: Get Table Segments of a Table description: Get Table Segments of a Table responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - properties: result: properties: id: type: string example: e77850ad5127a2d7dab870ff segmented_ingested_count: type: integer total_segments_count: type: integer total_count: type: integer table_id: type: string example: e77850ad5127a2d7dab870ff segments: items: properties: count: type: integer ingested_records_count: type: integer segment_id: type: string example: e77850ad5127a2d7dab870ff status: type: string example: ingested segments: items: allOf: - properties: derive_format: type: string enum: - yyyy - MM - dd - yyyyMM - MMdd - yyyyMMdd derive_function: type: string enum: - year - month - day num in month - year month - month day - year month day extract_from_column: type: boolean column: properties: name: type: string sql_type: type: integer - properties: value: type: string description: Any Column Value example: NEWYORK/ Engineer last_successful_job_time: 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}/tables/{table_id}/segmentation/end: post: security: - BearerAuth: [] operationId: endSegmentation parameters: - 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 tags: - Tables summary: End Segmentation on a Table description: End Segmentation on a Table responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message '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}/segmentation/cancel: post: security: - BearerAuth: [] operationId: cancelSegmentation parameters: - 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 tags: - Tables summary: Cancel Segmentation on a Table description: Cancel Segmentation on a Table responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message '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}/configurations/schema: 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 get: security: - BearerAuth: [] tags: - Tables summary: Get the schema of the table description: Get the schema of the table responses: '200': description: OK content: application/json: schema: allOf: - type: object properties: result: type: array items: properties: is_audit_column: type: boolean name: type: string original_name: type: string sql_type: type: integer target_sql_type: type: integer '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: Update the schema of the table description: Update the schema of the table requestBody: content: application/json: schema: oneOf: - type: object properties: type: type: string example: column enum: - column columns: type: array items: type: object required: - precision - scale - hiveType - name - origName properties: precision: type: number example: 3 scale: type: number example: 2 hiveType: type: string example: decimal name: type: string example: FNAME origName: type: string example: FNAME - type: object required: - type - precision - scale properties: type: type: string example: bulk enum: - bulk precision: type: number example: 3 scale: type: number example: 2 examples: Bulk Update: value: type: bulk precision: 3 scale: 2 responses: '200': description: OK content: application/json: schema: type: object properties: result: type: object properties: message: type: string example: Successfully updated schema of the table '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}/configurations: 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 get: security: - BearerAuth: [] tags: - Tables responses: '200': description: OK content: application/json: schema: type: object properties: result: properties: ingestion_configuraiton: allOf: - properties: 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 json_schema_breadcrumb: type: array items: properties: selected: type: boolean example: true name: type: string json_schema_node_key: type: integer example: 0 - properties: crawl_data_filter_enabled: type: boolean example: false crawl_filter_conditions: type: array items: example: '' topic_identifier: type: object properties: type: type: string example: list list: type: array items: example: person max_num_of_records: type: integer example: 20000 streaming_mode: type: string example: micro_batch streaming_frequency_type: type: string example: secs streaming_frequency_number: type: integer example: 10 error_threshold: type: integer example: 5 source_file_type: type: string example: kafka target_relative_path: type: string example: abch update_strategy: type: string example: append write_supported_engines: type: array items: type: string example: SPARK read_supported_engines: type: array items: type: string example: SPARK target_table_name: type: string storage_format: type: string target_schema_name: type: string sync_type: type: string example: incremental advance_configuration: type: array items: allOf: - type: object required: - key - value properties: key: type: string example: keyName value: type: string example: keyValue description: type: string example: description about this configuration is_active: type: boolean example: false entity_id: type: string example: e77850ad5127a2d7dab870ff entity_type: type: string example: source - properties: parent_entity_id: type: string example: e77850ad5127a2d7dab870ff parent_entity_type: type: string example: table '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}/segments: 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 get: security: - BearerAuth: [] tags: - Tables summary: Get a list of all table segments. description: Get a list of all table segments. responses: '200': description: Limitby list of all the tables segments sorted on the format user provided 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: results: type: array items: type: object properties: value: type: string connection_quota: 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}/tables/{table_id}/validation-specs: parameters: - 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 get: security: - BearerAuth: [] tags: - Tables summary: Gets Validation Specs for a Table. description: Gets Validation Specs for a given TableId. 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: type: array items: allOf: - type: object properties: name: type: string example: validation_regex_1 column_name: type: string example: CITY_COL table_id: type: string example: 848dc34275383cd2acdc8cec type: type: string example: regex regex_expression: type: string example: '[a-zA-Z]' '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: [] tags: - Tables summary: Add Validation Specs to a Table. description: Add Validation Specs to a Table. requestBody: content: application/json: schema: type: object properties: name: type: string example: validation_regex_1 column_name: type: string example: CITY_COL table_id: type: string example: 848dc34275383cd2acdc8cec type: type: string example: regex regex_expression: type: string example: '[a-zA-Z]' responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Validation Specs added Successfully 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}/tables/{table_id}/validation-specs/{validation_spec_id}: parameters: - 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 - name: validation_spec_id in: path description: Validation Specs Id. required: true schema: type: string patch: security: - BearerAuth: [] tags: - Tables summary: Updates the Validation Specs for a table. description: Updates the Validation Specs for a table. operationId: updateValidationSpecs requestBody: content: application/json: schema: type: object properties: name: type: string example: validation_regex_1 column_name: type: string example: CITY_COL table_id: type: string example: 848dc34275383cd2acdc8cec type: type: string example: regex regex_expression: type: string example: '[a-zA-Z]' 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 delete: security: - BearerAuth: [] tags: - Tables summary: Delete Validation Specs for a Table description: Delete Validation Specs operationId: deleteValidationSpecs responses: '200': description: successful operation content: application/json: schema: type: object properties: result: type: object properties: id: type: string example: fdf5c3fb3afaf1c3d286ef95 '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/{source_table_id}/get-preview: parameters: - name: source_table_id in: path description: Source Table Id 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 table preview. description: Get table preview. responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: allOf: - type: object properties: source: type: string example: e77850ad5127a2d7dab870ff last_ingested_cdc_value: type: string example: null full_load_performed: type: boolean example: false description: type: string example: example description tags: type: array items: example: c54t456f6d5a2c4564aed schema_name_at_source: type: string example: dummy topic_mapping_id: type: string example: e77850ad5127a2d7dab870ff configuration: type: object allOf: - properties: 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 json_schema_breadcrumb: type: array items: properties: selected: type: boolean example: true name: type: string json_schema_node_key: type: integer example: 0 crawl_data_filter_enabled: type: boolean example: false crawl_filter_conditions: type: array items: example: '' max_num_of_records: type: integer example: 20000 streaming_mode: type: string example: micro_batch streaming_frequency_type: type: string example: secs streaming_frequency_number: type: integer example: 10 error_threshold: type: integer example: 5 source_file_type: type: string example: kafka natural_keys: type: array items: type: string partition_keys: type: array items: type: string target_relative_path: type: string example: abch update_strategy: type: string example: append write_supported_engines: type: array items: type: string example: SPARK read_supported_engines: type: array items: type: string example: SPARK target_table_name: type: string storage_format: type: string target_schema_name: type: string sync_type: type: string example: incremental - type: object properties: id: type: string format: hexadecimal name: type: string original_table_name: type: string topic_mapping_name: type: string file_mapping_name: type: string data_lake_schema: type: string example: kafka data_lake_path: type: string example: /iw/kafka-source meta_crawl_performed: type: boolean columns: type: array items: type: object properties: sql_type: type: integer example: 4 name: type: string example: id original_name: type: string example: id target_sql_type: type: integer example: 4 json_schema_node_key: type: integer example: 4 is_mixed_element_text_content: type: boolean example: false is_recursive_data_text_content: type: boolean example: false is_excluded_column: 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}/table/{source_table_id}/generate-preview: parameters: - name: source_table_id in: path description: Source Table Id required: true schema: type: string - name: source_id in: path description: Source Id. required: true schema: type: string get: security: - BearerAuth: [] tags: - Tables summary: Generate table preview. description: Generate table preview. responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - 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}/query_table/generate-preview: parameters: - name: source_id in: path description: Source Id. required: true schema: type: string - name: query in: query description: Query for table preview required: true schema: type: string - name: number_of_rows in: query description: Number of rows schema: type: string get: security: - BearerAuth: [] tags: - Tables summary: Generate query table preview. description: Generate query table preview. responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - 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}/query_table/get-preview: parameters: - name: source_id in: path description: Source Id. required: true schema: type: string - name: query in: query description: Query for table preview required: true schema: type: string get: security: - BearerAuth: [] tags: - Tables summary: Get query table preview. description: Get query table preview. responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: allOf: - type: object properties: source: type: string example: e77850ad5127a2d7dab870ff last_ingested_cdc_value: type: string example: null full_load_performed: type: boolean example: false description: type: string example: example description tags: type: array items: example: c54t456f6d5a2c4564aed schema_name_at_source: type: string example: dummy topic_mapping_id: type: string example: e77850ad5127a2d7dab870ff configuration: type: object allOf: - properties: 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 json_schema_breadcrumb: type: array items: properties: selected: type: boolean example: true name: type: string json_schema_node_key: type: integer example: 0 crawl_data_filter_enabled: type: boolean example: false crawl_filter_conditions: type: array items: example: '' max_num_of_records: type: integer example: 20000 streaming_mode: type: string example: micro_batch streaming_frequency_type: type: string example: secs streaming_frequency_number: type: integer example: 10 error_threshold: type: integer example: 5 source_file_type: type: string example: kafka natural_keys: type: array items: type: string partition_keys: type: array items: type: string target_relative_path: type: string example: abch update_strategy: type: string example: append write_supported_engines: type: array items: type: string example: SPARK read_supported_engines: type: array items: type: string example: SPARK target_table_name: type: string storage_format: type: string target_schema_name: type: string sync_type: type: string example: incremental - type: object properties: id: type: string format: hexadecimal name: type: string original_table_name: type: string topic_mapping_name: type: string file_mapping_name: type: string data_lake_schema: type: string example: kafka data_lake_path: type: string example: /iw/kafka-source meta_crawl_performed: type: boolean columns: type: array items: type: object properties: sql_type: type: integer example: 4 name: type: string example: id original_name: type: string example: id target_sql_type: type: integer example: 4 json_schema_node_key: type: integer example: 4 is_mixed_element_text_content: type: boolean example: false is_recursive_data_text_content: type: boolean example: false is_excluded_column: 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}/generateQueries: parameters: - 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 get: security: - BearerAuth: [] tags: - Tables summary: Get Preview Queries. description: Gets Preview Queries. responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: object allOf: - type: object properties: sampleDataQuery: type: string example: select from xyz.` ( select * from xyz.test limit 101 ) QAAT ` limit 100dfb success: type: boolean example: true cdcQuery: type: string example: select from ( select * from test.test limit 101 ) QAAT schemaCrawlQuery: type: string example: select * from ( select * from test.test limit 101 ) QAAT where 1=0 rowCountQuery: type: string example: select count(*) as tableRowCount from ( select * from test.test limit 101 ) QAAT message: type: string example: Got Queries successfully fullLoadQuery: type: string example: select from ( select * from test.test limit 101 ) QAAT '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 /tables/: get: security: - BearerAuth: [] tags: - Tables summary: Get multiple table Ids description: Get multiple table Ids responses: '200': description: OK content: application/json: schema: type: object properties: message: type: string result: type: array items: type: object properties: id: type: string name: type: string original_table_name: type: string data_lake_path: type: string meta_crawl_performed: type: boolean columns: type: array items: type: object properties: sql_type: type: number is_deleted: type: boolean name: type: string original_name: type: string target_sql_type: type: number col_type_name: type: string is_audit_column: type: boolean target_scale: type: string col_size: type: number precision: type: number target_precision: type: string scale: type: number configuration: type: object properties: exclude_legacy_audit_columns: type: boolean sync_type: type: string write_supported_engines: type: array items: type: string read_supported_engines: type: array items: type: string target_table_name: type: string storage_format: type: string target_schema_name: type: string is_scd2_table: type: boolean is_archive_enabled: type: boolean natural_keys: type: array items: type: object generate_history_view: type: boolean segmented_load_columns: type: array items: type: object state: type: string created_at: type: string source: type: string last_ingested_cdc_value: type: object is_jtds_driver: type: boolean schema_name_at_source: type: string catalog_name: type: string catalog_is_database: type: boolean has_catalog: type: boolean data_warehouse_type: 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 /tables/{table_id}/metadata: parameters: - name: table_id in: path description: Table Id. required: true schema: type: string patch: security: - BearerAuth: [] tags: - Tables summary: update table metadata description: update table metadata requestBody: description: Table 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: descriptions columns_descriptions: type: array items: type: object properties: name: type: string example: Id description: type: string example: hello examples: EntityMetadata: value: tags_to_add: - sales tags_to_remove: - engg is_favorite: true description: description columns_descriptions: - name: Id description: hello 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 table metadata description: get table metadata responses: '200': description: get table 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 /tables/{table_id}/lineage: parameters: - name: table_id in: path description: Table Id. required: true schema: type: string get: security: - BearerAuth: [] tags: - Tables summary: get table lineage description: get table lineage responses: '200': description: get table lineage content: application/json: schema: type: object properties: table: type: object properties: id: type: string name: type: string parent_entity_type: type: string example: source parent_entity_id: type: string parent_entity_name: type: string has_catalog: type: boolean example: true catalog_name: type: string catalog_is_database: type: boolean example: true domains: type: object properties: id: type: string name: type: string pipelines: type: array items: allOf: - type: object properties: id: type: string version_id: type: string name: 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 components: securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT BasicAuth: type: http scheme: basic