openapi: 3.2.0 info: contact: {} title: Infoworks Rest API V3 Sources 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: Sources description: '' paths: /sources: parameters: - name: Content-Type in: header description: Http content type required: true schema: type: string get: security: - BearerAuth: [] tags: - Sources summary: Get list of sources description: Get list of sources operationId: getSourceList 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: allOf: - type: object allOf: - properties: id: type: string example: 354t45656556254564545 name: type: string example: sample source type: type: string example: streaming sub_type: type: string example: kafka enum: - kafka - structured - json - xml - unstructured - teradata - redshift - oracle - mysql - mariadb - sqlserver - db2 - netezza - saphana - hive - sybaseiq - ignite - vertica - maprdb - mongodb - rest_generic - salesforce data_lake_path: type: string example: /iw/kafka-source use_staging_schema_for_infoworks_managed_tables: type: boolean example: true use_staging_dataset_for_infoworks_managed_tables: type: boolean example: true description: type: string example: example description tags: type: array items: example: c54t456f6d5a2c4564aed data_lake_schema: type: string example: kafka state: type: string example: ready is_source_ingested: type: boolean example: true is_public: type: boolean - 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: tables: type: array items: type: string example: c74a5abb4854ac0a70206f00 - type: object properties: environment: type: object properties: id: type: string example: 63cd71df9f1c1e258c6e991b name: type: string example: env_azure compute_engine: type: string example: spark platform: type: string example: databricks ephemeral_compute: type: array items: type: object properties: name: type: string example: ephemeral_compute environment_id: type: string example: 63cd71df9f1c1e258c6e991b id: type: string example: 63cd71df9f1c1e258c6e991b interactive_compute: type: array items: type: object properties: name: type: string example: interactive_compute environment_id: type: string example: 63cd71df9f1c1e258c6e991b id: type: string example: 63cd71df9f1c1e258c6e991b storage: type: array items: type: object properties: id: type: string example: 63cd71df9f1c1e258c6e991b name: type: string example: storage environment_id: type: string example: 63cd71df9f1c1e258c6e991b description: type: string example: description for storage storage_type: type: string example: gcs storage_authentication: type: object properties: authentication_mechanism: type: string example: environment_service_credential scheme: type: string example: gs:// bucket_name: type: string example: temp-bucket-xxx - type: object properties: environment_id: type: string example: 5fda050e7758f32604184d38 storage_id: type: string example: 5fda050e7758f32604184d38 is_generic_jdbc_source_type: type: boolean example: false '400': description: Bad Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '401': description: Unauthorized Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '403': description: Forbidden Access content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '500': description: Internal Server Error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 post: security: - BearerAuth: [] tags: - Sources summary: Create source description: Create source operationId: createSource requestBody: description: Source configurations content: application/json: schema: oneOf: - type: object properties: name: type: string environment_id: type: string storage_id: type: string data_lake_schema: type: string data_lake_path: type: string type: type: string is_source_ingested: type: boolean storage: type: string is_public: type: boolean sub_type: type: string enum: - redshift - saphana - sybaseiq - vertica - mongodb - rest_generic is_oem_connector: type: boolean connection: oneOf: - allOf: - type: object required: - source_schema - username - password - database properties: connection_mode: type: string example: jdbc enum: - jdbc connection_url: type: string example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db source_schema: type: string example: test_schema username: type: string example: Lucifer 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 database: type: string example: automation_db snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - type: object properties: enable_log_based_cdc: type: boolean example: true staging_database: type: string example: db_staging enable_dictionary_rebuild_for_each_job: type: boolean example: true dictionary_path: type: string example: /tmp/dict dictionary_type: type: string example: online enum: - online - offline - redo_log - allOf: - type: object required: - source_schema - username - password - database properties: connection_mode: type: string example: jdbc enum: - jdbc connection_url: type: string example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db source_schema: type: string example: test_schema username: type: string example: Lucifer 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 database: type: string example: automation_db snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - allOf: - type: object required: - source_schema - username - password - database properties: connection_mode: type: string example: jdbc enum: - jdbc connection_url: type: string example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db source_schema: type: string example: test_schema username: type: string example: Lucifer 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 database: type: string example: automation_db snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - allOf: - type: object required: - source_schema - username - password - database properties: connection_mode: type: string example: jdbc enum: - jdbc connection_url: type: string example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db source_schema: type: string example: test_schema username: type: string example: Lucifer 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 database: type: string example: automation_db snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - type: object properties: enable_teradata_wallet: type: boolean example: true teradata_wallet_key_used_for_password: type: string storage: oneOf: - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object required: - sftp_host - sftp_port - username - password - auth_type properties: sftp_host: type: string example: 192.168.1.1 sftp_port: type: integer example: 22 username: type: string example: Lucifer 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 auth_type: type: string example: password credential: oneOf: - type: object required: - type - username - password properties: type: type: string example: basic username: type: string example: sftp-user 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 - type: object required: - type - username - private_key_path - passphrase properties: type: type: string example: key username: type: string example: sftp-user private_key_path: type: string example: /opt/infoworks/key passphrase: type: string example: J9moLFp0XjMhsLu - oneOf: - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object required: - type - base_path - credential properties: account_type: type: string access_id: type: string secret_key: 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 access_type: type: string support_gov_cloud: type: boolean endpoint: type: string - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object properties: access_type: type: string example: service_account enum: - service_account project_id: type: string example: csv_store upload_option: type: string enum: - fileUpload - serverLocation example: fileUpload server_path: type: string description: required if upload_option is set to serverLocation example: /opt/infoworks/uploads/ccd2d7144f74b382357e5f5f/key.json - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object properties: account_name: type: string account_key: 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 account_endpoint: type: string container_name: type: string support_gov_cloud: type: boolean access_type: type: string enum: - none - account_key enable_ingestion_via_tpt: type: boolean example: true is_td_wallet_enabled: type: boolean example: true enable_tpt_for_source: type: boolean example: true - allOf: - type: object required: - source_schema - username - password - database properties: connection_mode: type: string example: jdbc enum: - jdbc connection_url: type: string example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db source_schema: type: string example: test_schema username: type: string example: Lucifer 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 database: type: string example: automation_db snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - allOf: - type: object required: - source_schema - username - password - database properties: connection_mode: type: string example: jdbc enum: - jdbc connection_url: type: string example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db source_schema: type: string example: test_schema username: type: string example: Lucifer 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 database: type: string example: automation_db snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - type: object required: - source_type - storage properties: source_type: type: string example: structured_files enum: - structured_files storage: oneOf: - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object required: - sftp_host - sftp_port - username - password - auth_type properties: sftp_host: type: string example: 192.168.1.1 sftp_port: type: integer example: 22 username: type: string example: Lucifer 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 auth_type: type: string example: password credential: oneOf: - type: object required: - type - username - password properties: type: type: string example: basic username: type: string example: sftp-user 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 - type: object required: - type - username - private_key_path - passphrase properties: type: type: string example: key username: type: string example: sftp-user private_key_path: type: string example: /opt/infoworks/key passphrase: type: string example: J9moLFp0XjMhsLu - oneOf: - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object required: - type - base_path - credential properties: account_type: type: string access_id: type: string secret_key: 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 access_type: type: string support_gov_cloud: type: boolean endpoint: type: string - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object properties: access_type: type: string example: service_account enum: - service_account project_id: type: string example: csv_store upload_option: type: string enum: - fileUpload - serverLocation example: fileUpload server_path: type: string description: required if upload_option is set to serverLocation example: /opt/infoworks/uploads/ccd2d7144f74b382357e5f5f/key.json - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object properties: account_name: type: string account_key: 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 account_endpoint: type: string container_name: type: string support_gov_cloud: type: boolean access_type: type: string enum: - none - account_key - type: object required: - source_base_path - storage properties: source_base_path: type: string example: /sources/csv_source storage: oneOf: - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object required: - sftp_host - sftp_port - username - password - auth_type properties: sftp_host: type: string example: 192.168.1.1 sftp_port: type: integer example: 22 username: type: string example: Lucifer 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 auth_type: type: string example: password credential: oneOf: - type: object required: - type - username - password properties: type: type: string example: basic username: type: string example: sftp-user 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 - type: object required: - type - username - private_key_path - passphrase properties: type: type: string example: key username: type: string example: sftp-user private_key_path: type: string example: /opt/infoworks/key passphrase: type: string example: J9moLFp0XjMhsLu - oneOf: - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object required: - type - base_path - credential properties: account_type: type: string access_id: type: string secret_key: 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 access_type: type: string support_gov_cloud: type: boolean endpoint: type: string - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object properties: access_type: type: string example: service_account enum: - service_account project_id: type: string example: csv_store upload_option: type: string enum: - fileUpload - serverLocation example: fileUpload server_path: type: string description: required if upload_option is set to serverLocation example: /opt/infoworks/uploads/ccd2d7144f74b382357e5f5f/key.json - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object properties: account_name: type: string account_key: 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 account_endpoint: type: string container_name: type: string support_gov_cloud: type: boolean access_type: type: string enum: - none - account_key key: description: required only if gcs cloud storage type is selected with fileUpload Option use content-type as multipart/form-data format: binary example: key.json snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - allOf: - type: object required: - source_base_path - storage properties: source_base_path: type: string example: /sources/csv_source storage: oneOf: - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object required: - sftp_host - sftp_port - username - password - auth_type properties: sftp_host: type: string example: 192.168.1.1 sftp_port: type: integer example: 22 username: type: string example: Lucifer 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 auth_type: type: string example: password credential: oneOf: - type: object required: - type - username - password properties: type: type: string example: basic username: type: string example: sftp-user 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 - type: object required: - type - username - private_key_path - passphrase properties: type: type: string example: key username: type: string example: sftp-user private_key_path: type: string example: /opt/infoworks/key passphrase: type: string example: J9moLFp0XjMhsLu - oneOf: - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object required: - type - base_path - credential properties: account_type: type: string access_id: type: string secret_key: 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 access_type: type: string support_gov_cloud: type: boolean endpoint: type: string - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object properties: access_type: type: string example: service_account enum: - service_account project_id: type: string example: csv_store upload_option: type: string enum: - fileUpload - serverLocation example: fileUpload server_path: type: string description: required if upload_option is set to serverLocation example: /opt/infoworks/uploads/ccd2d7144f74b382357e5f5f/key.json - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object properties: account_name: type: string account_key: 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 account_endpoint: type: string container_name: type: string support_gov_cloud: type: boolean access_type: type: string enum: - none - account_key key: description: required only if gcs cloud storage type is selected with fileUpload Option use content-type as multipart/form-data format: binary example: key.json snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - type: object properties: source_base_path_relative: type: string - type: object properties: environment: type: string connection_url: type: string username: type: string 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 application_secret_key: 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 fetch_mechanism: type: string enum: - bulk - rest - both api_version: type: string snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - type: object properties: broker_id: type: string message_format: type: string enum: - json - avro snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - type: object properties: broker_id: type: string message_format: type: string enum: - json - avro enable_cluster_authentication: type: boolean enable_schema_registry: type: boolean cluster_authentication_details: type: object properties: security_protocol: type: string enum: - sasl_ssl sasl_mechanism: type: string enum: - plain username: type: string 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 schema_registry_authentication_details: type: object properties: authentication_mechanism: type: string enum: - http_basic - none username: type: string 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 schema_registry_url: type: string snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - type: object properties: connection_url: type: string source_schema: type: string username: type: string 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 database: type: string parameters: type: object properties: is_active: type: boolean is_encrypted: type: boolean key: type: string value: type: string snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - type: object properties: name: type: string environment_id: type: string storage_id: type: string data_lake_schema: type: string data_lake_path: type: string type: type: string is_source_ingested: type: boolean storage: type: string is_public: type: boolean sub_type: type: string enum: - structured - json - xml - unstructured - teradata - oracle - mysql - mariadb - sqlserver - db2 - netezza - hive - ignite - maprdb - salesforce connection: oneOf: - allOf: - type: object required: - source_schema - username - password - database properties: connection_mode: type: string example: jdbc enum: - jdbc connection_url: type: string example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db source_schema: type: string example: test_schema username: type: string example: Lucifer 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 database: type: string example: automation_db snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - type: object properties: enable_log_based_cdc: type: boolean example: true staging_database: type: string example: db_staging enable_dictionary_rebuild_for_each_job: type: boolean example: true dictionary_path: type: string example: /tmp/dict dictionary_type: type: string example: online enum: - online - offline - redo_log - allOf: - type: object required: - source_schema - username - password - database properties: connection_mode: type: string example: jdbc enum: - jdbc connection_url: type: string example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db source_schema: type: string example: test_schema username: type: string example: Lucifer 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 database: type: string example: automation_db snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - allOf: - type: object required: - source_schema - username - password - database properties: connection_mode: type: string example: jdbc enum: - jdbc connection_url: type: string example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db source_schema: type: string example: test_schema username: type: string example: Lucifer 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 database: type: string example: automation_db snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - allOf: - type: object required: - source_schema - username - password - database properties: connection_mode: type: string example: jdbc enum: - jdbc connection_url: type: string example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db source_schema: type: string example: test_schema username: type: string example: Lucifer 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 database: type: string example: automation_db snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - type: object properties: enable_teradata_wallet: type: boolean example: true teradata_wallet_key_used_for_password: type: string storage: oneOf: - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object required: - sftp_host - sftp_port - username - password - auth_type properties: sftp_host: type: string example: 192.168.1.1 sftp_port: type: integer example: 22 username: type: string example: Lucifer 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 auth_type: type: string example: password credential: oneOf: - type: object required: - type - username - password properties: type: type: string example: basic username: type: string example: sftp-user 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 - type: object required: - type - username - private_key_path - passphrase properties: type: type: string example: key username: type: string example: sftp-user private_key_path: type: string example: /opt/infoworks/key passphrase: type: string example: J9moLFp0XjMhsLu - oneOf: - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object required: - type - base_path - credential properties: account_type: type: string access_id: type: string secret_key: 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 access_type: type: string support_gov_cloud: type: boolean endpoint: type: string - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object properties: access_type: type: string example: service_account enum: - service_account project_id: type: string example: csv_store upload_option: type: string enum: - fileUpload - serverLocation example: fileUpload server_path: type: string description: required if upload_option is set to serverLocation example: /opt/infoworks/uploads/ccd2d7144f74b382357e5f5f/key.json - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object properties: account_name: type: string account_key: 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 account_endpoint: type: string container_name: type: string support_gov_cloud: type: boolean access_type: type: string enum: - none - account_key enable_ingestion_via_tpt: type: boolean example: true is_td_wallet_enabled: type: boolean example: true enable_tpt_for_source: type: boolean example: true - allOf: - type: object required: - source_schema - username - password - database properties: connection_mode: type: string example: jdbc enum: - jdbc connection_url: type: string example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db source_schema: type: string example: test_schema username: type: string example: Lucifer 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 database: type: string example: automation_db snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - allOf: - type: object required: - source_schema - username - password - database properties: connection_mode: type: string example: jdbc enum: - jdbc connection_url: type: string example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db source_schema: type: string example: test_schema username: type: string example: Lucifer 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 database: type: string example: automation_db snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - type: object required: - source_type - storage properties: source_type: type: string example: structured_files enum: - structured_files storage: oneOf: - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object required: - sftp_host - sftp_port - username - password - auth_type properties: sftp_host: type: string example: 192.168.1.1 sftp_port: type: integer example: 22 username: type: string example: Lucifer 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 auth_type: type: string example: password credential: oneOf: - type: object required: - type - username - password properties: type: type: string example: basic username: type: string example: sftp-user 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 - type: object required: - type - username - private_key_path - passphrase properties: type: type: string example: key username: type: string example: sftp-user private_key_path: type: string example: /opt/infoworks/key passphrase: type: string example: J9moLFp0XjMhsLu - oneOf: - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object required: - type - base_path - credential properties: account_type: type: string access_id: type: string secret_key: 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 access_type: type: string support_gov_cloud: type: boolean endpoint: type: string - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object properties: access_type: type: string example: service_account enum: - service_account project_id: type: string example: csv_store upload_option: type: string enum: - fileUpload - serverLocation example: fileUpload server_path: type: string description: required if upload_option is set to serverLocation example: /opt/infoworks/uploads/ccd2d7144f74b382357e5f5f/key.json - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object properties: account_name: type: string account_key: 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 account_endpoint: type: string container_name: type: string support_gov_cloud: type: boolean access_type: type: string enum: - none - account_key - type: object required: - source_base_path - storage properties: source_base_path: type: string example: /sources/csv_source storage: oneOf: - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object required: - sftp_host - sftp_port - username - password - auth_type properties: sftp_host: type: string example: 192.168.1.1 sftp_port: type: integer example: 22 username: type: string example: Lucifer 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 auth_type: type: string example: password credential: oneOf: - type: object required: - type - username - password properties: type: type: string example: basic username: type: string example: sftp-user 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 - type: object required: - type - username - private_key_path - passphrase properties: type: type: string example: key username: type: string example: sftp-user private_key_path: type: string example: /opt/infoworks/key passphrase: type: string example: J9moLFp0XjMhsLu - oneOf: - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object required: - type - base_path - credential properties: account_type: type: string access_id: type: string secret_key: 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 access_type: type: string support_gov_cloud: type: boolean endpoint: type: string - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object properties: access_type: type: string example: service_account enum: - service_account project_id: type: string example: csv_store upload_option: type: string enum: - fileUpload - serverLocation example: fileUpload server_path: type: string description: required if upload_option is set to serverLocation example: /opt/infoworks/uploads/ccd2d7144f74b382357e5f5f/key.json - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object properties: account_name: type: string account_key: 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 account_endpoint: type: string container_name: type: string support_gov_cloud: type: boolean access_type: type: string enum: - none - account_key key: description: required only if gcs cloud storage type is selected with fileUpload Option use content-type as multipart/form-data format: binary example: key.json snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - allOf: - type: object required: - source_base_path - storage properties: source_base_path: type: string example: /sources/csv_source storage: oneOf: - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object required: - sftp_host - sftp_port - username - password - auth_type properties: sftp_host: type: string example: 192.168.1.1 sftp_port: type: integer example: 22 username: type: string example: Lucifer 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 auth_type: type: string example: password credential: oneOf: - type: object required: - type - username - password properties: type: type: string example: basic username: type: string example: sftp-user 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 - type: object required: - type - username - private_key_path - passphrase properties: type: type: string example: key username: type: string example: sftp-user private_key_path: type: string example: /opt/infoworks/key passphrase: type: string example: J9moLFp0XjMhsLu - oneOf: - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object required: - type - base_path - credential properties: account_type: type: string access_id: type: string secret_key: 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 access_type: type: string support_gov_cloud: type: boolean endpoint: type: string - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object properties: access_type: type: string example: service_account enum: - service_account project_id: type: string example: csv_store upload_option: type: string enum: - fileUpload - serverLocation example: fileUpload server_path: type: string description: required if upload_option is set to serverLocation example: /opt/infoworks/uploads/ccd2d7144f74b382357e5f5f/key.json - allOf: - type: object properties: storage_type: type: string enum: - dbfs - remote - cloud - type: object properties: cloud_type: type: string enum: - s3 - wasb - gs - type: object properties: account_name: type: string account_key: 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 account_endpoint: type: string container_name: type: string support_gov_cloud: type: boolean access_type: type: string enum: - none - account_key key: description: required only if gcs cloud storage type is selected with fileUpload Option use content-type as multipart/form-data format: binary example: key.json snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - type: object properties: source_base_path_relative: type: string - type: object properties: environment: type: string connection_url: type: string username: type: string 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 application_secret_key: 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 fetch_mechanism: type: string enum: - bulk - rest - both api_version: type: string snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - type: object properties: broker_id: type: string message_format: type: string enum: - json - avro snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - type: object properties: broker_id: type: string message_format: type: string enum: - json - avro enable_cluster_authentication: type: boolean enable_schema_registry: type: boolean cluster_authentication_details: type: object properties: security_protocol: type: string enum: - sasl_ssl sasl_mechanism: type: string enum: - plain username: type: string 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 schema_registry_authentication_details: type: object properties: authentication_mechanism: type: string enum: - http_basic - none username: type: string 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 schema_registry_url: type: string snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH - type: object properties: connection_url: type: string source_schema: type: string username: type: string 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 database: type: string parameters: type: object properties: is_active: type: boolean is_encrypted: type: boolean key: type: string value: type: string snowflake_profile: type: string example: profile1 warehouse: type: string example: DEMO_WH examples: Infoworks Connectors: value: name: sample source environment_id: 5fda050e7758f32604184d38 storage_id: 5fda050e7758f32604184d38 data_lake_schema: kafka data_lake_path: /iw/kafka-source type: rdbms is_source_ingested": true storage: old_test is_public: true sub_type: mongodb is_oem_connector: true OEM Connectors: value: name: sample source environment_id: 5fda050e7758f32604184d38 storage_id: 5fda050e7758f32604184d38 data_lake_schema: kafka data_lake_path: /iw/kafka-source type: rdbms is_source_ingested": true storage: old_test is_public: true 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 x-codegen-request-body-name: configurations /sources/{source_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 get: security: - BearerAuth: [] tags: - Sources summary: Get Source Info description: Get Source Info operationId: getSourceInfo responses: '200': description: successful operation content: application/json: schema: type: object properties: result: allOf: - type: object allOf: - properties: id: type: string example: 354t45656556254564545 name: type: string example: sample source type: type: string example: streaming sub_type: type: string example: kafka enum: - kafka - structured - json - xml - unstructured - teradata - redshift - oracle - mysql - mariadb - sqlserver - db2 - netezza - saphana - hive - sybaseiq - ignite - vertica - maprdb - mongodb - rest_generic - salesforce data_lake_path: type: string example: /iw/kafka-source use_staging_schema_for_infoworks_managed_tables: type: boolean example: true use_staging_dataset_for_infoworks_managed_tables: type: boolean example: true description: type: string example: example description tags: type: array items: example: c54t456f6d5a2c4564aed data_lake_schema: type: string example: kafka state: type: string example: ready is_source_ingested: type: boolean example: true is_public: type: boolean - 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: tables: type: array items: type: string example: c74a5abb4854ac0a70206f00 - type: object properties: environment_details: type: array items: type: object properties: environment: type: object properties: id: type: string example: 63cd71df9f1c1e258c6e991b name: type: string example: env_azure compute_engine: type: string example: spark platform: type: string example: databricks ephemeral_compute: type: array items: type: object properties: name: type: string example: ephemeral_compute environment_id: type: string example: 63cd71df9f1c1e258c6e991b id: type: string example: 63cd71df9f1c1e258c6e991b interactive_compute: type: array items: type: object properties: name: type: string example: interactive_compute environment_id: type: string example: 63cd71df9f1c1e258c6e991b id: type: string example: 63cd71df9f1c1e258c6e991b storage: type: array items: type: object properties: id: type: string example: 63cd71df9f1c1e258c6e991b name: type: string example: storage environment_id: type: string example: 63cd71df9f1c1e258c6e991b description: type: string example: description for storage storage_type: type: string example: gcs storage_authentication: type: object properties: authentication_mechanism: type: string example: environment_service_credential scheme: type: string example: gs:// bucket_name: type: string example: temp-bucket-xxx connection: type: object properties: environment_details: type: object properties: environment: type: object properties: id: type: string example: 63cd71df9f1c1e258c6e991b name: type: string example: env_azure compute_engine: type: string example: spark platform: type: string example: databricks description: type: string example: Test Description ephemeral_compute: type: array items: type: object properties: name: type: string example: ephemeral_compute environment_id: type: string example: 63cd71df9f1c1e258c6e991b id: type: string example: 63cd71df9f1c1e258c6e991b interactive_compute: type: array items: type: object properties: name: type: string example: interactive_compute environment_id: type: string example: 63cd71df9f1c1e258c6e991b id: type: string example: 63cd71df9f1c1e258c6e991b storage: type: array items: type: object properties: id: type: string example: 63cd71df9f1c1e258c6e991b name: type: string example: storage environment_id: type: string example: 63cd71df9f1c1e258c6e991b configuration: type: object properties: oracle_staging_database: type: string example: AUTOMATION_DB_LOG_DEFAULTST19 oracle_logminer_dictionary_type: type: string example: online oracle_logbased_cdc_enabled: 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 delete: security: - BearerAuth: [] tags: - Sources summary: Delete source description: Delete source operationId: deleteSource 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 patch: security: - BearerAuth: [] tags: - Sources summary: Update source description: Update source operationId: updateSource requestBody: description: Source configurations content: application/json: schema: type: object properties: name: type: string example: Sales_data required: true 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 x-codegen-request-body-name: configurations /sources/{source_id}/source_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 - name: is_filter_enabled in: query description: True if filter is passed required: true schema: type: boolean example: true - name: schemas_filter in: query description: schema filter schema: type: string example: ingestion - name: catalogs_filter in: query description: catalogs filter schema: type: string example: catalog_name - name: tables_filter in: query description: tables filter schema: type: string example: table1 get: security: - BearerAuth: [] tags: - Sources summary: Browse source description: Browse source operationId: browseSource responses: '200': description: successful operation content: application/json: schema: type: object properties: message: type: string example: Source Browsed 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}/tables/query_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 post: security: - BearerAuth: [] tags: - Sources summary: Add query tables description: Add query tables operationId: addQueryTables requestBody: description: Query table configurations content: application/json: schema: type: object properties: tables_to_add: type: object example: - table_type: TABLE query: select * from "company"."sales"."order" target_table_name: order target_schema_name: sales target_database_name: testdb target_dataset_name: test_dataset project_id: test-id required: true responses: '200': description: successful operation content: application/json: schema: type: object properties: message: type: string example: Query 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}/crawl-schema: parameters: - 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 - name: entity_id in: query description: Entity ID required: true schema: type: string get: security: - BearerAuth: [] tags: - Sources summary: Crawl Entity Schema description: Crawl Entity 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}/bulk-crawl-schema: parameters: - 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 - name: entity_ids in: query description: A list of Entity IDs required: true schema: type: string get: security: - BearerAuth: [] tags: - Sources summary: Bulk Crawl Entity Schema description: Bulk Crawl Entity 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}/crawl-status: parameters: - 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 - name: entity_id in: query description: Entity ID required: true schema: type: string get: security: - BearerAuth: [] tags: - Sources summary: Check status for crawling description: Check status for crawling 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}/bulk-crawl-status: parameters: - 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 - name: entity_ids in: query description: A list of Entity IDs required: true schema: type: string get: security: - BearerAuth: [] tags: - Sources summary: Check status for bulk crawling description: Check status for bulk crawling 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 components: securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT BasicAuth: type: http scheme: basic