Infoworks Workflow Versions API

Workflow Versions CRUD Operations

Documentation GitHub OpenAPI

Operations 8

GET /domains/{domain_id}/workflows/{workflow_id}/versions Get all versions of a workflow #

POST /domains/{domain_id}/workflows/{workflow_id}/versions Create a new version of a workflow #

GET /domains/{domain_id}/workflows/{workflow_id}/versions/{workflow_version_id} Get a specific version of a workflow #

PUT /domains/{domain_id}/workflows/{workflow_id}/versions/{workflow_version_id} Update a specific version of a workflow #

DELETE /domains/{domain_id}/workflows/{workflow_id}/versions/{workflow_version_id} Delete a specific version of a workflow #

GET /domains/{domain_id}/workflows/{workflow_id}/versions/{workflow_version_id}/audits Get audit logs for a specific version of a workflow #

POST /domains/{domain_id}/workflows/{workflow_id}/versions/{workflow_version_id}/set-active Set a specific version of a workflow as active #

POST /domains/{domain_id}/workflows/{workflow_id}/versions/{workflow_version_id}/tasks/{task_id}/variables Set workflow variables for a task in a specific version of a workflow #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/infoworks-workflow-versions-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  contact: {}
  title: Infoworks Rest API V3 Workflow Versions 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: Workflow Versions
  description: Workflow Versions CRUD Operations
paths:
  /domains/{domain_id}/workflows/{workflow_id}/versions:
    get:
      security:
      - BearerAuth: []
      operationId: getWorkflowVersions
      tags:
      - Workflow Versions
      summary: Get all versions of a workflow
      description: Get all versions of 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
      - name: offset
        in: query
        description: The number of items to skip before starting to collect the result set
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: The numbers of items to return
        schema:
          type: integer
          default: 10
      - name: sort_by
        in: query
        description: Sort result on field
        schema:
          type: string
      - name: order_by
        in: query
        description: order  ascending | descending
        schema:
          type: string
          default: asc
          enum:
          - asc
          - desc
      - name: filter
        in: query
        description: Filter results query
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    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:
                            version:
                              type: number
                              example: 1
                            description:
                              type: string
                              example: Initial version of the workflow
                            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
                            child_workflow_version_ids:
                              type: array
                              items:
                                type: string
                                example: d5a2c3fa46e1e7f8fb1cf123
                            workflow_parameters:
                              type: array
                              items:
                                type: object
                                properties:
                                  key:
                                    type: string
                                    example: parameter_key
                                  value:
                                    type: string
                                    example: parameter_value
                            view_options:
                              type: object
                              properties:
                                zoom_level:
                                  type: number
                                  example: 1
                                pan_position:
                                  type: object
                                  properties:
                                    x:
                                      type: number
                                      example: 0
                                    y:
                                      type: number
                                      example: 0
                            is_paused:
                              type: boolean
                              example: false
                            is_active:
                              type: boolean
                              example: false
                        - 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:
                            workflow_id:
                              type: string
                              example: f132c1fa46e1e7f8fb1cf566
                            created_by_name:
                              type: string
                              example: Admin
                            modified_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: createWorkflowVersion
      tags:
      - Workflow Versions
      summary: Create a new version of a workflow
      description: Create a new version of 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
      - name: source_workflow_version_id
        in: query
        required: true
        schema:
          type: string
          example: f132c1fa46e1e7f8fb1cf566
      requestBody:
        description: This is the JSON body of request containing configured Workflow Version object.
        content:
          application/json:
            schema:
              type: object
              properties:
                version:
                  type: number
                  example: 1
                description:
                  type: string
                  example: Initial version of the workflow
                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
                child_workflow_version_ids:
                  type: array
                  items:
                    type: string
                    example: d5a2c3fa46e1e7f8fb1cf123
                workflow_parameters:
                  type: array
                  items:
                    type: object
                    properties:
                      key:
                        type: string
                        example: parameter_key
                      value:
                        type: string
                        example: parameter_value
                view_options:
                  type: object
                  properties:
                    zoom_level:
                      type: number
                      example: 1
                    pan_position:
                      type: object
                      properties:
                        x:
                          type: number
                          example: 0
                        y:
                          type: number
                          example: 0
                is_paused:
                  type: boolean
                  example: false
                is_active:
                  type: boolean
                  example: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      type: 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}/versions/{workflow_version_id}:
    get:
      security:
      - BearerAuth: []
      operationId: getWorkflowVersion
      tags:
      - Workflow Versions
      summary: Get a specific version of a workflow
      description: Get a specific version of 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
      - name: workflow_version_id
        in: path
        required: true
        schema:
          type: string
          example: d5a2c3fa46e1e7f8fb1cf123
      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:
                          version:
                            type: number
                            example: 1
                          description:
                            type: string
                            example: Initial version of the workflow
                          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: st

# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/openapi/infoworks-workflow-versions-api-openapi.yml