openapi: 3.2.0 info: contact: {} title: Infoworks Rest API V3 Jobs 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: Jobs description: '' paths: /admin/jobs: get: security: - BearerAuth: [] operationId: getJobs tags: - Jobs summary: Get the jobs details description: Get the jobs details parameters: - name: limit in: query description: The numbers of items to return schema: type: integer default: 10 - 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: Ok. content: application/json: schema: allOf: - type: object properties: limit: type: integer example: 10 offset: type: integer example: 0 links: type: object properties: base: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains} self: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0 next: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10 total_count: type: integer example: 10 x-examples: example-1: {} - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: array items: type: object properties: id: type: string example: 8714887c9a8c5bb0b8794811 build_id: type: integer example: 2 name: type: string example: test_job status: type: string enum: - completed - pending - aborted - blocked - failed - running - canceled - succeeded example: completed percentage: type: integer example: 100 type: type: string enum: - source_test_connection - fetch_metadata - source_structured_fetch_metadata - source_crawl - source_crawl_chunk_load - source_cdc - source_unstructured_crawl - source_structured_crawl - source_semistructured_crawl - delete_entity - pipeline_metadata - pipeline_build - pipeline_build_restatement - full_load - cdc - source_merge - source_structured_cdc_merge - source_structured_cdc - source_cdc_merge - source_cdc_restatement - source_semistructured_cdc_merge - source_semistructured_cdc - metadata_cleanup_policy entity_id: type: string example: d2f33c1d424363162692b3bf entity_type: type: string enum: - source - pipeline - workflow sub_entity_id: type: string example: be034607444511f74313be63 sub_entity_type: type: string example: table_group duration: type: integer example: 349316 description: This is duration of the job. cluster_id: type: string example: j-134jnasdkjaasd description: Extenal clusterId compute_id: type: string example: be034607444511f74313be63 description: Infoworks compute cluster id compute_name: type: string example: Default_Persistent_cluster description: Infoworks compute name created_at: type: string format: date-time example: '2020-10-05T04:23:30.339Z' created_by: type: string example: 6RkfybTRQQByEey3v description: UserId of user who triggered the job. last_updated: type: string example: '2019-11-21T12:54:05.875Z' processed_at: type: string example: '2019-11-21T12:54:05.875Z' '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /admin/jobs/{job_id}: parameters: - name: job_id in: path description: Job Id required: true schema: type: string get: security: - BearerAuth: [] operationId: getjobs id details tags: - Jobs summary: Get the job details with `job_id` description: Get the job details with `job_id` responses: '200': description: Ok. content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: object properties: id: type: string example: 8714887c9a8c5bb0b8794811 build_id: type: integer example: 2 name: type: string example: test_job status: type: string enum: - completed - pending - aborted - blocked - failed - running - canceled - succeeded example: completed percentage: type: integer example: 100 type: type: string enum: - source_test_connection - fetch_metadata - source_structured_fetch_metadata - source_crawl - source_crawl_chunk_load - source_cdc - source_unstructured_crawl - source_structured_crawl - source_semistructured_crawl - delete_entity - pipeline_metadata - pipeline_build - pipeline_build_restatement - full_load - cdc - source_merge - source_structured_cdc_merge - source_structured_cdc - source_cdc_merge - source_cdc_restatement - source_semistructured_cdc_merge - source_semistructured_cdc - metadata_cleanup_policy entity_id: type: string example: d2f33c1d424363162692b3bf entity_type: type: string enum: - source - pipeline - workflow sub_entity_id: type: string example: be034607444511f74313be63 sub_entity_type: type: string example: table_group duration: type: integer example: 349316 description: This is duration of the job. cluster_id: type: string example: j-134jnasdkjaasd description: Extenal clusterId compute_id: type: string example: be034607444511f74313be63 description: Infoworks compute cluster id compute_name: type: string example: Default_Persistent_cluster description: Infoworks compute name created_at: type: string format: date-time example: '2020-10-05T04:23:30.339Z' created_by: type: string example: 6RkfybTRQQByEey3v description: UserId of user who triggered the job. last_updated: type: string example: '2019-11-21T12:54:05.875Z' processed_at: type: string example: '2019-11-21T12:54:05.875Z' '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /admin/jobs/{job_id}/resubmit: parameters: - name: Content-Type in: header description: Http content type required: true schema: type: string enum: - application/json - multipart/form-data - text/plain default: application/json - name: job_id in: path description: Job Id required: true schema: type: string post: security: - BearerAuth: [] tags: - Jobs summary: Resubmit Failed tables for ingestion description: Resubmit Failed tables for ingestion responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: object properties: id: type: string example: e77850ad5127a2d7dab870ff '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /admin/jobs/{job_id}/logs: parameters: - name: job_id in: path description: Job Id required: true schema: type: string - name: num_lines in: query description: Number of lines of log required schema: type: integer default: 100 get: security: - BearerAuth: [] operationId: get_job_logs_admin tags: - Jobs summary: Get the job log as text stream with `job_id` description: Get the job log as text stream with `job_id` responses: '200': description: Ok. content: application/octet-stream: schema: type: string example: "[INFO] 2020-12-22 13:44:52,730 [main] io.infoworks.saas.ingestion.commons.utils.HeartBeatJob:24 :: Starting job for 5fe1f854e27e6d67b923f7c4\n [INFO] 2020-12-22 13:44:52,732 [main] io.infoworks.saas.ingestion.commons.utils.HeartbeatUpdater:30 :: Starting heartbeats thread\n [INFO] 2020-12-22 13:44:55,876 [main] io.infoworks.saas.ingestion.core.crawl.util.CrawlHelper:523 :: connector path :/opt/infoworks/lib/ingestion/connectors/mysql\n [INFO] 2020-12-22 13:44:55,876 [main] io.infoworks.saas.ingestion.core.crawl.util.CrawlHelper:526 :: Loading connector specific jars for :mysql\n [INFO] 2020-12-22 13:44:55,885 [main] io.infoworks.saas.ingestion.core.utils.ClassResolverFactory:214 :: Resolving connector class io.infoworks.connectors.rdbms.mysql.classresolver.ClassResolver\n [INFO] 2020-12-22 13:44:56,330 [main] io.infoworks.saas.ingestion.core.connectors.jdbc.sourcecrawler.AbstractJDBCSourceCrawler:83 :: Granted 1 connections\n [INFO] 2020-12-22 13:44:56,334 [main] io.infoworks.saas.ingestion.core.utils.ConnectionPool:24 :: Releasing 1 connections to pool\n [INFO] 2020-12-22 13:44:56,334 [main] io.infoworks.saas.ingestion.core.connectors.jdbc.sourcecrawler.AbstractJDBCSourceCrawler:83 :: Granted 1 connections\n [INFO] 2020-12-22 13:44:56,334 [main] io.infoworks.saas.ingestion.core.utils.ConnectionPool:24 :: Releasing 1 connections to pool\n [INFO] 2020-12-22 13:44:56,334 [main] io.infoworks.saas.ingestion.core.connectors.jdbc.sourcecrawler.AbstractJDBCSourceCrawler:83 :: Granted 1 connections\n [INFO] 2020-12-22 13:44:56,334 [main] io.infoworks.saas.ingestion.core.utils.ConnectionPool:24 :: Releasing 1 connections to pool\n [INFO] 2020-12-22 13:44:56,335 [main] io.infoworks.saas.ingestion.core.connectors.jdbc.sourcecrawler.AbstractJDBCSourceCrawler:83 :: Granted 1 connections\n [INFO] 2020-12-22 13:44:56,335 [main] io.infoworks.saas.ingestion.core.utils.ConnectionPool:24 :: Releasing 1 connections to pool\n [INFO] 2020-12-22 13:44:56,542 [pool-1-thread-1] io.infoworks.saas.ingestion.core.utils.ClassResolverFactory:214 :: Resolving connector class io.infoworks.connectors.rdbms.mysql.classresolver.ClassResolver\n [INFO] 2020-12-22 13:44:56,546 [pool-1-thread-4] io.infoworks.saas.ingestion.core.utils.ClassResolverFactory:214 :: Resolving connector class io.infoworks.connectors.rdbms.mysql.classresolver.ClassResolver\n [INFO] 2020-12-22 13:44:56,550 [pool-1-thread-2] io.infoworks.saas.ingestion.core.utils.ClassResolverFactory:214 :: Resolving connector class io.infoworks.connectors.rdbms.mysql.classresolver.ClassResolver\n [INFO] 2020-12-22 13:44:56,553 [pool-1-thread-3] io.infoworks.saas.ingestion.core.utils.ClassResolverFactory:214 :: Resolving connector class io.infoworks.connectors.rdbms.mysql.classresolver.ClassResolver\n [INFO] 2020-12-22 13:44:56,824 [pool-1-thread-4] io.infoworks.platform.metadb.core.sync.store.MongoDBMetaStore:37 :: Initializing mongodb meta store ...\n [INFO] 2020-12-22 13:44:56,892 [pool-1-thread-4] io.infoworks.platform.common.encryption.AES256:94 :: Attempting to decrypt data using AES-256\n" '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /admin/jobs/{job_id}/logs/download: parameters: - name: job_id in: path description: Job Id required: true schema: type: string get: security: - BearerAuth: [] tags: - Jobs summary: Download iw job logs zip for iw_job with job_id description: Download iw job logs zip for iw_job with `job_id` responses: '200': description: Ok. content: application/octet-stream: schema: type: string format: binary example: log_file_5fe1f854e27e6d67b923f7c4.zip '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /admin/jobs/{job_id}/runs: parameters: - name: job_id in: path description: Job Id required: true schema: type: string get: security: - BearerAuth: [] tags: - Jobs summary: Get cluster jobs for iw_job with job_id description: Get cluster jobs for iw_job with `job_id` responses: '200': description: Ok. content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - 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: result: type: object properties: id: type: string example: 8714887c9a8c5bb0b8794811 entity_id: type: string example: 8714887c9a8c5bb0b8794811 entity_type: type: string example: source entity_name: type: string example: jdbc_source sub_entity_type: type: string example: table sub_entity_id: type: string example: 8714887c9a8c5bb0b8794811 iw_job_id: type: string example: 8714887c9a8c5bb0b8794811 job_name: type: string example: table ingestion duration: type: integer example: 123414 percentage: type: integer format: int32 example: 90 type: type: string enum: - dataproc - databricks - local example: dataproc state: type: string enum: - PENDING - RUNNING - SKIPPED - TERMINATING - TERMINATED - INTERNAL_ERROR - DONE - NOT_RUNNING - CANCELED - STATE_UNSPECIFIED - SETUP_DONE - UNKNOWN - ERROR - CANCELED - CANCEL_STARTED - CANCEL_PENDING - ATTEMPT_FAILURE example: PENDING stages: type: object properties: stage: type: string example: start_cluster start_time: type: integer example: 1608637355 end_time: type: integer example: 1608737355 stage_status: type: string enum: - pending - running - completed - failed - canceled '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /admin/jobs/{job_id}/runs/{run_id}: parameters: - name: job_id in: path description: Job Id required: true schema: type: string - name: run_id in: path description: Cluster Job Run Id required: true schema: type: string get: security: - BearerAuth: [] tags: - Jobs summary: Get cluster job for iw_job with job_id and run_id description: Get cluster job for iw_job with `job_id` and `run_id` responses: '200': description: Ok. content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: object properties: id: type: string example: 8714887c9a8c5bb0b8794811 entity_id: type: string example: 8714887c9a8c5bb0b8794811 entity_type: type: string example: source entity_name: type: string example: jdbc_source sub_entity_type: type: string example: table sub_entity_id: type: string example: 8714887c9a8c5bb0b8794811 iw_job_id: type: string example: 8714887c9a8c5bb0b8794811 job_name: type: string example: table ingestion duration: type: integer example: 123414 percentage: type: integer format: int32 example: 90 type: type: string enum: - dataproc - databricks - local example: dataproc state: type: string enum: - PENDING - RUNNING - SKIPPED - TERMINATING - TERMINATED - INTERNAL_ERROR - DONE - NOT_RUNNING - CANCELED - STATE_UNSPECIFIED - SETUP_DONE - UNKNOWN - ERROR - CANCELED - CANCEL_STARTED - CANCEL_PENDING - ATTEMPT_FAILURE example: PENDING stages: type: object properties: stage: type: string example: start_cluster start_time: type: integer example: 1608637355 end_time: type: integer example: 1608737355 stage_status: type: string enum: - pending - running - completed - failed - canceled '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /admin/jobs/{job_id}/runs/{run_id}/logs: parameters: - name: job_id in: path description: Job Id required: true schema: type: string - name: run_id in: path description: Cluster Job Run Id required: true schema: type: string get: security: - BearerAuth: [] tags: - Jobs summary: Download cluster job logs zip for iw_job with job_id and run_id description: Download cluster job logs zip for iw_job with `job_id` and `run_id` responses: '200': description: Ok. content: application/octet-stream: schema: type: string format: binary example: log_file_5fe1f854e27e6d67b923f7c4.zip '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /admin/admin-jobs: get: security: - BearerAuth: [] operationId: Get-admin-jobs tags: - Jobs summary: Get the admin-jobs details description: Get the admin-jobs details responses: '200': description: Ok. content: application/json: schema: allOf: - type: object properties: limit: type: integer example: 10 offset: type: integer example: 0 links: type: object properties: base: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains} self: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0 next: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10 total_count: type: integer example: 10 x-examples: example-1: {} - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: array items: allOf: - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - properties: build_id: type: integer example: 2 - properties: status: type: string example: completed - properties: percentage: type: integer example: 100 - properties: type: type: string example: source_semistructured_cdc_merge duration: type: integer example: 31424 - type: object properties: created_at: type: string example: '2019-11-21T12:54:05.875Z' - type: object properties: created_by: type: string example: 6RkfybTRQQByEey3v '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /sources/{source_id}/jobs: 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: - Jobs summary: Get List of All jobs of this Source and it's artifacts. description: Get List of All jobs of this Source and it's artifacts. parameters: - name: filter in: query description: Filter results query schema: type: string - name: limit in: query description: The numbers of items to return schema: type: integer default: 10 - name: sort_by in: query description: Sort result on field schema: type: string - name: offset in: query description: The number of items to skip before starting to collect the result set schema: type: integer default: 0 - name: order_by in: query description: order ascending | descending schema: type: string default: asc enum: - asc - desc responses: '200': description: Ok. 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: result: type: array items: type: object properties: id: type: string example: 8714887c9a8c5bb0b8794811 build_id: type: integer example: 2 name: type: string example: test_job status: type: string enum: - completed - pending - aborted - blocked - failed - running - canceled - succeeded example: completed percentage: type: integer example: 100 type: type: string enum: - source_test_connection - fetch_metadata - source_structured_fetch_metadata - source_crawl - source_crawl_chunk_load - source_cdc - source_unstructured_crawl - source_structured_crawl - source_semistructured_crawl - delete_entity - pipeline_metadata - pipeline_build - pipeline_build_restatement - full_load - cdc - source_merge - source_structured_cdc_merge - source_structured_cdc - source_cdc_merge - source_cdc_restatement - source_semistructured_cdc_merge - source_semistructured_cdc - metadata_cleanup_policy entity_id: type: string example: d2f33c1d424363162692b3bf entity_type: type: string enum: - source - pipeline - workflow sub_entity_id: type: string example: be034607444511f74313be63 sub_entity_type: type: string example: table_group duration: type: integer example: 349316 description: This is duration of the job. cluster_id: type: string example: j-134jnasdkjaasd description: Extenal clusterId compute_id: type: string example: be034607444511f74313be63 description: Infoworks compute cluster id compute_name: type: string example: Default_Persistent_cluster description: Infoworks compute name created_at: type: string format: date-time example: '2020-10-05T04:23:30.339Z' created_by: type: string example: 6RkfybTRQQByEey3v description: UserId of user who triggered the job. last_updated: type: string example: '2019-11-21T12:54:05.875Z' processed_at: type: string example: '2019-11-21T12:54:05.875Z' '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 post: security: - BearerAuth: [] tags: - Jobs summary: Initiates jobs for source and its artifacts description: Initiates jobs for source and its artifacts. The job types that can be submitted are `export_data`, `streaming_start`, `segmentation_load`, `truncate_reload`, `cdc_merge`, `cdc_restatement`, `truncate_table`, `source_test_connection`, `source_fetch_metadata`, `table_fetch_metadata`. operationId: createJobForSource requestBody: description: '' content: application/json: schema: oneOf: - title: DeleteEntityJobRequestSchema type: object required: - job_type properties: job_type: type: string enum: - source_delete example: source_delete purge_metadata: type: boolean example: true - title: TruncateTableJobRequestSchema type: object required: - job_type - table_ids properties: job_type: type: string enum: - truncate_table example: truncate_table table_ids: type: array items: type: string example: 5f0754885406f51f04a85293 - title: IngestionJobRequestSchema type: object required: - job_type - job_name - table_ids - compute_template_id - min_worker_nodes - max_worker_nodes - max_parallel_entities properties: job_type: type: string enum: - truncate_reload - cdc_merge - cdc_restatement example: truncate_reload job_name: type: string example: test_job description: required in case job is triggered for tables table_group_id: type: string example: 5f0754885406f51f04a85293 description: table_group_id is required if no table_ids are provided table_ids: description: required if no table_group_id is provided type: array items: type: string example: 5f0754885406f51f04a85293 max_connections: type: integer example: 7 max_parallel_entities: type: integer example: 2 cluster_template_id: type: string example: 5f0754885406f51f04a85293 interactive_cluster_id: type: string example: 7d3652565406f51e34a85125 warehouse: type: string example: DEMO_WH custom_tags: type: string example: tag num_worker_nodes: type: number example: 3 min_worker_nodes: type: number example: 2 max_worker_nodes: type: number example: 4 query_tag: type: string example: querytag - title: SourceTestConnectionJobRequestSchema type: object required: - job_type properties: job_type: type: string enum: - source_test_connection example: source_test_connection - title: SourceFetchMetadataJobRequestSchema type: object required: - job_type - table_ids properties: job_type: type: string enum: - source_fetch_metadata example: source_fetch_metadata overwrite: type: boolean example: true table_ids: type: array items: type: string example: 5f0754885406f51f04a85293 - title: TableMetadataCrawlJobForCSVSourceSchema type: object required: - job_type - table_id properties: job_type: type: string enum: - table_fetch_metadata example: table_fetch_metadata table_id: type: string example: 5f0754885406f51f04a85293 source_file_properties: type: object properties: header_rows_count: type: integer format: int32 example: 1 column_separator: type: string example: null column_enclosed_by: type: string example: null escape_character: type: string example: \ encoding: type: string example: UTF-8 enable_pk_chunk: type: boolean example: true record_width_type: type: string example: UTF-8 record_separator: type: string example: ',' columns_configurations: type: object properties: column_width: type: number example: 20 - title: StreamingJobRequestSchema type: object required: - job_type - table_ids - compute_template_id - min_worker_nodes - max_worker_nodes properties: job_type: type: string enum: - streaming_start example: streaming_start table_id: type: string example: 5f0754885406f51f04a85293 compute_template_id: type: string example: 5f0754885406f51f04a85293 interactive_cluster_id: type: string example: 5f0754885406f51f04a85293 warehouse: type: string example: DEMO_WH custom_tags: type: array items: type: string example: tag1 num_worker_nodes: type: number example: 3 min_worker_nodes: type: number example: 2 max_worker_nodes: type: number example: 4 - title: SegmentationJobRequestSchema type: object required: - job_type - job_name - table_id - compute_template_id - segment_ids - max_connections - max_parallel_entities - min_worker_nodes - max_worker_nodes properties: job_type: type: string enum: - segmentation_load example: segmentation_load job_name: type: string example: test_job description: required in case job is triggered for tables max_connections: type: integer example: 7 max_parallel_entities: type: integer example: 2 cluster_template_id: type: string example: 5f0754885406f51f04a85293 interactive_cluster_id: type: string example: 7d3652565406f51e34a85125 warehouse: type: string example: DEMO_WH custom_tags: type: array items: type: string example: tag1 num_worker_nodes: type: number example: 3 min_worker_nodes: type: number example: 2 max_worker_nodes: type: number example: 4 table_id: type: string example: 7d3652234406f51f34b42125 segment_ids: type: string items: type: string example: 4e3626534412f51f34b42111 run_segments_in_single_job: type: boolean example: true - title: ExportTableDataJobRequestSchema type: object required: - job_type - job_name - table_ids - num_worker_nodes - compute_template_id properties: job_type: type: string enum: - export_data example: export_data job_name: type: string example: export1 compute_template_id: type: string example: 5f0754885406f51f04a85293 interactive_cluster_id: type: string example: 5f0754885406f51f04a85293 warehouse: type: string example: DEMO_WH custom_tags: type: array items: type: string example: tag1 num_worker_nodes: type: number example: 3 min_worker_nodes: type: number example: 2 max_worker_nodes: type: number example: 4 - title: SourceCDCRestatementJobRequestSchema type: object required: - job_type - job_name - table_ids - runtime_configurations properties: job_type: type: string enum: - cdc_restatement example: cdc_restatement job_name: type: string example: source_cdc_restatement_job compute_template_id: type: string example: 5f0754885406f51f04a85293 interactive_cluster_id: type: string example: 5f0754885406f51f04a85293 warehouse: type: string example: DEMO_WH custom_tags: type: array items: type: string example: tag1 num_worker_nodes: type: number example: 3 min_worker_nodes: type: number example: 2 max_worker_nodes: type: number example: 4 max_connections: type: integer example: 1 max_parallel_entities: type: integer example: 1 query_tag: type: string example: table_group_tag runtime_configurations: type: array items: type: object required: - table_id - watermark_lower_limit properties: table_id: type: string example: 5f0754885406f51f04a85293 watermark_lower_limit: type: string example: '2024-03-29 06:18:31.79' watermark_upper_limit: type: string default: $(MAX(WATERMARK_COLUMN(S))) required: false 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: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /sources/{source_id}/jobs/{job_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: job_id in: path description: Job Id required: true schema: type: string get: security: - BearerAuth: [] tags: - Jobs summary: Get job with job id. description: Get job with job id. responses: '200': description: Ok. content: application/json: schema: type: object properties: result: type: object properties: id: type: string example: 8714887c9a8c5bb0b8794811 build_id: type: integer example: 2 name: type: string example: test_job status: type: string enum: - completed - pending - aborted - blocked - failed - running - canceled - succeeded example: completed percentage: type: integer example: 100 type: type: string enum: - source_test_connection - fetch_metadata - source_structured_fetch_metadata - source_crawl - source_crawl_chunk_load - source_cdc - source_unstructured_crawl - source_structured_crawl - source_semistructured_crawl - delete_entity - pipeline_metadata - pipeline_build - pipeline_build_restatement - full_load - cdc - source_merge - source_structured_cdc_merge - source_structured_cdc - source_cdc_merge - source_cdc_restatement - source_semistructured_cdc_merge - source_semistructured_cdc - metadata_cleanup_policy entity_id: type: string example: d2f33c1d424363162692b3bf entity_type: type: string enum: - source - pipeline - workflow sub_entity_id: type: string example: be034607444511f74313be63 sub_entity_type: type: string example: table_group duration: type: integer example: 349316 description: This is duration of the job. cluster_id: type: string example: j-134jnasdkjaasd description: Extenal clusterId compute_id: type: string example: be034607444511f74313be63 description: Infoworks compute cluster id compute_name: type: string example: Default_Persistent_cluster description: Infoworks compute name created_at: type: string format: date-time example: '2020-10-05T04:23:30.339Z' created_by: type: string example: 6RkfybTRQQByEey3v description: UserId of user who triggered the job. last_updated: type: string example: '2019-11-21T12:54:05.875Z' processed_at: type: string example: '2019-11-21T12:54:05.875Z' '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}/jobs/{job_id}/resubmit: 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: job_id in: path description: Job Id required: true schema: type: string post: security: - BearerAuth: [] tags: - Jobs summary: Resubmit Failed tables for ingestion description: Resubmit Failed tables for ingestion responses: '200': description: Success content: application/json: schema: type: object properties: result: type: object properties: status: type: string example: success id: type: string '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /sources/{source_id}/jobs/{job_id}/summary: 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: job_id in: path description: Job Id required: true schema: type: string get: security: - BearerAuth: [] tags: - Jobs summary: Get crawl job info. description: Get crawl job info. responses: '200': description: Ok. 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 - properties: result: type: array items: type: object properties: message: type: string example: Starting To Execute Job for table abcd timestamp: type: string example: '2019-11-21T12:54:05.875Z' '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}/jobs/{job_id}/logs: parameters: - name: Content-Type in: header description: Http content type required: true schema: type: string - name: source_id in: path description: Source Id. required: true schema: type: string - name: job_id in: path description: Job Id required: true schema: type: string get: security: - BearerAuth: [] tags: - Jobs summary: Get Summary Logs for the Source Crawl Job. description: Get Summary Logs for the Source Crawl Job. parameters: - in: query name: num_lines schema: type: integer example: 50 responses: '200': description: Ok. content: text/plain: schema: type: string '400': description: Bad Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '401': description: Unauthorized Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '403': description: Forbidden Access content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '500': description: Internal Server Error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 /sources/{source_id}/jobs/{job_id}/logs/download: 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: job_id in: path description: Job Id required: true schema: type: string get: security: - BearerAuth: [] tags: - Jobs summary: Get Summary Logs for the Source Crawl Job. description: Get Summary Logs for the Source Crawl Job. responses: '200': description: Ok. content: application/zip: schema: type: string format: binary '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/reports/jobs/ingestion-metrics: 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: - Jobs summary: Get List of All jobs of this Source and it's artifacts. description: Get List of All jobs of this Source and it's artifacts. parameters: - name: filter in: query description: Filter results query schema: type: string - name: limit in: query description: The numbers of items to return schema: type: integer default: 10 - name: sort_by in: query description: Sort result on field schema: type: string - name: offset in: query description: The number of items to skip before starting to collect the result set schema: type: integer default: 0 - name: order_by in: query description: order ascending | descending schema: type: string default: asc enum: - asc - desc responses: '200': description: Ok. 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: result: type: array items: type: object properties: id: type: string example: 8714887c9a8c5bb0b8794811 build_id: type: integer example: 2 name: type: string example: test_job status: type: string enum: - completed - pending - aborted - blocked - failed - running - canceled - succeeded example: completed percentage: type: integer example: 100 type: type: string enum: - source_test_connection - fetch_metadata - source_structured_fetch_metadata - source_crawl - source_crawl_chunk_load - source_cdc - source_unstructured_crawl - source_structured_crawl - source_semistructured_crawl - delete_entity - pipeline_metadata - pipeline_build - pipeline_build_restatement - full_load - cdc - source_merge - source_structured_cdc_merge - source_structured_cdc - source_cdc_merge - source_cdc_restatement - source_semistructured_cdc_merge - source_semistructured_cdc - metadata_cleanup_policy entity_id: type: string example: d2f33c1d424363162692b3bf entity_type: type: string enum: - source - pipeline - workflow sub_entity_id: type: string example: be034607444511f74313be63 sub_entity_type: type: string example: table_group duration: type: integer example: 349316 description: This is duration of the job. cluster_id: type: string example: j-134jnasdkjaasd description: Extenal clusterId compute_id: type: string example: be034607444511f74313be63 description: Infoworks compute cluster id compute_name: type: string example: Default_Persistent_cluster description: Infoworks compute name created_at: type: string format: date-time example: '2020-10-05T04:23:30.339Z' created_by: type: string example: 6RkfybTRQQByEey3v description: UserId of user who triggered the job. last_updated: type: string example: '2019-11-21T12:54:05.875Z' processed_at: type: string example: '2019-11-21T12:54:05.875Z' '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /sources/{source_id}/interactive-jobs: parameters: - name: source_id in: path description: Source Id. required: true schema: type: string - name: limit in: query description: The numbers of items to return schema: type: integer default: 10 - name: sort_by in: query description: Sort result on field schema: type: string - name: order_by in: query description: order ascending | descending schema: type: string default: asc enum: - asc - desc - name: filter in: query description: Filter results query schema: type: string get: security: - BearerAuth: [] operationId: getInteractiveJobs tags: - Jobs summary: Get Interactive Jobs List responses: '200': description: Ok. 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: result: type: array items: type: object properties: id: type: string example: d57850ad5127a2d7dab870ff type: type: string enum: - sampledata - table_preview - query_table_preview - segment_load - file_preview - metacrawl - fetch_topics - browse_source example: file_preview status: type: string enum: - created - submitted - running - failed - completed example: completed source_id: type: string example: e77850ad5127a2d7dab870ff message: type: string example: job success created_at: type: string example: '2019-11-21T12:54:05.875Z' duration: type: number example: 134234 entity_name: type: string example: My Source entity_type: type: string enum: - source - table - file_mapping - topic_mapping entity_id: type: string example: e77850ad5127a2d7dab870ff '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /sources/{source_id}/interactive-jobs/{interactive_job_id}: parameters: - name: source_id in: path description: Source Id. required: true schema: type: string - name: interactive_job_id in: path description: Interactive job id. required: true schema: type: string get: security: - BearerAuth: [] operationId: getInteractiveJob tags: - Jobs summary: Get Interactive Job by id responses: '200': description: Ok. content: application/json: schema: allOf: - type: object properties: result: type: object properties: id: type: string example: d57850ad5127a2d7dab870ff type: type: string enum: - sampledata - table_preview - query_table_preview - segment_load - file_preview - metacrawl - fetch_topics - browse_source example: file_preview status: type: string enum: - created - submitted - running - failed - completed example: completed source_id: type: string example: e77850ad5127a2d7dab870ff message: type: string example: job success created_at: type: string example: '2019-11-21T12:54:05.875Z' duration: type: number example: 134234 entity_name: type: string example: My Source entity_type: type: string enum: - source - table - file_mapping - topic_mapping entity_id: type: string example: e77850ad5127a2d7dab870ff '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 patch: security: - BearerAuth: [] tags: - Jobs summary: Update the job status for Interactive Job description: Update the job status to failed for Interactive jobs responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /sources/{source_id}/interactive-jobs/{interactive_job_id}/logs/download: parameters: - name: source_id in: path description: Source Id. required: true schema: type: string - name: interactive_job_id in: path description: Interactive job id. required: true schema: type: string get: security: - BearerAuth: [] operationId: downloadInteractiveJobLogsForSource tags: - Jobs summary: Download Logs for Interactive Job description: Downloads the dataplane logs for the source interactive job. responses: '200': description: Ok. content: application/zip: schema: type: string format: binary '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}/jobs_for_source_job_type: parameters: - name: source_id in: path description: Source Id. required: true schema: type: string get: security: - BearerAuth: [] tags: - Jobs summary: Gets Jobs Model for a Source. description: Gets Jobs Model for a Source. parameters: - name: offset in: query description: The number of items to skip before starting to collect the result set schema: type: integer default: 0 - name: limit in: query description: The numbers of items to return schema: type: integer default: 10 - name: sort_by in: query description: Sort result on field schema: type: string - name: order_by in: query description: order ascending | descending schema: type: string default: asc enum: - asc - desc - name: filter in: query description: Filter results query schema: type: string responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: limit: type: integer example: 10 offset: type: integer example: 0 links: type: object properties: base: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains} self: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0 next: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10 total_count: type: integer example: 10 x-examples: example-1: {} - type: object properties: message: type: string example: Example Success Message - type: object properties: result: allOf: - type: object properties: source: type: string example: e77850ad5127a2d7dab870ff last_ingested_cdc_value: type: string example: null full_load_performed: type: boolean example: false description: type: string example: example description tags: type: array items: example: c54t456f6d5a2c4564aed schema_name_at_source: type: string example: dummy topic_mapping_id: type: string example: e77850ad5127a2d7dab870ff configuration: type: object allOf: - properties: json_schema: type: array items: type: object properties: key: type: integer example: 1 name: type: string example: del properties: type: object properties: sql_type: type: integer example: 1 target_sql_type: type: integer example: 1 type: type: string example: struct json_schema_breadcrumb: type: array items: properties: selected: type: boolean example: true name: type: string json_schema_node_key: type: integer example: 0 crawl_data_filter_enabled: type: boolean example: false crawl_filter_conditions: type: array items: example: '' max_num_of_records: type: integer example: 20000 streaming_mode: type: string example: micro_batch streaming_frequency_type: type: string example: secs streaming_frequency_number: type: integer example: 10 error_threshold: type: integer example: 5 source_file_type: type: string example: kafka natural_keys: type: array items: type: string partition_keys: type: array items: type: string target_relative_path: type: string example: abch update_strategy: type: string example: append write_supported_engines: type: array items: type: string example: SPARK read_supported_engines: type: array items: type: string example: SPARK target_table_name: type: string storage_format: type: string target_schema_name: type: string sync_type: type: string example: incremental - type: object properties: id: type: string format: hexadecimal name: type: string original_table_name: type: string topic_mapping_name: type: string file_mapping_name: type: string data_lake_schema: type: string example: kafka data_lake_path: type: string example: /iw/kafka-source meta_crawl_performed: type: boolean columns: type: array items: type: object properties: sql_type: type: integer example: 4 name: type: string example: id original_name: type: string example: id target_sql_type: type: integer example: 4 json_schema_node_key: type: integer example: 4 is_mixed_element_text_content: type: boolean example: false is_recursive_data_text_content: type: boolean example: false is_excluded_column: type: boolean example: true type: array items: allOf: - type: object properties: id: type: string status: type: string queue_info: type: string params: type: object properties: connection: type: object properties: driver_name: type: string driver_version: type: string database: type: string connection_method: type: string connection_string: type: string password: type: object properties: password_type: type: string secret_id: type: string username: type: string entityId: type: string error: type: string '400': description: Bad Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '401': description: Unauthorized Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '403': description: Forbidden Access content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '500': description: Internal Server Error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 /domains/{domain_id}/pipelines/{pipeline_id}/jobs: parameters: - name: domain_id in: path required: true schema: type: string - name: pipeline_id in: path required: true schema: type: string - name: Content-Type in: header description: Http content type required: true schema: type: string enum: - application/json - multipart/form-data - text/plain default: application/json get: security: - BearerAuth: [] operationId: getJobs_1 tags: - Jobs summary: Gets List of Pipeline Jobs. description: Gets List of Pipeline Jobs. parameters: - name: filter in: query description: Filter results query schema: type: string - name: limit in: query description: The numbers of items to return schema: type: integer default: 10 - name: sort_by in: query description: Sort result on field schema: type: string - name: offset in: query description: The number of items to skip before starting to collect the result set schema: type: integer default: 0 - name: order_by in: query description: order ascending | descending schema: type: string default: asc enum: - asc - desc responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: limit: type: integer example: 10 offset: type: integer example: 0 links: type: object properties: base: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains} self: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0 next: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10 total_count: type: integer example: 10 x-examples: example-1: {} - type: object properties: result: type: array items: type: object properties: id: type: string example: 8714887c9a8c5bb0b8794811 build_id: type: integer example: 2 name: type: string example: test_job status: type: string enum: - completed - pending - aborted - blocked - failed - running - canceled - succeeded example: completed percentage: type: integer example: 100 type: type: string enum: - source_test_connection - fetch_metadata - source_structured_fetch_metadata - source_crawl - source_crawl_chunk_load - source_cdc - source_unstructured_crawl - source_structured_crawl - source_semistructured_crawl - delete_entity - pipeline_metadata - pipeline_build - pipeline_build_restatement - full_load - cdc - source_merge - source_structured_cdc_merge - source_structured_cdc - source_cdc_merge - source_cdc_restatement - source_semistructured_cdc_merge - source_semistructured_cdc - metadata_cleanup_policy entity_id: type: string example: d2f33c1d424363162692b3bf entity_type: type: string enum: - source - pipeline - workflow sub_entity_id: type: string example: be034607444511f74313be63 sub_entity_type: type: string example: table_group duration: type: integer example: 349316 description: This is duration of the job. cluster_id: type: string example: j-134jnasdkjaasd description: Extenal clusterId compute_id: type: string example: be034607444511f74313be63 description: Infoworks compute cluster id compute_name: type: string example: Default_Persistent_cluster description: Infoworks compute name created_at: type: string format: date-time example: '2020-10-05T04:23:30.339Z' created_by: type: string example: 6RkfybTRQQByEey3v description: UserId of user who triggered the job. last_updated: type: string example: '2019-11-21T12:54:05.875Z' processed_at: type: string example: '2019-11-21T12:54:05.875Z' '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 post: security: - BearerAuth: [] operationId: submitJob_2 tags: - Jobs summary: Submit Pipeline Job. description: Submit Pipeline Job. requestBody: content: application/json: schema: oneOf: - type: object properties: job_type: type: string enum: - pipeline_build - pipeline_metadata example: pipeline_build version_id: type: string example: 5fd5c5f7e27e6d34cf0660b8 description: if not provided it will build pipeline with active version_id updated_pipeline_parameters: type: array items: type: object properties: key: type: string example: param_key value: type: string example: param_value - type: object title: PipelineBuildRestatementJobRequestModel properties: job_type: type: string enum: - pipeline_build_restatement example: pipeline_build_restatement version_id: type: string example: 5fd5c5f7e27e6d34cf0660b8 description: if not provided it will build pipeline with active version_id updated_pipeline_parameters: type: array items: type: object properties: key: type: string example: param_key value: type: string example: param_value runtime_configurations: type: array items: type: object required: - table_id properties: table_id: type: string example: 5f0754885406f51f04a85293 watermark_lower_limit: type: string default: $(LAST_RUN_HIGH_WATERMARK) watermark_upper_limit: type: string default: $(INGESTION_LAST_MERGED_WATERMARK) - title: DeleteEntityJobRequestSchema type: object required: - job_type properties: job_type: type: string enum: - source_delete example: source_delete purge_metadata: type: boolean example: true responses: '200': description: Success content: application/json: schema: type: object properties: message: type: string example: Pipeline Build Job submitted successfully result: type: object properties: id: type: string example: 5fd5c5f7e27e6d34cf0660b8 '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /domains/{domain_id}/pipelines/{pipeline_id}/jobs/{job_id}: parameters: - name: domain_id in: path required: true schema: type: string - name: pipeline_id in: path required: true schema: type: string - name: Content-Type in: header description: Http content type required: true schema: type: string enum: - application/json - multipart/form-data - text/plain default: application/json - name: job_id in: path description: Job Id required: true schema: type: string get: security: - BearerAuth: [] operationId: getJobs tags: - Jobs summary: Gets Pipeline Job. description: Gets Pipeline Job. responses: '200': description: Success content: application/json: schema: type: object properties: id: type: string example: 8714887c9a8c5bb0b8794811 build_id: type: integer example: 2 name: type: string example: test_job status: type: string enum: - completed - pending - aborted - blocked - failed - running - canceled - succeeded example: completed percentage: type: integer example: 100 type: type: string enum: - source_test_connection - fetch_metadata - source_structured_fetch_metadata - source_crawl - source_crawl_chunk_load - source_cdc - source_unstructured_crawl - source_structured_crawl - source_semistructured_crawl - delete_entity - pipeline_metadata - pipeline_build - pipeline_build_restatement - full_load - cdc - source_merge - source_structured_cdc_merge - source_structured_cdc - source_cdc_merge - source_cdc_restatement - source_semistructured_cdc_merge - source_semistructured_cdc - metadata_cleanup_policy entity_id: type: string example: d2f33c1d424363162692b3bf entity_type: type: string enum: - source - pipeline - workflow sub_entity_id: type: string example: be034607444511f74313be63 sub_entity_type: type: string example: table_group duration: type: integer example: 349316 description: This is duration of the job. cluster_id: type: string example: j-134jnasdkjaasd description: Extenal clusterId compute_id: type: string example: be034607444511f74313be63 description: Infoworks compute cluster id compute_name: type: string example: Default_Persistent_cluster description: Infoworks compute name created_at: type: string format: date-time example: '2020-10-05T04:23:30.339Z' created_by: type: string example: 6RkfybTRQQByEey3v description: UserId of user who triggered the job. last_updated: type: string example: '2019-11-21T12:54:05.875Z' processed_at: type: string example: '2019-11-21T12:54:05.875Z' '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /domains/{domain_id}/pipelines/{pipeline_id}/version/{pipeline_version_id}/jobs: parameters: - name: pipeline_version_id in: path description: pipeline_version_id as HEX string required: true schema: type: string - name: domain_id in: path required: true schema: type: string - name: pipeline_id in: path required: true schema: type: string - name: Content-Type in: header description: Http content type required: true schema: type: string enum: - application/json - multipart/form-data - text/plain default: application/json post: security: - BearerAuth: [] operationId: submitJob_3 tags: - Jobs summary: Submit Pipeline Job. description: Submit Pipeline Job. requestBody: content: application/json: schema: type: object properties: job_type: type: string enum: - pipeline_build - pipeline_metadata example: pipeline_build version_id: type: string example: 5fd5c5f7e27e6d34cf0660b8 description: if not provided it will build pipeline with active version_id updated_pipeline_parameters: type: array items: type: object properties: key: type: string example: param_key value: type: string example: param_value responses: '200': description: Success content: application/json: schema: type: object properties: message: type: string example: Pipeline Build Job submitted successfully result: type: object properties: id: type: string example: 5fd5c5f7e27e6d34cf0660b8 '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /prodops/jobs: post: security: - BearerAuth: [] operationId: getJobsForProdOps tags: - Jobs summary: Get the jobs details description: Get the jobs details (This operation is only for `operations_analyst` user) requestBody: content: application/json: schema: type: object required: - date_range properties: date_range: oneOf: - type: object required: - type - unit - value properties: type: type: string example: last unit: type: string enum: - day - hour example: day value: type: integer example: 6 - type: object required: - type - start_date - end_date properties: type: type: string example: custom start_date: type: integer example: 1652355912000 end_date: type: integer example: 1652355912000 order_by: type: string enum: - asc - desc minLength: 1 example: asc default: desc sort_by: type: string example: createdAt minLength: 1 offset: type: integer example: 5 minimum: 0 limit: type: integer example: 10 default: 20 minimum: -1 run_time_hour: type: integer example: 0.2 minimum: 0 default: Infinity domain_ids: type: array items: type: string example: e77850ad5127a2d7dab870ff source_ids: type: array items: type: string example: e77850ad5127a2d7dab870ff job_types: type: array items: type: string enum: - source_test_connection - fetch_metadata - source_structured_fetch_metadata - source_crawl - source_crawl_chunk_load - source_cdc - dictionary_crawl - source_unstructured_crawl - source_structured_crawl - source_semistructured_crawl - delete_entity - generate_sample - pipeline_metadata - pipeline_build - full_load - cdc - source_merge - source_structured_cdc_merge - source_structured_cdc - source_cdc_merge - source_cdc_restatement - source_semistructured_cdc_merge - source_semistructured_cdc - metadata_cleanup_policy - metadata_backup - export_data entity_type: type: string minLength: 1 example: source enum: - pipeline - source status: type: string minLength: 1 items: type: string enum: - pending - aborted - blocked - failed - running - canceled - completed - succeeded - toprocess - terminated additional_filters: type: object example: _id: $in: - $oid: 2154859ca27ec87b09f39303 responses: '200': description: Ok. content: application/json: schema: allOf: - type: object properties: limit: type: integer example: 10 offset: type: integer example: 0 links: type: object properties: base: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains} self: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0 next: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10 total_count: type: integer example: 10 x-examples: example-1: {} - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: array items: type: object properties: id: type: string example: 8714887c9a8c5bb0b8794811 build_id: type: integer example: 2 name: type: string example: test_job status: type: string enum: - completed - pending - aborted - blocked - failed - running - canceled - succeeded example: completed percentage: type: integer example: 100 type: type: string enum: - source_test_connection - fetch_metadata - source_structured_fetch_metadata - source_crawl - source_crawl_chunk_load - source_cdc - source_unstructured_crawl - source_structured_crawl - source_semistructured_crawl - delete_entity - pipeline_metadata - pipeline_build - pipeline_build_restatement - full_load - cdc - source_merge - source_structured_cdc_merge - source_structured_cdc - source_cdc_merge - source_cdc_restatement - source_semistructured_cdc_merge - source_semistructured_cdc - metadata_cleanup_policy entity_id: type: string example: d2f33c1d424363162692b3bf entity_type: type: string enum: - source - pipeline - workflow sub_entity_id: type: string example: be034607444511f74313be63 sub_entity_type: type: string example: table_group duration: type: integer example: 349316 description: This is duration of the job. cluster_id: type: string example: j-134jnasdkjaasd description: Extenal clusterId compute_id: type: string example: be034607444511f74313be63 description: Infoworks compute cluster id compute_name: type: string example: Default_Persistent_cluster description: Infoworks compute name created_at: type: string format: date-time example: '2020-10-05T04:23:30.339Z' created_by: type: string example: 6RkfybTRQQByEey3v description: UserId of user who triggered the job. last_updated: type: string example: '2019-11-21T12:54:05.875Z' processed_at: type: string example: '2019-11-21T12:54:05.875Z' '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /prodops/jobs/{job_id}: parameters: - name: job_id in: path description: Job Id required: true schema: type: string get: security: - BearerAuth: [] operationId: getJobsWithIdForProdOps tags: - Jobs summary: Get the job details with `job_id` description: Get the job details with `job_id` (This operation is only for `operations_analyst` user) responses: '200': description: Ok. content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: object properties: id: type: string example: 8714887c9a8c5bb0b8794811 build_id: type: integer example: 2 name: type: string example: test_job status: type: string enum: - completed - pending - aborted - blocked - failed - running - canceled - succeeded example: completed percentage: type: integer example: 100 type: type: string enum: - source_test_connection - fetch_metadata - source_structured_fetch_metadata - source_crawl - source_crawl_chunk_load - source_cdc - source_unstructured_crawl - source_structured_crawl - source_semistructured_crawl - delete_entity - pipeline_metadata - pipeline_build - pipeline_build_restatement - full_load - cdc - source_merge - source_structured_cdc_merge - source_structured_cdc - source_cdc_merge - source_cdc_restatement - source_semistructured_cdc_merge - source_semistructured_cdc - metadata_cleanup_policy entity_id: type: string example: d2f33c1d424363162692b3bf entity_type: type: string enum: - source - pipeline - workflow sub_entity_id: type: string example: be034607444511f74313be63 sub_entity_type: type: string example: table_group duration: type: integer example: 349316 description: This is duration of the job. cluster_id: type: string example: j-134jnasdkjaasd description: Extenal clusterId compute_id: type: string example: be034607444511f74313be63 description: Infoworks compute cluster id compute_name: type: string example: Default_Persistent_cluster description: Infoworks compute name created_at: type: string format: date-time example: '2020-10-05T04:23:30.339Z' created_by: type: string example: 6RkfybTRQQByEey3v description: UserId of user who triggered the job. last_updated: type: string example: '2019-11-21T12:54:05.875Z' processed_at: type: string example: '2019-11-21T12:54:05.875Z' '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /prodops/jobs/{job_id}/cancel: parameters: - name: job_id in: path description: Job Id required: true schema: type: string get: security: - BearerAuth: [] operationId: cancelJobByIdForProdOps tags: - Jobs summary: Cancel the job with `job_id` description: Cancel the job with `job_id` (This operation is only for `operations_analyst` user) responses: '200': description: Ok. content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /prodops/jobs/{job_id}/resubmit: parameters: - name: Content-Type in: header description: Http content type required: true schema: type: string enum: - application/json - multipart/form-data - text/plain default: application/json - name: job_id in: path description: Job Id required: true schema: type: string get: security: - BearerAuth: [] tags: - Jobs summary: Resubmit Failed tables for ingestion description: Resubmit Failed tables for ingestion (This operation is only for `operations_analyst` user) responses: '200': description: Success content: application/json: schema: type: object properties: result: type: object properties: status: type: string example: success id: type: string '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/jobs: parameters: - name: domain_id in: path required: true schema: type: string - name: pipeline_group_id in: path description: pipeline_group_id required: true schema: type: string get: security: - BearerAuth: [] operationId: getPipelineGroupsJobs_1 tags: - Jobs summary: Gets List of Pipeline Jobs. description: Gets List of Pipeline Jobs. parameters: - name: domain_id in: path required: true schema: type: string - name: Content-Type in: header description: Http content type required: true schema: type: string enum: - application/json - multipart/form-data - text/plain default: application/json - name: filter in: query description: Filter results query schema: type: string - name: limit in: query description: The numbers of items to return schema: type: integer default: 10 - name: sort_by in: query description: Sort result on field schema: type: string - name: offset in: query description: The number of items to skip before starting to collect the result set schema: type: integer default: 0 - name: order_by in: query description: order ascending | descending schema: type: string default: asc enum: - asc - desc responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: limit: type: integer example: 10 offset: type: integer example: 0 links: type: object properties: base: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains} self: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0 next: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10 total_count: type: integer example: 10 x-examples: example-1: {} - type: object properties: message: type: string example: List of Jobs - type: object properties: result: type: array items: type: object properties: id: type: string example: 63cd71df9f1c1e258c6e991b type: type: string example: pipeline-group-build status: type: string example: completed percentage: type: number example: 100 duration: type: number example: 19134 created_at: type: string example: '2023-01-22T17:26:55.895Z' created_by: type: string example: 6RkfybTRQQByEey3v last_updated: type: string example: '2023-01-22T17:26:55.895Z' processed_at: type: string example: '2023-01-22T17:26:55.895Z' entity_type: type: string example: pipeline-group entity_id: type: string example: 63cd71df9f1c1e258c6e991b triggered_by: type: object properties: parent: type: string example: null client_host_id: type: string example: null user_id: type: string example: null custom_tags: type: array items: type: object properties: key: type: string example: null value: type: string example: null build_started_at: type: string example: null build_ended_at: type: string example: null cluster_id: type: string example: null queue_info: type: string example: null job_list: type: array items: type: string example: null domain_id: type: string example: null '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 post: security: - BearerAuth: [] operationId: submitPipelineGroupJob_2 tags: - Jobs summary: Submit Pipeline Job. description: Submit Pipeline Job. requestBody: content: application/json: schema: oneOf: - type: object properties: job_type: type: string enum: - pipeline_group_build example: pipeline_group_build responses: '200': description: Success content: application/json: schema: type: object properties: message: type: string example: Pipeline Build Job submitted successfully result: type: object properties: id: type: string example: 5fd5c5f7e27e6d34cf0660b8 '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/jobs/{job_id}: parameters: - name: domain_id in: path required: true schema: type: string - name: job_id in: path description: Job Id required: true schema: type: string - name: pipeline_group_id in: path description: pipeline_group_id required: true schema: type: string get: security: - BearerAuth: [] operationId: getPipelineGroupsJobviaJobID tags: - Jobs summary: Gets Pipeline Groups Job. description: Gets Pipeline Groups Job. responses: '200': description: Success content: application/json: schema: type: object properties: message: type: string result: type: object properties: id: type: string example: 63cd71df9f1c1e258c6e991b type: type: string example: pipeline_group_build status: type: string example: failed percentage: type: number duration: type: number example: 19199 created_at: type: string example: '2023-01-22T17:26:55.895Z' created_by: type: string example: 6RkfybTRQQByEey3v last_updated: type: string example: '2023-01-22T17:27:07.487Z' processed_at: type: string example: '2023-01-22T17:26:58.609Z' entity_type: type: string example: pipeline_group entity_id: type: string example: 63cd41299f1c1e258c6e9753 triggered_by: type: object properties: parent: type: string example: restapi client_host_id: type: string example: 10.253.8.4 user_id: type: string example: 6RkfybTRQQByEey3v custom_tags: type: array items: type: object properties: key: type: string example: tag1 value: type: string example: val1 build_started_at: type: string example: '2023-01-22T17:27:06.356Z' build_ended_at: type: string example: '2023-01-22T17:27:25.555Z' cluster_id: type: string example: 0116-132644-ohcnfchr queue_info: type: string job_list: type: array items: type: string example: 63cd71df9f1c1e258c6e991a domain_id: type: string example: 0451ef3e5fd83029e98ab3c1 '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/jobs/{job_id}/pipeline-jobs: parameters: - name: domain_id in: path required: true schema: type: string - name: job_id in: path description: Job Id required: true schema: type: string - name: pipeline_group_id in: path description: pipeline_group_id required: true schema: type: string get: security: - BearerAuth: [] operationId: getJobs_job_id tags: - Jobs summary: Gets Pipeline Groups Job. description: Gets Pipeline Groups Job. responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: limit: type: integer example: 10 offset: type: integer example: 0 links: type: object properties: base: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains} self: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0 next: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10 total_count: type: integer example: 10 x-examples: example-1: {} - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: object properties: job_type: type: string enum: - pipeline_group_build example: pipeline_group_build '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/jobs/{job_id}/runs: parameters: - name: domain_id in: path required: true schema: type: string - name: job_id in: path description: Job Id required: true schema: type: string - name: pipeline_group_id in: path description: pipeline_group_id required: true schema: type: string get: security: - BearerAuth: [] operationId: getJobs_runs tags: - Jobs summary: Gets Pipeline Groups Job. description: Gets Pipeline Groups Job. responses: '200': description: Success content: application/json: schema: type: object properties: id: type: string example: 8714887c9a8c5bb0b8794811 build_id: type: integer example: 2 name: type: string example: test_job status: type: string enum: - completed - pending - aborted - blocked - failed - running - canceled - succeeded example: completed percentage: type: integer example: 100 type: type: string enum: - source_test_connection - fetch_metadata - source_structured_fetch_metadata - source_crawl - source_crawl_chunk_load - source_cdc - source_unstructured_crawl - source_structured_crawl - source_semistructured_crawl - delete_entity - pipeline_metadata - pipeline_build - pipeline_build_restatement - full_load - cdc - source_merge - source_structured_cdc_merge - source_structured_cdc - source_cdc_merge - source_cdc_restatement - source_semistructured_cdc_merge - source_semistructured_cdc - metadata_cleanup_policy entity_id: type: string example: d2f33c1d424363162692b3bf entity_type: type: string enum: - source - pipeline - workflow sub_entity_id: type: string example: be034607444511f74313be63 sub_entity_type: type: string example: table_group duration: type: integer example: 349316 description: This is duration of the job. cluster_id: type: string example: j-134jnasdkjaasd description: Extenal clusterId compute_id: type: string example: be034607444511f74313be63 description: Infoworks compute cluster id compute_name: type: string example: Default_Persistent_cluster description: Infoworks compute name created_at: type: string format: date-time example: '2020-10-05T04:23:30.339Z' created_by: type: string example: 6RkfybTRQQByEey3v description: UserId of user who triggered the job. last_updated: type: string example: '2019-11-21T12:54:05.875Z' processed_at: type: string example: '2019-11-21T12:54:05.875Z' '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/jobs/{job_id}/logs: parameters: - name: job_id in: path description: Job Id required: true schema: type: string - name: num_lines in: query description: Number of lines of log required schema: type: integer default: 100 - name: domain_id in: path required: true schema: type: string - name: pipeline_group_id in: path description: pipeline_group_id required: true schema: type: string get: security: - BearerAuth: [] operationId: get_pipeline_group_job_logs_admin tags: - Jobs summary: Get the job log as text stream with `job_id` description: Get the job log as text stream with `job_id` responses: '200': description: Ok. content: application/octet-stream: schema: type: string example: "[INFO] 2020-12-22 13:44:52,730 [main] io.infoworks.saas.ingestion.commons.utils.HeartBeatJob:24 :: Starting job for 5fe1f854e27e6d67b923f7c4\n [INFO] 2020-12-22 13:44:52,732 [main] io.infoworks.saas.ingestion.commons.utils.HeartbeatUpdater:30 :: Starting heartbeats thread\n [INFO] 2020-12-22 13:44:55,876 [main] io.infoworks.saas.ingestion.core.crawl.util.CrawlHelper:523 :: connector path :/opt/infoworks/lib/ingestion/connectors/mysql\n [INFO] 2020-12-22 13:44:55,876 [main] io.infoworks.saas.ingestion.core.crawl.util.CrawlHelper:526 :: Loading connector specific jars for :mysql\n [INFO] 2020-12-22 13:44:55,885 [main] io.infoworks.saas.ingestion.core.utils.ClassResolverFactory:214 :: Resolving connector class io.infoworks.connectors.rdbms.mysql.classresolver.ClassResolver\n [INFO] 2020-12-22 13:44:56,330 [main] io.infoworks.saas.ingestion.core.connectors.jdbc.sourcecrawler.AbstractJDBCSourceCrawler:83 :: Granted 1 connections\n [INFO] 2020-12-22 13:44:56,334 [main] io.infoworks.saas.ingestion.core.utils.ConnectionPool:24 :: Releasing 1 connections to pool\n [INFO] 2020-12-22 13:44:56,334 [main] io.infoworks.saas.ingestion.core.connectors.jdbc.sourcecrawler.AbstractJDBCSourceCrawler:83 :: Granted 1 connections\n [INFO] 2020-12-22 13:44:56,334 [main] io.infoworks.saas.ingestion.core.utils.ConnectionPool:24 :: Releasing 1 connections to pool\n [INFO] 2020-12-22 13:44:56,334 [main] io.infoworks.saas.ingestion.core.connectors.jdbc.sourcecrawler.AbstractJDBCSourceCrawler:83 :: Granted 1 connections\n [INFO] 2020-12-22 13:44:56,334 [main] io.infoworks.saas.ingestion.core.utils.ConnectionPool:24 :: Releasing 1 connections to pool\n [INFO] 2020-12-22 13:44:56,335 [main] io.infoworks.saas.ingestion.core.connectors.jdbc.sourcecrawler.AbstractJDBCSourceCrawler:83 :: Granted 1 connections\n [INFO] 2020-12-22 13:44:56,335 [main] io.infoworks.saas.ingestion.core.utils.ConnectionPool:24 :: Releasing 1 connections to pool\n [INFO] 2020-12-22 13:44:56,542 [pool-1-thread-1] io.infoworks.saas.ingestion.core.utils.ClassResolverFactory:214 :: Resolving connector class io.infoworks.connectors.rdbms.mysql.classresolver.ClassResolver\n [INFO] 2020-12-22 13:44:56,546 [pool-1-thread-4] io.infoworks.saas.ingestion.core.utils.ClassResolverFactory:214 :: Resolving connector class io.infoworks.connectors.rdbms.mysql.classresolver.ClassResolver\n [INFO] 2020-12-22 13:44:56,550 [pool-1-thread-2] io.infoworks.saas.ingestion.core.utils.ClassResolverFactory:214 :: Resolving connector class io.infoworks.connectors.rdbms.mysql.classresolver.ClassResolver\n [INFO] 2020-12-22 13:44:56,553 [pool-1-thread-3] io.infoworks.saas.ingestion.core.utils.ClassResolverFactory:214 :: Resolving connector class io.infoworks.connectors.rdbms.mysql.classresolver.ClassResolver\n [INFO] 2020-12-22 13:44:56,824 [pool-1-thread-4] io.infoworks.platform.metadb.core.sync.store.MongoDBMetaStore:37 :: Initializing mongodb meta store ...\n [INFO] 2020-12-22 13:44:56,892 [pool-1-thread-4] io.infoworks.platform.common.encryption.AES256:94 :: Attempting to decrypt data using AES-256\n" '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/jobs/{job_id}/logs/download: parameters: - name: domain_id in: path required: true schema: type: string - name: job_id in: path description: Job Id required: true schema: type: string - name: pipeline_group_id in: path description: pipeline_group_id required: true schema: type: string get: security: - BearerAuth: [] tags: - Jobs summary: Download iw job logs zip for iw_job with job_id description: Download iw job logs zip for iw_job with `job_id` responses: '200': description: Ok. content: application/octet-stream: schema: type: string format: binary example: log_file_5fe1f854e27e6d67b923f7c4.zip '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 components: securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT BasicAuth: type: http scheme: basic