openapi: 3.2.0 info: contact: {} title: Infoworks Rest API V3 Workflows 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: Workflows description: '' paths: /domains/{domain_id}/workflows: get: security: - BearerAuth: [] operationId: getDomainWorkflows tags: - Workflows summary: Get list of all Workflows for a `domain` with `{domain_id}`. description: Get list of all Workflows for a `domain` with `{domain_id}`. parameters: - name: domain_id in: path required: true schema: type: string - name: offset in: query description: The number of items to skip before starting to collect the result set schema: type: integer default: 0 - name: limit in: query description: The numbers of items to return schema: type: integer default: 10 - name: sort_by in: query description: Sort result on field schema: type: string - name: order_by in: query description: order ascending | descending schema: type: string default: asc enum: - asc - desc - name: filter in: query description: Filter results query schema: type: string - name: Content-Type in: header description: Http content type required: true schema: type: string enum: - application/json - multipart/form-data - text/plain default: application/json responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: limit: type: integer example: 10 offset: type: integer example: 0 links: type: object properties: base: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains} self: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0 next: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10 total_count: type: integer example: 10 x-examples: example-1: {} - type: object properties: result: type: array items: allOf: - allOf: - allOf: - type: object properties: name: type: string description: type: string active_version_id: type: string example: e77850ad5127a2d7dab870ff child_workflow_ids: type: array items: type: string example: e77850ad5127a2d7dab870ff impact: type: number - type: object properties: domain_id: type: string example: e77850ad5127a2d7dab870ff scheduler_username: type: string example: admin@infoworks.io schedule: oneOf: - type: object title: Generic Schedule description: Generic schedule object required: - schedule_status properties: schedule_status: type: string enum: - enabled - disabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - NEVER - MINUTE - HOUR - DAY - WEEK - MONTH default: NEVER example: MONTH repeat_interval_measure: type: integer minimum: 1 repeat_on_last_day: type: boolean description: '`specified_days` must be provided if `repeat_on_last_day` is false. Applicable for `repeat_interval_unit=MONTH` ' default: false specified_days: type: array description: 'Applicable when `repeat_interval_unit` is `WEEK` or `MONTH`. ' minLength: 1 items: type: integer minimum: 0 maximum: 31 example: - 1 - 17 - 31 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 38 is_custom_job: type: boolean description: '`custom_job_details` must be provided when `is_custom_job=true`. Applicable when `repeat_interval_unit` is `DAY`, `WEEK` or `MONTH`. ' default: false custom_job_details: type: object required: - starts_daily_at - ends_daily_at - repeat_interval_measure - repeat_interval_unit properties: starts_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '12:40' ends_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '17:45' repeat_interval_measure: type: integer minimum: 1 example: 10 repeat_interval_unit: type: string enum: - MINUTE - HOUR - type: object title: By Minute Schedule description: Schedule job by minutes required: - schedule_status - start_date - start_hour - start_min - repeat_interval_unit - repeat_interval_measure properties: schedule_status: type: string enum: - enabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - MINUTE repeat_interval_measure: type: integer minimum: 1 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 55 - type: object title: Hourly Schedule description: Schedule job hourly required: - schedule_status - start_date - start_hour - start_min - repeat_interval_unit - repeat_interval_measure properties: schedule_status: type: string enum: - enabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - HOUR repeat_interval_measure: type: integer minimum: 1 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 55 - type: object title: Daily Schedule description: Schedule job daily required: - schedule_status - start_date - start_hour - start_min - repeat_interval_unit - repeat_interval_measure properties: schedule_status: type: string enum: - enabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - DAY repeat_interval_measure: type: integer minimum: 1 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 55 is_custom_job: type: boolean description: '`custom_job_details` must be provided when `is_custom_job=true` ' default: false example: true custom_job_details: type: object required: - starts_daily_at - ends_daily_at - repeat_interval_measure - repeat_interval_unit properties: starts_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '12:40' ends_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '17:45' repeat_interval_measure: type: integer minimum: 1 example: 10 repeat_interval_unit: type: string enum: - MINUTE - HOUR - type: object title: Weekly Schedule description: Schedule job weekly required: - schedule_status - start_date - start_hour - start_min - repeat_interval_unit - repeat_interval_measure - specified_days properties: schedule_status: type: string enum: - enabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - WEEK repeat_interval_measure: type: integer minimum: 1 specified_days: type: array minLength: 1 items: type: integer minimum: 0 maximum: 6 example: - 0 - 2 - 5 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 55 is_custom_job: type: boolean description: '`custom_job_details` must be provided when `is_custom_job=true` ' default: false example: true custom_job_details: type: object required: - starts_daily_at - ends_daily_at - repeat_interval_measure - repeat_interval_unit properties: starts_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '12:40' ends_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '17:45' repeat_interval_measure: type: integer minimum: 1 example: 10 repeat_interval_unit: type: string enum: - MINUTE - HOUR - type: object title: Monthly Schedule description: Schedule job monthly required: - schedule_status - start_date - start_hour - start_min - repeat_interval_unit - repeat_interval_measure properties: schedule_status: type: string enum: - enabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - MONTH repeat_interval_measure: type: integer minimum: 1 repeat_on_last_day: type: boolean description: '`specified_days` must be provided if `repeat_on_last_day` is false. ' default: false specified_days: type: array minLength: 1 items: type: integer minimum: 1 maximum: 31 example: - 1 - 17 - 31 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 45 is_custom_job: type: boolean description: '`custom_job_details` must be provided when `is_custom_job=true` ' default: false example: true custom_job_details: type: object required: - starts_daily_at - ends_daily_at - repeat_interval_measure - repeat_interval_unit properties: starts_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '12:40' ends_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '17:45' repeat_interval_measure: type: integer minimum: 1 example: 10 repeat_interval_unit: type: string enum: - MINUTE - HOUR - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - 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: modified_by_name: type: string example: Admin created_by_name: type: string example: Admin '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: createWorkflow tags: - Workflows summary: Create Workflow for a `domain` with `{domain_id}`. description: Create Workflow for a `domain` with `{domain_id}`. parameters: - name: domain_id in: path required: true schema: type: string - name: Content-Type in: header description: Http content type required: true schema: type: string enum: - application/json - multipart/form-data - text/plain default: application/json requestBody: description: This is the JSON body of request containing configured Workflow object. content: application/json: schema: type: object properties: name: type: string description: type: string active_version_id: type: string example: e77850ad5127a2d7dab870ff child_workflow_ids: type: array items: type: string example: e77850ad5127a2d7dab870ff impact: type: number responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: object properties: id: type: string example: e77850ad5127a2d7dab870ff '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /domains/{domain_id}/workflows/{workflow_id}: get: security: - BearerAuth: [] operationId: getWorkflow tags: - Workflows summary: Gets a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`. description: Gets a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`. parameters: - name: domain_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string example: f132c1fa46e1e7f8fb1cf566 responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message type: object properties: result: allOf: - allOf: - type: object properties: name: type: string description: type: string active_version_id: type: string example: e77850ad5127a2d7dab870ff child_workflow_ids: type: array items: type: string example: e77850ad5127a2d7dab870ff impact: type: number - type: object properties: domain_id: type: string example: e77850ad5127a2d7dab870ff scheduler_username: type: string example: admin@infoworks.io schedule: oneOf: - type: object title: Generic Schedule description: Generic schedule object required: - schedule_status properties: schedule_status: type: string enum: - enabled - disabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - NEVER - MINUTE - HOUR - DAY - WEEK - MONTH default: NEVER example: MONTH repeat_interval_measure: type: integer minimum: 1 repeat_on_last_day: type: boolean description: '`specified_days` must be provided if `repeat_on_last_day` is false. Applicable for `repeat_interval_unit=MONTH` ' default: false specified_days: type: array description: 'Applicable when `repeat_interval_unit` is `WEEK` or `MONTH`. ' minLength: 1 items: type: integer minimum: 0 maximum: 31 example: - 1 - 17 - 31 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 38 is_custom_job: type: boolean description: '`custom_job_details` must be provided when `is_custom_job=true`. Applicable when `repeat_interval_unit` is `DAY`, `WEEK` or `MONTH`. ' default: false custom_job_details: type: object required: - starts_daily_at - ends_daily_at - repeat_interval_measure - repeat_interval_unit properties: starts_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '12:40' ends_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '17:45' repeat_interval_measure: type: integer minimum: 1 example: 10 repeat_interval_unit: type: string enum: - MINUTE - HOUR - type: object title: By Minute Schedule description: Schedule job by minutes required: - schedule_status - start_date - start_hour - start_min - repeat_interval_unit - repeat_interval_measure properties: schedule_status: type: string enum: - enabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - MINUTE repeat_interval_measure: type: integer minimum: 1 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 55 - type: object title: Hourly Schedule description: Schedule job hourly required: - schedule_status - start_date - start_hour - start_min - repeat_interval_unit - repeat_interval_measure properties: schedule_status: type: string enum: - enabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - HOUR repeat_interval_measure: type: integer minimum: 1 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 55 - type: object title: Daily Schedule description: Schedule job daily required: - schedule_status - start_date - start_hour - start_min - repeat_interval_unit - repeat_interval_measure properties: schedule_status: type: string enum: - enabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - DAY repeat_interval_measure: type: integer minimum: 1 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 55 is_custom_job: type: boolean description: '`custom_job_details` must be provided when `is_custom_job=true` ' default: false example: true custom_job_details: type: object required: - starts_daily_at - ends_daily_at - repeat_interval_measure - repeat_interval_unit properties: starts_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '12:40' ends_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '17:45' repeat_interval_measure: type: integer minimum: 1 example: 10 repeat_interval_unit: type: string enum: - MINUTE - HOUR - type: object title: Weekly Schedule description: Schedule job weekly required: - schedule_status - start_date - start_hour - start_min - repeat_interval_unit - repeat_interval_measure - specified_days properties: schedule_status: type: string enum: - enabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - WEEK repeat_interval_measure: type: integer minimum: 1 specified_days: type: array minLength: 1 items: type: integer minimum: 0 maximum: 6 example: - 0 - 2 - 5 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 55 is_custom_job: type: boolean description: '`custom_job_details` must be provided when `is_custom_job=true` ' default: false example: true custom_job_details: type: object required: - starts_daily_at - ends_daily_at - repeat_interval_measure - repeat_interval_unit properties: starts_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '12:40' ends_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '17:45' repeat_interval_measure: type: integer minimum: 1 example: 10 repeat_interval_unit: type: string enum: - MINUTE - HOUR - type: object title: Monthly Schedule description: Schedule job monthly required: - schedule_status - start_date - start_hour - start_min - repeat_interval_unit - repeat_interval_measure properties: schedule_status: type: string enum: - enabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - MONTH repeat_interval_measure: type: integer minimum: 1 repeat_on_last_day: type: boolean description: '`specified_days` must be provided if `repeat_on_last_day` is false. ' default: false specified_days: type: array minLength: 1 items: type: integer minimum: 1 maximum: 31 example: - 1 - 17 - 31 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 45 is_custom_job: type: boolean description: '`custom_job_details` must be provided when `is_custom_job=true` ' default: false example: true custom_job_details: type: object required: - starts_daily_at - ends_daily_at - repeat_interval_measure - repeat_interval_unit properties: starts_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '12:40' ends_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '17:45' repeat_interval_measure: type: integer minimum: 1 example: 10 repeat_interval_unit: type: string enum: - MINUTE - HOUR - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - 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 delete: security: - BearerAuth: [] operationId: submitJob tags: - Workflows summary: Deletes a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`. description: Deletes a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`. parameters: - name: domain_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string example: f132c1fa46e1e7f8fb1cf566 responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: string example: e77850ad5127a2d7dab870ff '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 patch: security: - BearerAuth: [] operationId: updateWorkflow tags: - Workflows summary: Update a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`. description: Update a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`. parameters: - name: domain_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string example: f132c1fa46e1e7f8fb1cf566 requestBody: content: application/json: schema: type: object properties: name: type: string description: type: string active_version_id: type: string example: e77850ad5127a2d7dab870ff child_workflow_ids: type: array items: type: string example: e77850ad5127a2d7dab870ff impact: type: number responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: object properties: id: type: string example: e77850ad5127a2d7dab870ff '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /domains/{domain_id}/workflows/{workflow_id}/config-migration: get: security: - BearerAuth: [] operationId: getExportConfigForMigration tags: - Workflows summary: Exports workflow configuration description: Exports the workflow configuration to JSON format for workflow with `workflow_id` in domain with `domain_id` parameters: - name: domain_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string example: f132c1fa46e1e7f8fb1cf566 - name: version_id in: query required: false description: ID of the workflow version to run. If omitted, the active version is used. schema: type: string example: e77850ad5127a2d7dab870ff responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: configuration: type: object properties: workflow: allOf: - type: object properties: name: type: string description: type: string active_version_id: type: string example: e77850ad5127a2d7dab870ff child_workflow_ids: type: array items: type: string example: e77850ad5127a2d7dab870ff impact: type: number - type: object properties: domain_id: type: string example: e77850ad5127a2d7dab870ff scheduler_username: type: string example: admin@infoworks.io schedule: oneOf: - type: object title: Generic Schedule description: Generic schedule object required: - schedule_status properties: schedule_status: type: string enum: - enabled - disabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - NEVER - MINUTE - HOUR - DAY - WEEK - MONTH default: NEVER example: MONTH repeat_interval_measure: type: integer minimum: 1 repeat_on_last_day: type: boolean description: '`specified_days` must be provided if `repeat_on_last_day` is false. Applicable for `repeat_interval_unit=MONTH` ' default: false specified_days: type: array description: 'Applicable when `repeat_interval_unit` is `WEEK` or `MONTH`. ' minLength: 1 items: type: integer minimum: 0 maximum: 31 example: - 1 - 17 - 31 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 38 is_custom_job: type: boolean description: '`custom_job_details` must be provided when `is_custom_job=true`. Applicable when `repeat_interval_unit` is `DAY`, `WEEK` or `MONTH`. ' default: false custom_job_details: type: object required: - starts_daily_at - ends_daily_at - repeat_interval_measure - repeat_interval_unit properties: starts_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '12:40' ends_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '17:45' repeat_interval_measure: type: integer minimum: 1 example: 10 repeat_interval_unit: type: string enum: - MINUTE - HOUR - type: object title: By Minute Schedule description: Schedule job by minutes required: - schedule_status - start_date - start_hour - start_min - repeat_interval_unit - repeat_interval_measure properties: schedule_status: type: string enum: - enabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - MINUTE repeat_interval_measure: type: integer minimum: 1 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 55 - type: object title: Hourly Schedule description: Schedule job hourly required: - schedule_status - start_date - start_hour - start_min - repeat_interval_unit - repeat_interval_measure properties: schedule_status: type: string enum: - enabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - HOUR repeat_interval_measure: type: integer minimum: 1 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 55 - type: object title: Daily Schedule description: Schedule job daily required: - schedule_status - start_date - start_hour - start_min - repeat_interval_unit - repeat_interval_measure properties: schedule_status: type: string enum: - enabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - DAY repeat_interval_measure: type: integer minimum: 1 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 55 is_custom_job: type: boolean description: '`custom_job_details` must be provided when `is_custom_job=true` ' default: false example: true custom_job_details: type: object required: - starts_daily_at - ends_daily_at - repeat_interval_measure - repeat_interval_unit properties: starts_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '12:40' ends_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '17:45' repeat_interval_measure: type: integer minimum: 1 example: 10 repeat_interval_unit: type: string enum: - MINUTE - HOUR - type: object title: Weekly Schedule description: Schedule job weekly required: - schedule_status - start_date - start_hour - start_min - repeat_interval_unit - repeat_interval_measure - specified_days properties: schedule_status: type: string enum: - enabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - WEEK repeat_interval_measure: type: integer minimum: 1 specified_days: type: array minLength: 1 items: type: integer minimum: 0 maximum: 6 example: - 0 - 2 - 5 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 55 is_custom_job: type: boolean description: '`custom_job_details` must be provided when `is_custom_job=true` ' default: false example: true custom_job_details: type: object required: - starts_daily_at - ends_daily_at - repeat_interval_measure - repeat_interval_unit properties: starts_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '12:40' ends_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '17:45' repeat_interval_measure: type: integer minimum: 1 example: 10 repeat_interval_unit: type: string enum: - MINUTE - HOUR - type: object title: Monthly Schedule description: Schedule job monthly required: - schedule_status - start_date - start_hour - start_min - repeat_interval_unit - repeat_interval_measure properties: schedule_status: type: string enum: - enabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - MONTH repeat_interval_measure: type: integer minimum: 1 repeat_on_last_day: type: boolean description: '`specified_days` must be provided if `repeat_on_last_day` is false. ' default: false specified_days: type: array minLength: 1 items: type: integer minimum: 1 maximum: 31 example: - 1 - 17 - 31 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 45 is_custom_job: type: boolean description: '`custom_job_details` must be provided when `is_custom_job=true` ' default: false example: true custom_job_details: type: object required: - starts_daily_at - ends_daily_at - repeat_interval_measure - repeat_interval_unit properties: starts_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '12:40' ends_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '17:45' repeat_interval_measure: type: integer minimum: 1 example: 10 repeat_interval_unit: type: string enum: - MINUTE - HOUR iw_mappings: type: array items: oneOf: - type: object properties: entity_type: type: string example: pipeline recommendation: type: object properties: {} to_entity_id: type: string example: e77850ad5127a2d7dab870ff - type: object properties: entity_type: type: string example: pipeline recommendation: type: object properties: pipeline_name: type: string example: Workflow_Pipeline_1 domain_name: type: string example: Automation_domain selected_versions: type: array items: type: object properties: version_id: type: string example: 648845a0007ecf1a1c550c5f version: type: number example: 1 to_entity_id: type: string example: e77850ad5127a2d7dab870ff entity: type: object properties: entity_id: type: string example: e77850ad5127a2d7dab870ff entity_type: type: string enum: - workflow entity_name: type: string example: example_workflow export: type: object properties: exported_at: type: string exported_by: type: string exported_by_username: 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 put: security: - BearerAuth: [] operationId: importConfigForMigration tags: - Workflows summary: Imports workflow configuration description: Imports the workflow configuration from JSON format for workflow with `workflow_id` in domain with `domain_id`. parameters: - name: domain_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string example: f132c1fa46e1e7f8fb1cf566 requestBody: description: This is the JSON body of request containing configuration of the Workflow object. content: application/json: schema: allOf: - type: object properties: configuration: type: object properties: workflow: allOf: - type: object properties: name: type: string description: type: string active_version_id: type: string example: e77850ad5127a2d7dab870ff child_workflow_ids: type: array items: type: string example: e77850ad5127a2d7dab870ff impact: type: number - type: object properties: domain_id: type: string example: e77850ad5127a2d7dab870ff scheduler_username: type: string example: admin@infoworks.io schedule: oneOf: - type: object title: Generic Schedule description: Generic schedule object required: - schedule_status properties: schedule_status: type: string enum: - enabled - disabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - NEVER - MINUTE - HOUR - DAY - WEEK - MONTH default: NEVER example: MONTH repeat_interval_measure: type: integer minimum: 1 repeat_on_last_day: type: boolean description: '`specified_days` must be provided if `repeat_on_last_day` is false. Applicable for `repeat_interval_unit=MONTH` ' default: false specified_days: type: array description: 'Applicable when `repeat_interval_unit` is `WEEK` or `MONTH`. ' minLength: 1 items: type: integer minimum: 0 maximum: 31 example: - 1 - 17 - 31 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 38 is_custom_job: type: boolean description: '`custom_job_details` must be provided when `is_custom_job=true`. Applicable when `repeat_interval_unit` is `DAY`, `WEEK` or `MONTH`. ' default: false custom_job_details: type: object required: - starts_daily_at - ends_daily_at - repeat_interval_measure - repeat_interval_unit properties: starts_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '12:40' ends_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '17:45' repeat_interval_measure: type: integer minimum: 1 example: 10 repeat_interval_unit: type: string enum: - MINUTE - HOUR - type: object title: By Minute Schedule description: Schedule job by minutes required: - schedule_status - start_date - start_hour - start_min - repeat_interval_unit - repeat_interval_measure properties: schedule_status: type: string enum: - enabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - MINUTE repeat_interval_measure: type: integer minimum: 1 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 55 - type: object title: Hourly Schedule description: Schedule job hourly required: - schedule_status - start_date - start_hour - start_min - repeat_interval_unit - repeat_interval_measure properties: schedule_status: type: string enum: - enabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - HOUR repeat_interval_measure: type: integer minimum: 1 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 55 - type: object title: Daily Schedule description: Schedule job daily required: - schedule_status - start_date - start_hour - start_min - repeat_interval_unit - repeat_interval_measure properties: schedule_status: type: string enum: - enabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - DAY repeat_interval_measure: type: integer minimum: 1 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 55 is_custom_job: type: boolean description: '`custom_job_details` must be provided when `is_custom_job=true` ' default: false example: true custom_job_details: type: object required: - starts_daily_at - ends_daily_at - repeat_interval_measure - repeat_interval_unit properties: starts_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '12:40' ends_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '17:45' repeat_interval_measure: type: integer minimum: 1 example: 10 repeat_interval_unit: type: string enum: - MINUTE - HOUR - type: object title: Weekly Schedule description: Schedule job weekly required: - schedule_status - start_date - start_hour - start_min - repeat_interval_unit - repeat_interval_measure - specified_days properties: schedule_status: type: string enum: - enabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - WEEK repeat_interval_measure: type: integer minimum: 1 specified_days: type: array minLength: 1 items: type: integer minimum: 0 maximum: 6 example: - 0 - 2 - 5 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 55 is_custom_job: type: boolean description: '`custom_job_details` must be provided when `is_custom_job=true` ' default: false example: true custom_job_details: type: object required: - starts_daily_at - ends_daily_at - repeat_interval_measure - repeat_interval_unit properties: starts_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '12:40' ends_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '17:45' repeat_interval_measure: type: integer minimum: 1 example: 10 repeat_interval_unit: type: string enum: - MINUTE - HOUR - type: object title: Monthly Schedule description: Schedule job monthly required: - schedule_status - start_date - start_hour - start_min - repeat_interval_unit - repeat_interval_measure properties: schedule_status: type: string enum: - enabled example: enabled start_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: Start time should be after current time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 start_hour: type: integer minimum: 0 maximum: 23 example: 14 start_min: type: integer minimum: 0 maximum: 59 example: 35 repeat_interval_unit: type: string enum: - MONTH repeat_interval_measure: type: integer minimum: 1 repeat_on_last_day: type: boolean description: '`specified_days` must be provided if `repeat_on_last_day` is false. ' default: false specified_days: type: array minLength: 1 items: type: integer minimum: 1 maximum: 31 example: - 1 - 17 - 31 ends: type: boolean description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`. ' default: false example: true end_date: pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$ type: string description: End time should be after start time. format: date-month'/'date-mday'/'date-fullyear example: 08/28/2023 end_hour: type: integer minimum: 0 maximum: 23 example: 15 end_min: type: integer minimum: 0 maximum: 59 example: 45 is_custom_job: type: boolean description: '`custom_job_details` must be provided when `is_custom_job=true` ' default: false example: true custom_job_details: type: object required: - starts_daily_at - ends_daily_at - repeat_interval_measure - repeat_interval_unit properties: starts_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '12:40' ends_daily_at: pattern: ^{0-23}:[0-59]$ type: string example: '17:45' repeat_interval_measure: type: integer minimum: 1 example: 10 repeat_interval_unit: type: string enum: - MINUTE - HOUR iw_mappings: type: array items: oneOf: - type: object properties: entity_type: type: string example: pipeline recommendation: type: object properties: {} to_entity_id: type: string example: e77850ad5127a2d7dab870ff - type: object properties: entity_type: type: string example: pipeline recommendation: type: object properties: pipeline_name: type: string example: Workflow_Pipeline_1 domain_name: type: string example: Automation_domain selected_versions: type: array items: type: object properties: version_id: type: string example: 648845a0007ecf1a1c550c5f version: type: number example: 1 to_entity_id: type: string example: e77850ad5127a2d7dab870ff entity: type: object properties: entity_id: type: string example: e77850ad5127a2d7dab870ff entity_type: type: string enum: - workflow entity_name: type: string example: example_workflow export: type: object properties: exported_at: type: string exported_by: type: string exported_by_username: type: string - type: object properties: dry_run: type: boolean example: true - type: object properties: import_configs: type: object properties: map_active_version: type: boolean example: true responses: '200': description: Success 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: entity_type: type: string example: pipeline recommendation: type: object properties: {} to_entity_id: type: string example: e77850ad5127a2d7dab870ff - type: object properties: error: type: string example: Exmaple Error '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}/workflows/{workflow_id}/start: post: security: - BearerAuth: [] operationId: startWorkflow summary: Runs the latest workflow description: Runs the latest workflow with the provided `workflow_id`, `domain_id`, and returns `workflow_run_id`. tags: - Workflows parameters: - name: domain_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string example: f132c1fa46e1e7f8fb1cf566 - name: workflow_version_id in: query required: false description: ID of the workflow version to run. If omitted, the active version is used. schema: type: string example: e77850ad5127a2d7dab870ff requestBody: description: Optional Request Body containing Workflow Parameters to be submitted at Runtime and skip nodes to skip the workflow tasks at Runtime. content: application/json: schema: type: object properties: workflow_parameters: type: array items: type: object properties: key: type: string example: parameter_key value: type: string example: parameter_value skip_nodes: type: array items: type: string responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: 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}/workflows/{workflow_id}/pause: post: security: - BearerAuth: [] operationId: pauseWorkflow summary: This will pause all running builds of `workflow` with `{workflow_id}`. description: This will pause all running builds of `workflow` with `{workflow_id}`. tags: - Workflows parameters: - name: domain_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string example: f132c1fa46e1e7f8fb1cf566 - name: workflow_version_id in: query required: true description: ID of the workflow version to pause. schema: type: string example: e77850ad5127a2d7dab870ff responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: object properties: id: type: string example: e77850ad5127a2d7dab870ff '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /domains/{domain_id}/workflows/{workflow_id}/resume: post: security: - BearerAuth: [] operationId: resumeWorkflow summary: This will resume all paused builds of `workflow` with `{workflow_id}`. description: This will resume all paused builds of `workflow` with `{workflow_id}`. tags: - Workflows parameters: - name: domain_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string example: f132c1fa46e1e7f8fb1cf566 - name: workflow_version_id in: query required: true description: ID of the workflow version to resume. schema: type: string example: e77850ad5127a2d7dab870ff responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: object properties: id: type: string example: e77850ad5127a2d7dab870ff '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /domains/{domain_id}/workflows/{workflow_id}/lineage: get: security: - BearerAuth: [] operationId: getWorkflowLineage summary: Get workflow lineage description: 'Retrieves the workflow lineage ' tags: - Workflows parameters: - name: domain_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string example: f132c1fa46e1e7f8fb1cf566 responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: array items: type: object properties: id: type: string example: e77850ad5127a2d7dab870ff lineage: type: array items: type: object properties: id: type: string example: 3e2c83ee872d3ba03ed612ce lineage: type: array items: type: object example: - id: 3e2c83ee872d3ba03ed612ce lineage: [] '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}/workflows/{workflow_id}/ancestors: get: security: - BearerAuth: [] operationId: getWorkflowAncestors summary: Get workflow ancestors description: 'Retrieves the workflow ancestors ' tags: - Workflows parameters: - name: domain_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string example: f132c1fa46e1e7f8fb1cf566 responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: array description: Workflow IDs of ancestors items: 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}/workflows/{workflow_id}/runs: get: security: - BearerAuth: [] operationId: getWorkflowRunsByWorkflowId summary: This will get all builds of `workflow` with `{workflow_id}`. description: This will get all builds of `workflow` with `{workflow_id}`. tags: - Workflows parameters: - name: domain_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string example: f132c1fa46e1e7f8fb1cf566 - name: offset in: query description: The number of items to skip before starting to collect the result set schema: type: integer default: 0 - name: limit in: query description: The numbers of items to return schema: type: integer default: 10 - name: sort_by in: query description: Sort result on field schema: type: string - name: order_by in: query description: order ascending | descending schema: type: string default: asc enum: - asc - desc - name: filter in: query description: Filter results query schema: type: string - name: Content-Type in: header description: Http content type required: true schema: type: string enum: - application/json - multipart/form-data - text/plain default: application/json responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: limit: type: integer example: 10 offset: type: integer example: 0 links: type: object properties: base: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains} self: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0 next: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10 total_count: type: integer example: 10 x-examples: example-1: {} - type: object properties: result: type: array items: allOf: - type: object properties: workflow_name: type: string example: example_workflow job_progress: type: integer example: 87 workflow_id: type: string example: e77850ad5127a2d7dab870ff build_number: type: integer example: 5 triggered_at: type: string example: '2019-11-21T12:54:05.875Z' triggered_by: type: object properties: id: type: string example: 6RkfybTRQQByEey3v type: type: string enum: - user - wow_run workflow_version_id: type: string example: e77850ad5127a2d7dab870ff child_workflow_ids: type: array items: type: string example: e77850ad5127a2d7dab870ff workflow_graph: type: object properties: tasks: type: array items: type: object properties: is_group: type: boolean example: false task_id: type: string example: SI_BS78 task_type: type: string example: ingest_table_group location: type: string example: -237 52 title: type: string example: ingest task_properties: type: object properties: {} run_properties: type: object properties: enable_exponential_backoff_for_retries: type: boolean example: true num_retries: type: integer minimum: 0 example: 5 retry_delay: type: integer example: 200 max_retry_delay: type: integer example: 1000 trigger_rule: type: string enum: - all_success - all_done - all_failed - one_failed - one_success environment_variables_conf: description: List of additional environment variable config for bash node. type: array items: type: object required: - name - config_type properties: name: type: string example: RDBMS_PASSWORD config_type: type: string example: KEYVAULT enum: - KEYVAULT - ADMIN config_name: type: string example: iw_admin_conf secret_id: type: string example: e77850ad5127a2d7dab870ff workflow_variables: type: array items: type: object properties: key: type: string example: job_id value: type: string example: e77850ad5127a2d7dab870ff edges: type: array items: type: object properties: category: type: string from_task: type: string to_task: type: string task_id: type: number workflow_parameters: type: array items: type: object properties: key: type: string example: parameter_key value: type: string example: parameter_value workflow_status: type: object properties: run_id: type: string example: e77850ad5127a2d7dab870ff state: type: string enum: - success - failed - pending - running start_date: type: string example: '2019-11-21T12:54:05.875Z' end_date: type: string example: '2019-11-21T12:54:05.875Z' tasks_status: type: array items: type: object properties: task_id: type: string example: e77850ad5127a2d7dab870ff task_state: type: string example: failed task_title: type: string example: ingest_table_group task_start_time: type: string example: '2019-11-21T12:54:05.875Z' task_end_time: type: string example: '2019-11-21T12:54:05.875Z' - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - 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 /domains/{domain_id}/workflows/{workflow_id}/runs/{workflow_run_id}: get: security: - BearerAuth: [] operationId: getWorkflowRun summary: This will get a specific build of `workflow` with `{workflow_id}`. description: This will get a specific build of `workflow` with `{workflow_id}`. tags: - Workflows parameters: - name: domain_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string example: f132c1fa46e1e7f8fb1cf566 - name: Content-Type in: header description: Http content type required: true schema: type: string enum: - application/json - multipart/form-data - text/plain default: application/json - name: workflow_run_id in: path required: true schema: type: string example: af690b4324090bd09da4505d responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: allOf: - type: object properties: workflow_name: type: string example: example_workflow job_progress: type: integer example: 87 workflow_id: type: string example: e77850ad5127a2d7dab870ff build_number: type: integer example: 5 triggered_at: type: string example: '2019-11-21T12:54:05.875Z' triggered_by: type: object properties: id: type: string example: 6RkfybTRQQByEey3v type: type: string enum: - user - wow_run workflow_version_id: type: string example: e77850ad5127a2d7dab870ff child_workflow_ids: type: array items: type: string example: e77850ad5127a2d7dab870ff workflow_graph: type: object properties: tasks: type: array items: type: object properties: is_group: type: boolean example: false task_id: type: string example: SI_BS78 task_type: type: string example: ingest_table_group location: type: string example: -237 52 title: type: string example: ingest task_properties: type: object properties: {} run_properties: type: object properties: enable_exponential_backoff_for_retries: type: boolean example: true num_retries: type: integer minimum: 0 example: 5 retry_delay: type: integer example: 200 max_retry_delay: type: integer example: 1000 trigger_rule: type: string enum: - all_success - all_done - all_failed - one_failed - one_success environment_variables_conf: description: List of additional environment variable config for bash node. type: array items: type: object required: - name - config_type properties: name: type: string example: RDBMS_PASSWORD config_type: type: string example: KEYVAULT enum: - KEYVAULT - ADMIN config_name: type: string example: iw_admin_conf secret_id: type: string example: e77850ad5127a2d7dab870ff workflow_variables: type: array items: type: object properties: key: type: string example: job_id value: type: string example: e77850ad5127a2d7dab870ff edges: type: array items: type: object properties: category: type: string from_task: type: string to_task: type: string task_id: type: number workflow_parameters: type: array items: type: object properties: key: type: string example: parameter_key value: type: string example: parameter_value workflow_status: type: object properties: run_id: type: string example: e77850ad5127a2d7dab870ff state: type: string enum: - success - failed - pending - running start_date: type: string example: '2019-11-21T12:54:05.875Z' end_date: type: string example: '2019-11-21T12:54:05.875Z' tasks_status: type: array items: type: object properties: task_id: type: string example: e77850ad5127a2d7dab870ff task_state: type: string example: failed task_title: type: string example: ingest_table_group task_start_time: type: string example: '2019-11-21T12:54:05.875Z' task_end_time: type: string example: '2019-11-21T12:54:05.875Z' - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - 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 /domains/{domain_id}/workflows/{workflow_id}/runs/{workflow_run_id}/restart: post: security: - BearerAuth: [] operationId: restartWorkflowRun summary: This will restart running `workflow` with `{workflow_id}`. description: This will restart running `workflow` with `{workflow_id}`. tags: - Workflows parameters: - name: domain_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string example: f132c1fa46e1e7f8fb1cf566 - name: workflow_run_id in: path required: true schema: type: string example: af690b4324090bd09da4505d requestBody: description: Optional Request Body containing Skip Nodes to be skip workflow tasks at Runtime. content: application/json: schema: type: object properties: skip_nodes: type: array items: type: string responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: 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}/workflows/{workflow_id}/runs/{workflow_run_id}/cancel: post: security: - BearerAuth: [] operationId: cancelWorkflowRun summary: This will cancel running `workflow` with `{workflow_id}` for build with `workflow_run_id`. description: This will cancel running `workflow` with `{workflow_id}` for build with `workflow_run_id`. tags: - Workflows parameters: - name: domain_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string example: f132c1fa46e1e7f8fb1cf566 - name: workflow_run_id in: path required: true schema: type: string example: af690b4324090bd09da4505d responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: object properties: id: type: string example: e77850ad5127a2d7dab870ff '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /domains/{domain_id}/workflows/{workflow_id}/runs/{workflow_run_id}/tasks/{task_id}/logs: get: security: - BearerAuth: [] operationId: getWorkflowRunTaskLogsByAttempt summary: Get task logs for a workflow run description: 'Retrieves the logs for a specific task in a workflow run. It fetches logs for the latest attempt by default if `try_number` is not specified. ' tags: - Workflows parameters: - name: domain_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string example: f132c1fa46e1e7f8fb1cf566 - name: workflow_run_id in: path required: true schema: type: string example: af690b4324090bd09da4505d - name: task_id in: path required: true schema: type: string example: SI_F50E - name: try_number in: query required: false schema: type: integer minimum: 1 responses: '200': description: Success headers: try-number: schema: type: integer minimum: 1 example: 2 description: Attempt number for retrieved task logs total-attempts: schema: type: integer minimum: 1 example: 4 description: Total attempts for the task content: text/plain: schema: type: string description: Task log '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}/workflows/{workflow_id}/runs/{workflow_run_id}/tasks/{task_id}/logs/download: get: security: - BearerAuth: [] operationId: downloadWorkflowRunTaskLogs summary: Download task logs for a workflow run description: 'Downloads the logs for a specific task in a workflow run. The downloaded zip file will contain logs for all attempts of that task for that particular workflow run. ' tags: - Workflows parameters: - name: domain_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string example: f132c1fa46e1e7f8fb1cf566 - name: workflow_run_id in: path required: true schema: type: string example: af690b4324090bd09da4505d - name: task_id in: path required: true schema: type: string example: SI_F50E responses: '200': description: Success content: application/zip: schema: type: string format: binary '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}/workflows/{workflow_id}/parents: get: security: - BearerAuth: [] operationId: getWorkflowParents tags: - Workflows summary: Gets parents workflow details of the workflow description: Gets parents workflow details of the workflow. parameters: - name: domain_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string example: f132c1fa46e1e7f8fb1cf566 responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message type: object properties: result: allOf: - allOf: - type: object properties: workflow_parents: type: array items: type: object properties: id: type: string example: 67062be0d4876873f1276852 name: type: string example: w3 '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}/workflows/{workflow_id}/runs/{workflow_run_id}/tasks/{task_id}/variables: post: security: - BearerAuth: [] operationId: setWorkflowVariableForWorkflowRun tags: - Workflows summary: Set workflow variables for a task in a workflow run description: Set workflow variables for a task in a workflow run with `{workflow_run_id}` for workflow with `{workflow_id}` in domain with `{domain_id}`. parameters: - name: domain_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string example: f132c1fa46e1e7f8fb1cf566 - name: workflow_run_id in: path required: true schema: type: string example: af690b4324090bd09da4505d - name: task_id in: path required: true schema: type: string example: SI_F50E requestBody: description: This is the JSON body of request containing workflow variable. content: application/json: schema: type: object properties: key: type: string example: variable_key value: type: string example: variable_value responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /prodops/workflow_runs: post: security: - BearerAuth: [] summary: Get Workflows description: Get Workflows runs (This operation is only for `operations_analyst` user) tags: - Workflows requestBody: content: application/json: schema: type: object required: - date_range properties: date_range: oneOf: - type: object required: - type - unit - value properties: type: type: string example: last unit: type: string enum: - day - hour example: day value: type: integer example: 6 - type: object required: - type - start_date - end_date properties: type: type: string example: custom start_date: type: integer example: 1652355912000 end_date: type: integer example: 1652355912000 order_by: type: string enum: - asc - desc minLength: 1 example: asc default: desc sort_by: type: string example: createdAt minLength: 1 offset: type: integer example: 5 minimum: 0 limit: type: integer example: 10 default: 20 minimum: -1 run_time_hour: type: integer example: 0.2 minimum: 0 default: Infinity domain_ids: type: array items: type: string example: e77850ad5127a2d7dab870ff source_ids: type: array items: type: string example: e77850ad5127a2d7dab870ff entity_type: type: string minLength: 1 example: source enum: - pipeline - source status: type: string minLength: 1 items: type: string enum: - success - failed - pending - running additional_filters: type: object example: _id: $in: - $oid: 2154859ca27ec87b09f39303 responses: '200': description: Ok. content: application/json: schema: allOf: - type: object properties: limit: type: integer example: 10 offset: type: integer example: 0 links: type: object properties: base: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains} self: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0 next: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10 total_count: type: integer example: 10 x-examples: example-1: {} - type: object properties: message: type: string example: Example Success Message - properties: result: type: object properties: total_count: type: integer minimum: 0 description: Total count of workflows example: 10 items: type: array items: type: object allOf: - type: object properties: created_by: type: string example: 6RkfybTRQQByEey3v - properties: created_by_user_email: type: string description: User email example: admin@infoworks.io created_by_user_name: type: string description: User name example: Infoworks Admin domain_id: type: string example: e77850ad5127a2d7dab870ff domain_name: type: string description: Domain name is_paused: type: boolean example: false last_exec_end_time: type: string example: '2022-06-14 07:55:57.334000+00:00' last_exec_start_time: type: string example: '2022-06-14 07:55:55.549158+00:00' last_exec_status: type: string example: success workflow_id: type: string example: e77850ad5127a2d7dab870ff workflow_name: type: string example: new_workflow '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /prodops/workflow_runs/{run_id}/jobs: parameters: - name: run_id in: path description: Cluster Job Run Id required: true schema: type: string get: security: - BearerAuth: [] operationId: getProdopsJobs tags: - Workflows summary: Retrieves the job details description: Retrieve the details and status of any job. This is applicable only for the Operations Analyst user. responses: '200': description: Ok. content: application/json: schema: allOf: - type: object properties: limit: type: integer example: 10 offset: type: integer example: 0 links: type: object properties: base: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains} self: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0 next: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10 total_count: type: integer example: 10 x-examples: example-1: {} - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: array items: type: object properties: id: type: string example: 8714887c9a8c5bb0b8794811 build_id: type: integer example: 2 name: type: string example: test_job status: type: string enum: - completed - pending - aborted - blocked - failed - running - canceled - succeeded example: completed percentage: type: integer example: 100 type: type: string enum: - source_test_connection - fetch_metadata - source_structured_fetch_metadata - source_crawl - source_crawl_chunk_load - source_cdc - source_unstructured_crawl - source_structured_crawl - source_semistructured_crawl - delete_entity - pipeline_metadata - pipeline_build - pipeline_build_restatement - full_load - cdc - source_merge - source_structured_cdc_merge - source_structured_cdc - source_cdc_merge - source_cdc_restatement - source_semistructured_cdc_merge - source_semistructured_cdc - metadata_cleanup_policy entity_id: type: string example: d2f33c1d424363162692b3bf entity_type: type: string enum: - source - pipeline - workflow sub_entity_id: type: string example: be034607444511f74313be63 sub_entity_type: type: string example: table_group duration: type: integer example: 349316 description: This is duration of the job. cluster_id: type: string example: j-134jnasdkjaasd description: Extenal clusterId compute_id: type: string example: be034607444511f74313be63 description: Infoworks compute cluster id compute_name: type: string example: Default_Persistent_cluster description: Infoworks compute name created_at: type: string format: date-time example: '2020-10-05T04:23:30.339Z' created_by: type: string example: 6RkfybTRQQByEey3v description: UserId of user who triggered the job. last_updated: type: string example: '2019-11-21T12:54:05.875Z' processed_at: type: string example: '2019-11-21T12:54:05.875Z' '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /prodops/workflows/restart: post: security: - BearerAuth: [] operationId: restartMultipleWorkflowRunsForProdOps tags: - Workflows summary: Restart Multiple Workflows description: Restart Multiple Workflows (This operation is only for `operations_analyst` user) requestBody: content: application/json: schema: type: object properties: ids: type: array items: type: object properties: workflow_id: type: string example: e77850ad5127a2d7dab870ff run_id: type: string example: e77850ad5127a2d7dab870ff skip_nodes: type: array items: type: string example: DM_AA38 responses: '200': description: Ok. content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - properties: result: type: object properties: ids: type: array items: type: object properties: workflow_id: type: string example: e77850ad5127a2d7dab870ff run_id: type: string example: e77850ad5127a2d7dab870ff error: type: - string - 'null' example: Example Error Message '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 /prodops/workflows/cancel: post: security: - BearerAuth: [] operationId: cancelMultipleWorkflowRunsForProdOps tags: - Workflows summary: Cancel Multiple Workflows description: Cancel Multiple Workflows (This operation is only for `operations_analyst` user) requestBody: content: application/json: schema: type: object properties: ids: type: array items: type: object properties: workflow_id: type: string example: e77850ad5127a2d7dab870ff run_id: type: string example: e77850ad5127a2d7dab870ff skip_nodes: type: array items: type: string example: DM_AA38 responses: '200': description: Ok. content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 components: securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT BasicAuth: type: http scheme: basic