openapi: 3.2.0 info: contact: {} title: Infoworks Rest API V3 Domains 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: Domains description: '' paths: /admin/data-connections/{data_connection_id}: parameters: - name: data_connection_id in: path required: true schema: type: string get: security: - BearerAuth: [] operationId: getDataConnection tags: - Domains summary: Get the Target Data Connection description: Get the Target Data Connection responses: '200': description: Ok content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - properties: result: allOf: - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - properties: type: type: string example: SNOWFLAKE name: type: string example: target1 connection_url: type: string example: jdbc://admin:xxxx@infoworks.io/ account_name: type: string example: pvt_account_1 username: type: string example: admin password: type: string example: xxxx warehouse: type: string example: data_warehouse additional_params: type: string example: x=2&&y=4 - type: object allOf: - type: object properties: created_at: type: string example: '2019-11-21T12:54:05.875Z' - type: object properties: created_by: type: string example: 6RkfybTRQQByEey3v - type: object properties: modified_at: type: string example: '2019-11-21T12:54:05.875Z' - type: object properties: modified_by: type: string example: 6RkfybTRQQByEey3v '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 put: security: - BearerAuth: [] operationId: updateDataConnection tags: - Domains summary: Edit the Target Data Connections Associated with a Domain description: Edit the Target Data Connections Associated with a Domain requestBody: content: application/json: schema: properties: type: type: string example: SNOWFLAKE name: type: string example: target1 connection_url: type: string example: jdbc://admin:xxxx@infoworks.io/ account_name: type: string example: pvt_account_1 username: type: string example: admin password: type: string example: xxxx warehouse: type: string example: data_warehouse additional_params: type: string example: x=2&&y=4 responses: '200': description: Ok 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 patch: security: - BearerAuth: [] operationId: patchDataConnection tags: - Domains summary: Patch the Target Data Connection description: Patch the Target Data Connection requestBody: content: application/json: schema: properties: type: type: string example: SNOWFLAKE name: type: string example: target1 connection_url: type: string example: jdbc://admin:xxxx@infoworks.io/ account_name: type: string example: pvt_account_1 username: type: string example: admin password: type: string example: xxxx warehouse: type: string example: data_warehouse additional_params: type: string example: x=2&&y=4 responses: '200': description: Ok 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 delete: security: - BearerAuth: [] operationId: deleteDataConnection tags: - Domains summary: Delete the Target Data Connections Associated with a Domain description: Delete the Target Data Connections Associated with a Domain responses: '200': description: Ok 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 /admin/domains: get: security: - BearerAuth: [] operationId: getDomains tags: - Domains summary: Get List of Domains description: Get List of Domains 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: 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 - name: sort_by in: query description: Sort result on field schema: type: string 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: allOf: - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - allOf: - type: object properties: name: type: string example: DF_SQLIMPORT - type: object properties: description: type: string example: Example Domain - type: object properties: secrets: type: array items: type: string example: 8247ad34f124512e - properties: environment_ids: type: array items: type: string example: 8247ad34f124512e users: type: array items: type: string example: 8247ad34f124512e - type: object allOf: - type: object properties: created_at: type: string example: '2019-11-21T12:54:05.875Z' - type: object properties: created_by: type: string example: 6RkfybTRQQByEey3v - type: object properties: modified_at: type: string example: '2019-11-21T12:54:05.875Z' - type: object properties: modified_by: type: string example: 6RkfybTRQQByEey3v - type: object properties: accessibleDomains: type: array items: type: string example: 3456234456cde12e - type: object properties: accessiblePipelineExtensions: type: array items: type: string example: 7b606a6c4bc0688a99cc5f07 - type: object properties: environment: type: object properties: id: type: string example: 63cd71df9f1c1e258c6e991b name: type: string example: env_azure compute_engine: type: string example: spark platform: type: string example: databricks ephemeral_compute: type: array items: type: object properties: name: type: string example: ephemeral_compute environment_id: type: string example: 63cd71df9f1c1e258c6e991b id: type: string example: 63cd71df9f1c1e258c6e991b interactive_compute: type: array items: type: object properties: name: type: string example: interactive_compute environment_id: type: string example: 63cd71df9f1c1e258c6e991b id: type: string example: 63cd71df9f1c1e258c6e991b storage: type: array items: type: object properties: id: type: string example: 63cd71df9f1c1e258c6e991b name: type: string example: storage environment_id: type: string example: 63cd71df9f1c1e258c6e991b description: type: string example: description for storage storage_type: type: string example: gcs storage_authentication: type: object properties: authentication_mechanism: type: string example: environment_service_credential scheme: type: string example: gs:// bucket_name: type: string example: temp-bucket-xxx '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/domains/{domain_id}/accessible-sources-to-add: parameters: - name: domain_id in: path required: true schema: type: string get: security: - BearerAuth: [] operationId: Domain Accessible Sources tags: - Domains summary: Get List of Domains description: Get List of Domains 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: 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 - name: sort_by in: query description: Sort result on field schema: type: string 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: array items: type: object properties: id: type: string created_at: type: string created_by: type: string source_name: type: string environment_details: type: array items: type: object properties: environment: type: object properties: id: type: string name: type: string compute_engine: type: string platform: type: string ephemeral_computes: type: array items: type: object properties: name: type: string environment_id: type: string id: type: string interactive_computes: type: array items: type: object properties: name: type: string environment_id: type: string id: type: string storage: type: array items: type: object properties: id: type: string name: type: string environment_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 /admin/domains/{domain_id}/domain-users: parameters: - name: domain_id in: path required: true schema: type: string get: security: - BearerAuth: [] operationId: Domain Users tags: - Domains summary: Get List of Domains Users description: Get List of Domains Users 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: 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 - name: sort_by in: query description: Sort result on field schema: type: string 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: {} - properties: result: items: type: array items: type: object properties: id: type: string example: sEKaHnrAAEx9P5YkM '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/domains/{domain_id}/accessible-domains-to-add: parameters: - name: domain_id in: path required: true schema: type: string get: security: - BearerAuth: [] operationId: Domain Accessible tags: - Domains summary: Get List of Accessible Domains description: Get List of Accessible Domains 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: 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 - name: sort_by in: query description: Sort result on field schema: type: string 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: array items: type: object properties: id: type: string created_at: type: string created_by: type: string domain_name: type: string created_by_name: type: string description: 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 /admin/domains/{domain_id}/accessible-pipeline-extensions-to-add: parameters: - name: domain_id in: path required: true schema: type: string get: security: - BearerAuth: [] operationId: Domain Pipeline Extensions tags: - Domains summary: Get List of Domains Pipeline Extensions description: Get List of Domains Pipeline Extensions 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: 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 - name: sort_by in: query description: Sort result on field schema: type: string 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: array items: type: object properties: id: type: string pipeline_extension_name: type: string extension_type: 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: get: security: - BearerAuth: [] operationId: getDomains tags: - Domains summary: Get List of Domains description: Get List of Domains 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: 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 - name: sort_by in: query description: Sort result on field schema: type: string 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: allOf: - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - allOf: - type: object properties: name: type: string example: DF_SQLIMPORT - type: object properties: description: type: string example: Example Domain - type: object properties: secrets: type: array items: type: string example: 8247ad34f124512e - properties: environment_ids: type: array items: type: string example: 8247ad34f124512e users: type: array items: type: string example: 8247ad34f124512e - type: object allOf: - type: object properties: created_at: type: string example: '2019-11-21T12:54:05.875Z' - type: object properties: created_by: type: string example: 6RkfybTRQQByEey3v - type: object properties: modified_at: type: string example: '2019-11-21T12:54:05.875Z' - type: object properties: modified_by: type: string example: 6RkfybTRQQByEey3v - type: object properties: accessibleDomains: type: array items: type: string example: 3456234456cde12e - type: object properties: accessiblePipelineExtensions: type: array items: type: string example: 7b606a6c4bc0688a99cc5f07 - type: object properties: environment: type: object properties: id: type: string example: 63cd71df9f1c1e258c6e991b name: type: string example: env_azure compute_engine: type: string example: spark platform: type: string example: databricks ephemeral_compute: type: array items: type: object properties: name: type: string example: ephemeral_compute environment_id: type: string example: 63cd71df9f1c1e258c6e991b id: type: string example: 63cd71df9f1c1e258c6e991b interactive_compute: type: array items: type: object properties: name: type: string example: interactive_compute environment_id: type: string example: 63cd71df9f1c1e258c6e991b id: type: string example: 63cd71df9f1c1e258c6e991b storage: type: array items: type: object properties: id: type: string example: 63cd71df9f1c1e258c6e991b name: type: string example: storage environment_id: type: string example: 63cd71df9f1c1e258c6e991b description: type: string example: description for storage storage_type: type: string example: gcs storage_authentication: type: object properties: authentication_mechanism: type: string example: environment_service_credential scheme: type: string example: gs:// bucket_name: type: string example: temp-bucket-xxx '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: createDomain tags: - Domains summary: Add a domain. (Requires Admin Access) description: Add a domain. (Requires Admin Access) requestBody: content: application/json: schema: allOf: - type: object properties: name: type: string example: DF_SQLIMPORT - type: object properties: description: type: string example: Example Domain - type: object properties: secrets: type: array items: type: string example: 8247ad34f124512e - properties: environment_ids: type: array items: type: string example: 8247ad34f124512e users: type: array items: type: string example: 8247ad34f124512e responses: '200': description: ok content: application/json: schema: type: object properties: message: type: string example: Successfully created a Domain result: allOf: - 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 /domains/{domain_id}: get: security: - BearerAuth: [] operationId: getDomain tags: - Domains summary: Get description of a domain_id. (Requires Admin Access) description: Get description of a domain_id. (Requires Admin Access) parameters: - name: domain_id in: path required: true schema: type: string responses: '200': description: ok content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: allOf: - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - allOf: - type: object properties: name: type: string example: DF_SQLIMPORT - type: object properties: description: type: string example: Example Domain - type: object properties: secrets: type: array items: type: string example: 8247ad34f124512e - properties: environment_ids: type: array items: type: string example: 8247ad34f124512e users: type: array items: type: string example: 8247ad34f124512e - type: object allOf: - type: object properties: created_at: type: string example: '2019-11-21T12:54:05.875Z' - type: object properties: created_by: type: string example: 6RkfybTRQQByEey3v - type: object properties: modified_at: type: string example: '2019-11-21T12:54:05.875Z' - type: object properties: modified_by: type: string example: 6RkfybTRQQByEey3v - type: object properties: accessibleDomains: type: array items: type: string example: 3456234456cde12e - type: object properties: accessiblePipelineExtensions: type: array items: type: string example: 7b606a6c4bc0688a99cc5f07 - type: object properties: environment: type: object properties: id: type: string example: 63cd71df9f1c1e258c6e991b name: type: string example: env_azure compute_engine: type: string example: spark platform: type: string example: databricks ephemeral_compute: type: array items: type: object properties: name: type: string example: ephemeral_compute environment_id: type: string example: 63cd71df9f1c1e258c6e991b id: type: string example: 63cd71df9f1c1e258c6e991b interactive_compute: type: array items: type: object properties: name: type: string example: interactive_compute environment_id: type: string example: 63cd71df9f1c1e258c6e991b id: type: string example: 63cd71df9f1c1e258c6e991b storage: type: array items: type: object properties: id: type: string example: 63cd71df9f1c1e258c6e991b name: type: string example: storage environment_id: type: string example: 63cd71df9f1c1e258c6e991b description: type: string example: description for storage storage_type: type: string example: gcs storage_authentication: type: object properties: authentication_mechanism: type: string example: environment_service_credential scheme: type: string example: gs:// bucket_name: type: string example: temp-bucket-xxx - type: object properties: accessible_domains_details: type: array items: type: object properties: id: type: string name: type: string created_at: type: string created_by: type: string environment_ids: type: array items: type: object - type: object properties: accessible_pipeline_extensions_details: type: array items: type: object properties: id: type: string name: type: string type: type: string - type: object properties: recently_used: type: array items: type: object properties: entity_type: type: string example: pipeline entity_id: type: string example: 8f94b2d08e48b07f1a50ac1e access_at: type: string example: '2023-03-09T04:46:27.297Z' access_by: type: string example: 6RkfybTRQQByEey3v entity_name: type: string example: pipeline123 modified_at: type: string example: '2023-02-21T05:19:09.803Z' modified_by_name: type: string example: Admin created_at: type: string example: '2022-12-14T10:40:29.536Z' '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: [] operationId: patchDomain tags: - Domains summary: Edit name and description of a domain. (Requires Admin Access) description: Edit name and description of a domain. (Requires Admin Access) parameters: - name: domain_id in: path required: true schema: type: string requestBody: content: application/json: schema: anyOf: - type: object properties: name: type: string example: DF_SQLIMPORT - type: object properties: description: type: string example: Example Domain - type: object properties: secrets: type: array items: type: string example: 8247ad34f124512e responses: '200': description: ok content: application/json: schema: allOf: - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - type: object properties: message: type: string example: Successfully Edited a Domain '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 delete: security: - BearerAuth: [] operationId: deleteDomain tags: - Domains summary: Delete a Domain (Requires Admin Access). description: Delete a Domain (Requires Admin Access). parameters: - name: domain_id in: path required: true schema: type: string responses: '200': description: Ok. content: application/json: schema: type: object properties: result: type: string example: success '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}/accessible-sources: get: security: - BearerAuth: [] operationId: getAccessibleSources tags: - Domains summary: Get all the Sources associated with this Domain description: Get all the Sources associated with this Domain 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: 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 - name: sort_by in: query description: Sort result on field schema: type: string - name: domain_id in: path required: true schema: type: string 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: - allOf: - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - type: object properties: sourceName: type: string example: kafka-source sourceType: type: string example: streaming - type: object properties: created_at: type: string example: '2019-11-21T12:54:05.875Z' - type: object properties: created_by: type: string example: 6RkfybTRQQByEey3v - type: object properties: environment: type: object properties: id: type: string example: 63cd71df9f1c1e258c6e991b name: type: string example: env_azure compute_engine: type: string example: spark platform: type: string example: databricks ephemeral_compute: type: array items: type: object properties: name: type: string example: ephemeral_compute environment_id: type: string example: 63cd71df9f1c1e258c6e991b id: type: string example: 63cd71df9f1c1e258c6e991b interactive_compute: type: array items: type: object properties: name: type: string example: interactive_compute environment_id: type: string example: 63cd71df9f1c1e258c6e991b id: type: string example: 63cd71df9f1c1e258c6e991b storage: type: array items: type: object properties: id: type: string example: 63cd71df9f1c1e258c6e991b name: type: string example: storage environment_id: type: string example: 63cd71df9f1c1e258c6e991b description: type: string example: description for storage storage_type: type: string example: gcs storage_authentication: type: object properties: authentication_mechanism: type: string example: environment_service_credential scheme: type: string example: gs:// bucket_name: type: string example: temp-bucket-xxx '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: addAccessibleSources parameters: - name: domain_id in: path required: true schema: type: string tags: - Domains summary: Add Sources to this Domain (Requires Admin Access) description: Add Sources to this Domain (Requires Admin Access) requestBody: content: application/json: schema: type: object properties: entity_ids: type: array items: type: string example: 8247ad34f124512e responses: '200': description: Ok. content: application/json: schema: type: object properties: result: type: string example: success '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 put: security: - BearerAuth: [] operationId: updateAccessibleSources parameters: - name: domain_id in: path required: true schema: type: string tags: - Domains summary: Update Sources to this Domain (Requires Admin Access) description: Update Sources to this Domain (Requires Admin Access) requestBody: content: application/json: schema: type: object properties: entity_ids: type: array items: type: string example: 8247ad34f124512e responses: '200': description: Ok. content: application/json: schema: type: object properties: result: type: string example: success '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 delete: security: - BearerAuth: [] operationId: deleteAccessibleSources parameters: - name: domain_id in: path required: true schema: type: string tags: - Domains summary: Remove Source from this Domain (Requires Admin Access) description: Remove Source from this Domain (Requires Admin Access) responses: '200': description: Ok. content: application/json: schema: type: object properties: result: type: string example: success '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}/accessible-domains: get: security: - BearerAuth: [] operationId: getAccessibleDomains tags: - Domains summary: Get all the Domains associated with this Domain description: Get all the Domains associated with this Domain 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: 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 - name: sort_by in: query description: Sort result on field schema: type: string - name: domain_id in: path required: true schema: type: string 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: - allOf: - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - type: object properties: domainName: type: string example: Stock Domain - type: object allOf: - type: object properties: created_at: type: string example: '2019-11-21T12:54:05.875Z' - type: object properties: created_by: type: string example: 6RkfybTRQQByEey3v - type: object properties: modified_at: type: string example: '2019-11-21T12:54:05.875Z' - type: object properties: modified_by: type: string example: 6RkfybTRQQByEey3v '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: addAccessibleDomains parameters: - name: domain_id in: path required: true schema: type: string tags: - Domains summary: Add Domains to this Domain (Requires Admin Access) description: Add Domains to this Domain (Requires Admin Access) requestBody: content: application/json: schema: type: object properties: entity_ids: type: array items: type: string example: 8247ad34f124512e responses: '200': description: Ok. content: application/json: schema: type: object properties: result: type: string example: success '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 put: security: - BearerAuth: [] operationId: updateAccessibleDomains parameters: - name: domain_id in: path required: true schema: type: string tags: - Domains summary: Update accessible-domain in this Domain (Requires Admin Access) description: Update accessible-domain in this Domain (Requires Admin Access) requestBody: content: application/json: schema: type: object properties: entity_ids: type: array items: type: string example: 8247ad34f124512e responses: '200': description: Ok. content: application/json: schema: type: object properties: result: type: string example: success '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 delete: security: - BearerAuth: [] operationId: removeAccessibleDomains parameters: - name: domain_id in: path required: true schema: type: string tags: - Domains summary: Remove Domain from this Domain (Requires Admin Access) description: Remove Domain from this Domain (Requires Admin Access) responses: '200': description: Ok. content: application/json: schema: type: object properties: result: type: string example: success '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}/accessible-workflows: get: security: - BearerAuth: [] operationId: getAccessibleWorkflows tags: - Domains summary: Get all the workflows associated with this Domain description: Get all the workflows associated with this Domain parameters: - name: domain_id in: path required: true schema: type: string responses: '200': description: Ok. content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: array items: allOf: - type: object properties: id: type: string name: type: string domain_id: type: string domain_name: 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}/accessible-table-groups: get: security: - BearerAuth: [] operationId: getAccessibleTableGroups tags: - Domains summary: Get all the tablegroups associated with this Domain description: Get all the tablegroups associated with this Domain parameters: - name: domain_id in: path required: true schema: type: string responses: '200': description: Ok. content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: array items: allOf: - type: object properties: id: type: string name: type: string source: type: string source_name: 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}/accessible-interactive-computes: get: security: - BearerAuth: [] operationId: getAccessibleInteractiveComputes tags: - Domains summary: Get all the interactive computes associated with this Domain description: Get all the interactive computes associated with this Domain parameters: - name: domain_id in: path required: true schema: type: string responses: '200': description: Ok. content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: array items: allOf: - type: object properties: id: type: string name: type: string environment_id: type: string environment_name: 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}/accessible-pipelines: get: security: - BearerAuth: [] operationId: getAccessiblePipelines tags: - Domains summary: Get all the pipelines associated with this Domain description: Get all the pipelines associated with this Domain parameters: - name: domain_id in: path required: true schema: type: string responses: '200': description: Ok. content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: array items: allOf: - type: object properties: id: type: string name: type: string domain_id: type: string domain_name: 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}/accessible-pipeline-extensions: get: security: - BearerAuth: [] operationId: getAccessiblePipelineExtensions tags: - Domains summary: Get all the Pipeline Extensions associated with this Domain description: Get all the Pipeline Extensions associated with this Domain 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: 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 - name: sort_by in: query description: Sort result on field schema: type: string - name: domain_id in: path required: true schema: type: string 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: pipeline_extension_name: type: string example: Custom Transformation Example extension_type: type: string example: Spark execution_type: type: string example: JAVA transformations: type: array items: type: object properties: alias: type: string example: AddInteger class_name: type: string example: io.infoworks.external.maskers.AddInteger '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 put: security: - BearerAuth: [] operationId: updateAccessiblePipelineExtensions parameters: - name: domain_id in: path required: true schema: type: string tags: - Domains summary: Update accessible-pipeline-extensions in this Domain (Requires Admin Access) description: Update accessible-pipeline-extensions in this Domain (Requires Admin Access) requestBody: content: application/json: schema: type: object properties: entity_ids: type: array items: type: string example: 8247ad34f124512e responses: '200': description: Ok. content: application/json: schema: type: object properties: result: type: string example: success '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: addAccessiblePipelineExtensions parameters: - name: domain_id in: path required: true schema: type: string tags: - Domains summary: Add Pipeline Extensions to this Domain (Requires Admin Access) description: Add Pipeline Extensions to this Domain (Requires Admin Access) requestBody: content: application/json: schema: type: object properties: entity_ids: type: array items: type: string example: 8247ad34f124512e responses: '200': description: Ok. content: application/json: schema: type: object properties: result: type: string example: success '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 delete: security: - BearerAuth: [] operationId: removeAccessiblePipelineExtensions description: Remove Pipeline Extension from this Domain (Requires Admin Access) parameters: - name: domain_id in: path required: true schema: type: string tags: - Domains summary: Remove Pipeline Extension from this Domain (Requires Admin Access) responses: '200': description: Ok. content: application/json: schema: type: object properties: result: type: string example: success '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}/configurations/advance/{key}: put: security: - BearerAuth: [] operationId: advancedConfigurationInfo description: Domain Advanced Configurations tags: - Domains parameters: - name: domain_id in: path required: true schema: type: string - name: key in: path required: true schema: type: string example: SPARK_ML_LIB requestBody: content: application/json: schema: allOf: - properties: value: type: string example: 3.2.0 - properties: description: type: string example: Spark version - properties: isActive: type: boolean example: true responses: '200': description: Ok. content: application/json: schema: type: object properties: result: type: string example: success '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: [] operationId: updateAdvancedConfiguration tags: - Domains description: update advanced configs parameters: - name: domain_id in: path required: true schema: type: string - name: key in: path required: true schema: type: string example: SPARK_ML_LIB requestBody: content: application/json: schema: anyOf: - properties: value: type: string example: 3.2.0 - properties: description: type: string example: Spark version - properties: isActive: type: boolean example: true responses: '200': description: Ok. content: application/json: schema: type: object properties: result: type: string example: success '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 delete: security: - BearerAuth: [] operationId: removedAdvancedConfigs description: delete advanced configs tags: - Domains parameters: - name: domain_id in: path required: true schema: type: string - name: key in: path required: true schema: type: string example: SPARK_ML_LIB responses: '200': description: Ok. content: application/json: schema: type: object properties: result: type: string example: success '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}/recently-used-entities: parameters: - name: domain_id in: path required: true schema: type: string get: security: - BearerAuth: [] operationId: getRecentlyUsedEntities tags: - Domains summary: Get recently used entities associated with this Domain description: Get recently used entities associated with this Domain 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: entity_type: type: string example: pipeline entity_id: type: string access_at: type: string access_by: type: string entity_name: type: string modified_at: type: string modified_by_name: type: string created_at: 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 post: security: - BearerAuth: [] operationId: addRecentlyUsedEntity parameters: - name: domain_id in: path required: true schema: type: string tags: - Domains summary: Add Recently Used Entity to this Domain description: Add Recently Used Entity to this Domain requestBody: content: application/json: schema: type: object properties: entity_type: type: string example: pipeline entity_id: type: string responses: '200': description: Ok. content: application/json: schema: type: object properties: result: type: string example: success '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}/comments: parameters: - name: domain_id in: path required: true schema: type: string get: security: - BearerAuth: [] operationId: getComments tags: - Domains summary: Get comments associated with this Domain description: Get comments associated with this Domain 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: comment: 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 post: security: - BearerAuth: [] operationId: addComments parameters: - name: domain_id in: path required: true schema: type: string tags: - Domains summary: Add comment to this Domain description: Add comment to this Domain requestBody: content: application/json: schema: type: object properties: comment: type: string responses: '200': description: Ok. content: application/json: schema: type: object properties: result: type: string example: success '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}/notifications: parameters: - name: domain_id in: path required: true schema: type: string get: security: - BearerAuth: [] operationId: getNotifications tags: - Domains summary: Get notifications associated with this Domain description: Get notifications associated with this Domain 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 type: type: string example: user_action domain_id: type: string created_by: type: string created_at: type: string message_type: type: string example: domain_user_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 /domains/{domain_id}/pipelines/{pipeline_id}/versions/{version_id}/node/{node_id}: parameters: - name: domain_id in: path required: true schema: type: string - name: pipeline_id in: path required: true schema: type: string - name: version_id in: path required: true schema: type: string - name: node_id in: path required: true description: node_id for node in pipeline schema: type: string example: TARGET_kulo get: security: - BearerAuth: [] operationId: Get Table Orders With Hierachy tags: - Domains summary: Get Table Orders With Hierachy description: Get Table Orders With Hierachy 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: table: type: object properties: id: type: string name: type: string original_table_name: type: string data_lake_schema: type: string data_lake_path: type: string meta_crawl_performed: type: boolean columns: type: array items: type: object properties: sql_type: type: number is_deleted: type: boolean name: type: string original_name: type: string target_sql_type: type: number is_audit_column: type: boolean target_scale: type: string col_size: type: number precision: type: number target_precision: type: string scale: type: number configuration: type: object properties: exclude_legacy_audit_columns: type: boolean sync_type: type: string write_supported_engines: type: array items: type: string read_supported_engines: type: array items: type: string target_table_name: type: string storage_format: type: string target_schema_name: type: string update_strategy: type: string is_scd2_table: type: boolean is_archive_enabled: type: boolean natural_keys: type: array items: type: string fetch_mechanism: type: string generate_history_view: type: boolean state: type: string modified_at: type: string modified_by: type: string source: type: string is_jtds_driver: type: boolean schema_name_at_source: type: string source: type: object properties: created_at: type: string created_by: type: string modifiedAt: type: string modifiedBy: type: string tables: type: array items: type: string id: type: string name: type: string data_lake_schema: type: string data_lake_path: type: string type: type: string sub_type: type: string connection: type: object properties: connection_mode: type: string connection_url: type: string username: type: string password: type: string driver_name: type: string driver_version: type: string database: type: string enable_log_based_cdc: type: boolean environment_id: type: string storage_id: type: string quoted_identifier: type: string transformation_extensions: type: array items: type: object state: type: string filter_tables_properties: type: object properties: schemas_filter: type: string catalogs_filter: type: string tables_filter: type: string is_data_sync_with_filter: type: boolean is_filter_enabled: type: boolean is_source_ingested: type: boolean is_source_connection_verified: type: boolean default_step: type: string configuration: type: object properties: oracle_logbased_cdc_enabled: type: boolean '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}/environment_details_pipelines_accessible_sources: parameters: - name: domain_id in: path required: true schema: type: string get: security: - BearerAuth: [] operationId: Get Domains Pipeline and Accessibele Sources tags: - Domains summary: Get Domains Pipeline and Accessibele Sources description: Get Domains Pipeline and Accessibele Sources 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: sp2_e2e_1: type: object properties: pipelines: type: array items: type: object properties: name: type: string accessible_sources: type: array items: type: object properties: name: 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 components: securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT BasicAuth: type: http scheme: basic