openapi: 3.2.0 info: contact: {} title: Infoworks Rest API V3 Topics 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: Topics description: '' paths: /sources/{source_id}/topic-mappings: 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: [] operationId: getTopicMappingsForSource tags: - Topics summary: Get a list of all topics mapping. description: Get a list of all topics mapping. responses: '200': description: Topics Mapping content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: total_count: type: integer minimum: 0 description: Total count of topic mappings example: 10 result: items: allOf: - properties: name: type: string example: topic_mapping_1 configuration: properties: topic_identifier: type: object properties: type: type: string example: list list: type: array items: example: person regex: type: string example: ^person crawl_schema_mechanism: type: string subject_name: type: string - type: object allOf: - type: object properties: created_at: type: string example: '2019-11-21T12:54:05.875Z' - type: object properties: created_by: type: string example: 6RkfybTRQQByEey3v - type: object properties: modified_at: type: string example: '2019-11-21T12:54:05.875Z' - type: object properties: modified_by: type: string example: 6RkfybTRQQByEey3v properties: id: type: string example: e77850ad5127a2d7dab870ff json_schema: type: array items: type: object properties: key: type: integer example: 1 name: type: string example: del properties: type: object properties: sql_type: type: integer example: 1 target_sql_type: type: integer example: 1 type: type: string example: struct table_details: type: array items: properties: id: type: string example: d04a89ca9d4e9af1b86fdc3e name: type: string example: tableName state: type: string example: ready deserializer_extension_name: type: string example: Kafka deserializer_function_alias: type: string example: Kafka_function '400': description: Bad Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '401': description: Unauthorized Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '403': description: Forbidden Access content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '500': description: Internal Server Error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 post: security: - BearerAuth: [] operationId: createTopicMappingForSource tags: - Topics summary: Create Topic Mapping For Source description: Create Topic Mapping For Source requestBody: content: application/json: schema: properties: name: type: string example: topic_mapping_1 configuration: properties: topic_identifier: type: object properties: type: type: string example: list list: type: array items: example: person regex: type: string example: ^person crawl_schema_mechanism: type: string subject_name: type: string responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: string example: e77850ad5127a2d7dab870ff '400': description: Bad Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '401': description: Unauthorized Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '403': description: Forbidden Access content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '500': description: Internal Server Error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 /sources/{source_id}/topic-mappings/{topic_mapping_id}: parameters: - name: Content-Type in: header description: Http content type required: true schema: type: string - name: source_id in: path description: Source Id. required: true schema: type: string - name: topic_mapping_id in: path description: Topic Mapping Id. required: true schema: type: string get: security: - BearerAuth: [] operationId: getTopicMappingForSource tags: - Topics summary: Get topic mapping id. description: Get topic mapping id. responses: '200': description: Topics Mapping Id content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: allOf: - properties: name: type: string example: topic_mapping_1 configuration: properties: topic_identifier: type: object properties: type: type: string example: list list: type: array items: example: person regex: type: string example: ^person crawl_schema_mechanism: type: string subject_name: type: string - type: object allOf: - type: object properties: created_at: type: string example: '2019-11-21T12:54:05.875Z' - type: object properties: created_by: type: string example: 6RkfybTRQQByEey3v - type: object properties: modified_at: type: string example: '2019-11-21T12:54:05.875Z' - type: object properties: modified_by: type: string example: 6RkfybTRQQByEey3v properties: id: type: string example: e77850ad5127a2d7dab870ff json_schema: type: array items: type: object properties: key: type: integer example: 1 name: type: string example: del properties: type: object properties: sql_type: type: integer example: 1 target_sql_type: type: integer example: 1 type: type: string example: struct table_details: type: array items: properties: id: type: string example: d04a89ca9d4e9af1b86fdc3e name: type: string example: tableName state: type: string example: ready deserializer_extension_name: type: string example: Kafka deserializer_function_alias: type: string example: Kafka_function '400': description: Bad Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '401': description: Unauthorized Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '403': description: Forbidden Access content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '500': description: Internal Server Error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 patch: security: - BearerAuth: [] operationId: updateTopicMappingForSource tags: - Topics summary: Update Topic Mapping For Source description: Update Topic Mapping For Source requestBody: content: application/json: schema: properties: name: type: string example: topic_mapping_1 configuration: properties: topic_identifier: type: object properties: type: type: string example: list list: type: array items: example: person regex: type: string example: ^person crawl_schema_mechanism: type: string subject_name: type: string responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: string example: e77850ad5127a2d7dab870ff '400': description: Bad Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '401': description: Unauthorized Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '403': description: Forbidden Access content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '500': description: Internal Server Error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 delete: security: - BearerAuth: [] operationId: deleteTopicMapping tags: - Topics summary: Delete Topic Mapping For Source description: Delete Topic Mapping For Source responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: string example: e77850ad5127a2d7dab870ff '400': description: Bad Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '401': description: Unauthorized Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '403': description: Forbidden Access content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '500': description: Internal Server Error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 /sources/{source_id}/topics: parameters: - name: source_id in: path description: Source Id. required: true schema: type: string get: security: - BearerAuth: [] operationId: getTopics tags: - Topics summary: Get topics From Source description: Get topics From Source responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: object '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}/topic-mappings/{topic_mapping_id}/preview: parameters: - name: source_id in: path description: Source Id. required: true schema: type: string - name: topic_mapping_id in: path description: Topic Mapping Id. required: true schema: type: string get: security: - BearerAuth: [] operationId: getTopicMappingPreview tags: - Topics summary: Get topic Preview description: Get topics 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 '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}/topic-mappings/{topic_mapping_id}/crawl-schema: parameters: - name: source_id in: path description: Source Id. required: true schema: type: string - name: topic_mapping_id in: path description: Topic Mapping Id. required: true schema: type: string get: security: - BearerAuth: [] operationId: crawlSchemaForTopicMapping tags: - Topics summary: Crawl Schema For Topic Mapping description: Crawl Schema For Topic Mapping 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 '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}/topic-mappings/{topic_mapping_id}/table-schema: parameters: - name: source_id in: path description: Source Id. required: true schema: type: string - name: topic_mapping_id in: path description: Topic Mapping Id. required: true schema: type: string get: security: - BearerAuth: [] operationId: getTableSchemaFromMapping tags: - Topics parameters: - name: selected_keys in: query schema: type: string example: '[1, 2]' summary: Get Table Schema From Mapping description: Get Table Schema From Mapping 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 '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}/topic-mappings/{topic_mapping_id}/tables: parameters: - name: source_id in: path description: Source Id. required: true schema: type: string - name: topic_mapping_id in: path description: Topic Mapping Id. required: true schema: type: string post: security: - BearerAuth: [] operationId: createSourceTable tags: - Topics summary: Create Streaming Table description: Create Streaming Table requestBody: content: application/json: schema: type: object responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: string example: e77850ad5127a2d7dab870ff '400': description: Bad Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '401': description: Unauthorized Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '403': description: Forbidden Access content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '500': description: Internal Server Error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 /sources/{source_id}/topic-mappings/{topic_mapping_id}/tables/{table_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: topic_mapping_id in: path description: Topic Mapping Id. required: true schema: type: string get: security: - BearerAuth: [] operationId: getTableInfo tags: - Topics summary: Get Streaming Table description: Get Streaming Table responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message properties: result: 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 '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: deleteTableFromKafkaSource tags: - Topics summary: Delete Streaming Table description: Delete Streaming Table responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: string example: e77850ad5127a2d7dab870ff '400': description: Bad Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '401': description: Unauthorized Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '403': description: Forbidden Access content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '500': description: Internal Server Error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 /sources/{source_id}/file-mappings/{file_mapping_id}/tables/{table_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: file_mapping_id in: path description: File Mapping Id. required: true schema: type: string delete: security: - BearerAuth: [] operationId: deleteTableFromFileMappingsForJSONSource tags: - Topics summary: Delete JSON Source Table description: Delete JSON Source Table responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: string example: e77850ad5127a2d7dab870ff '400': description: Bad Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '401': description: Unauthorized Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '403': description: Forbidden Access content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '500': description: Internal Server Error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 components: securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT BasicAuth: type: http scheme: basic