Documentation for Versions 2.x, 3.1.
Infoworks Rest API V3
Authentication
Security
GETGet `authentication_token` with `username` and `password`.
GETGet `authentication_token` with `refresh_token`.
DELETEPurge authentication token
GETValidate `authentication_token` if its active or not.
Users
GETGet the User details
POSTCreate a new User
GETGet the details of the user linked with the user_id
DELETEDelete a user.
PATCHUpdate the User
POSTAdd the domain to the user linked with the user_id
Environment
GETGet the list of environments
POSTCreate a new environment
GETGet the environment id details
GETGet the environment id storage details
POSTCreate storage for environment id
GETGet the environment storage id storage details
GETGet List of ephemeral computes for environment
POSTCreate ephemeral cluster
GETGet ephemeral computes for environment by id
GETGet the list of environments interactive (persistent) templates
POSTCreate an interactive compute
GETGet persistent computes for environment by id
Sources
GETGet list of sources
POSTCreate source
GETGet Source Info
DELETEDelete source
PATCHUpdate source
GETBrowse source
POSTAdd query tables
Connections
GETGet source connection details
PUTUpdate an existing source connection
Source Configurations
POSTAdd advanced configuration to the source
GETGet all advanced configuration of the source
GETGet a source advanced configuration
PUTUpdate a source advanced configuration
DELETEDelete a source advanced configuration
GETGet source Configuration
Generic Source Types
GETGet Generic Source Types List
POSTRegister or Create Generic Source Type
GETGet Generic Source Type By Id
PATCHUpdate Generic Source Type By Id
DELETEDelete Generic Source Type By Id
GETGet all files in Generic Source Type by id
POSTadd file in Generic Source Type by id
Topics
GETGet a list of all topics mapping.
POSTCreate Topic Mapping For Source
GETGet topic mapping id.
PATCHUpdate Topic Mapping For Source
DELETEDelete Topic Mapping For Source
GETGet topics From Source
GETGet topic Preview
GETCrawl Schema For Topic Mapping
GETGet Table Schema From Mapping
POSTCreate Streaming Table
GETGet Streaming Table
DELETEDelete Streaming Table
DELETEDelete JSON Source Table
File Mappings
GETGet File Mappings for JSON source
POSTCreate File Mapping For JSON Source
GETGet File Mappings for JSON source by id
DELETEDelete File Mapping For JSON Source
PATCHUpdate File Mapping For JSON Source
GETGet File Mapping Data Preview
GETCrawl Schema For File Mapping
GETGet Table Schema From Mapping
POSTCreate JSON Source Table
GETGet JSON Source Table
Streaming
PUTAdd/Edit Configuration for streaming options of a table group.
GETGet streaming configuration of given table.
GETGet tables for whom streaming configurations are set in a particular source.
GETGet streaming table info.
Tables
POSTCreates the file mapping (table) of the csv source.
PUTModifies the file mapping (table) of the csv source.
PATCHUpdates the file mapping (table) of the csv source.
PUTupdate source metadata
GETget source metadata
GETget whether staging fields can be edited
GETGet the list of Source Files paths of the table
GETlist all the tables in the source
POSTadd Table for CSV/Fixed Width source
GETGet Table Info
POSTadd the tables to a source and crawl metadata of those added tables
PUTUpdates and configures the table for Ingestion
GETGet ingestion configuration of table
GETGet list of Entity advance configuration
POSTAdd advance configuration for a table
GETGet table advance configuration
PUTupdate advance configuration for a table
DELETEDelete advance configuration for a table
PUTupdate table export configuration
GETget table export configuration
PATCHupdate table column order
PUTupdate table metadata
GETget table metadata
GETGet table export configuration connection properties
PUTupdate table export configuration Connection properties
POSTStart Segmentation on a Table
POSTCrawl Segments Metadata on a Table
GETGet Table Segments of a Table
POSTEnd Segmentation on a Table
POSTCancel Segmentation on a Table
GETGet the schema of the table
PUTUpdate the schema of the table
GETconfigurations
GETGet a list of all table segments.
GETGets Validation Specs for a Table.
POSTAdd Validation Specs to a Table.
PATCHUpdates the Validation Specs for a table.
DELETEDelete Validation Specs for a Table
Table Groups
POSTAdd a `Table Group`.
GETGets `Table Group` list.
GETGets `Table Group` object for given id.
PUTUpdate `Table Group` object for given id.
DELETE{table_group_id}
POSTThis will Configure particular `Table Group` with `tableGroupId`.
GETThis will fetch array of audit logs for table group with `tableGroupId`.
Domains
GETGet the Target Data Connection
PUTEdit the Target Data Connections Associated with a Domain
PATCHPatch the Target Data Connection
DELETEDelete the Target Data Connections Associated with a Domain
GETGet List of Domains
POSTAdd a domain. (Requires Admin Access)
GETGet description of a domain_id. (Requires Admin Access)
PATCHEdit name and description of a domain. (Requires Admin Access)
DELETEDelete a Domain (Requires Admin Access).
GETGet all the Sources associated with this Domain
POSTAdd Sources to this Domain (Requires Admin Access)
PUTUpdate Sources to this Domain (Requires Admin Access)
DELETERemove Source from this Domain (Requires Admin Access)
GETGet all the Domains associated with this Domain
POSTAdd Domains to this Domain (Requires Admin Access)
PUTUpdate accessible-domain in this Domain (Requires Admin Access)
DELETERemove Domain from this Domain (Requires Admin Access)
GETGet all the Pipeline Extensions associated with this Domain
PUTUpdate accessible-pipeline-extensions in this Domain (Requires Admin Access)
POSTAdd Pipeline Extensions to this Domain (Requires Admin Access)
DELETERemove Pipeline Extension from this Domain (Requires Admin Access)
PUT{key}
PATCH{key}
DELETE{key}
Pipelines
POSTChange the active version of the Pipeline
GETGet all pipelines for domain with `domain_id`
POSTcreate new pipeline for domain with `domain_id`
GETGets a `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
DELETEDeletes a `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
PUTUpdates a `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
GETGet list of all versions of Pipeline
POSTCreate a pipeline version
GETGets a `pipelineVersion` with `pipeline_version_id` of `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
DELETEDeletes a `pipelineVersion` with `pipeline_version_id` of `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
PUTUpdate a `pipelineVersion` with `pipeline_version_id` of `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
POSTimportSql
GETExports the pipeline configuration
POSTImports the pipeline configuration
GETGets lineage for Pipeline Column.
Pipeline Extensions
GETGet Pipeline Extensions List
POSTGet Pipeline Extensions List
GETGet Pipeline Extension by id
PUTUpdate Pipeline Extension by id
DELETEDelete Pipeline Extension by id
GETGet all files in Pipeline Extension by id
POSTadd file in Pipeline Extension by id
POSTGet Pipeline Extensions List
Source Extensions
GETGet Source Extensions List
GETGet Source Extension by id
PUTUpdate Source Extension by id
DELETEDelete Source Extension by id
GETGet all files in Source Extension by id
POSTadd file in Source Extension by id
DELETEDelete File from Source Extension by file name
Workflows
GETGet list of all Workflows for a `domain` with `{domain_id}`.
POSTCreate Workflow for a `domain` with `{domain_id}`.
GETGets a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`.
DELETEDeletes a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`.
PATCHUpdate a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`.
GETExports workflow configuration
PUTImports workflow configuration
POSTRuns the latest workflow
POSTThis will pause all running builds of `workflow` with `{workflow_id}`.
POSTThis will resume all paused builds of `workflow` with `{workflow_id}`.
GETThis will get all builds of `workflow` with `{workflow_id}`.
GETThis will get a specific build of `workflow` with `{workflow_id}`.
POSTThis will restart running `workflow` with `{workflow_id}`.
POSTThis will cancel running `workflow` with `{workflow_id}` for build with `workflow_run_id`.
POSTGet Workflows
GETRetrieves the job details
POSTRestart Multiple Workflows
POSTCancel Multiple Workflows
Workflows Schedules
GETSchedules of Workflows belonging to this Domain.
GETSchedules of particular Workflow belonging to this Domain.
PUTEnable Workflow Schedule
PUTDisable Workflow Schedule
PUTChange Workflow Schedule User
Jobs
GETGet the jobs details
GETGet the job details with `job_id`
POSTResubmit Failed tables for ingestion
GETGet the job log as text stream with `job_id`
GETDownload iw job logs zip for iw_job with job_id
GETGet cluster jobs for iw_job with job_id
GETGet cluster job for iw_job with job_id and run_id
GETDownload cluster job logs zip for iw_job with job_id and run_id
GETGet the admin-jobs details
GETGet List of All jobs of this Source and it's artifacts.
POSTInitiates jobs for source and its artifacts
GETGet job with job id.
POSTResubmit Failed tables for ingestion
GETGet crawl job info.
GETGet Summary Logs for the Source Crawl Job.
GETGet Summary Logs for the Source Crawl Job.
GETGet Interactive Jobs List
GETGet Interactive Job by id
GETGets List of Pipeline Jobs.
POSTSubmit Pipeline Job.
GETGets Pipeline Job.
POSTSubmit Pipeline Job.
POSTGet the jobs details
GETGet the job details with `job_id`
GETCancel the job with `job_id`
GETResubmit Failed tables for ingestion
GETGets List of Pipeline Jobs.
POSTSubmit Pipeline Job.
GETGets Pipeline Groups Job.
GETGets Pipeline Groups Job.
GETGets Pipeline Groups Job.
GETGet the job log as text stream with `job_id`
GETDownload iw job logs zip for iw_job with job_id
Job Hooks
GETGet Job Hooks List
POSTCreate a Job Hook
GETGet Job Hook By Id
PATCHUpdate Job Hook Type By Id
DELETEDelete Job Hook By Id
GETGet all files in Job Hook by id
POSTadd file in Job Hook by id
License
GETGet Active License Violations
GETGet Active License
GETGet All Licenses
Pipeline Groups
POSTCreate Pipeline Groups
GETGet all pipeline groups for domain with `domain_id`
GETGet pipeline group
DELETEDelete Pipeline Group
PATCHUpdate Pipeline Group
GETGet Accessible pipeline group
GETGets List of Advance Config pipeline group.
POSTAdvance Configuration Pipeline Group.
GETGet Pipelinegroup advance configuration
PUTupdate advance configuration for a pipeline group
DELETEDelete advance configuration for a pipeline group
Admin Configurations
GETGet all General Configurations for Infoworks.
PUTReplace General Configurations for Infoworks.
GETGets `Mongo Backups` list.
GETGets Mongo Backup With Specified Id.
POSTStart Mongo Backup
GETGet the Schedule of the Mongo Backup.
PUTSchedule Mongo Backup.
PUTSchedule Mongo Backup.
GETGet the type of the Authentication and associated properties.
PUTChange the Authentication Mechanism
PATCHChange the Authentication Mechanism
POSTTest the Authentication Mechanism's Connection.
Admin Metadata Cleanup
GETGet metadata cleanup policies.
GETGet Jobs cleanup policy.
PUTEdit the Jobs Cleanup Policy
GETGet Audits cleanup policy.
PUTEdit the Audits Cleanup Policy
GETGet Metrics cleanup policy.
PUTEdit the Metrics Cleanup Policy
GETGet Schedule of cleanup policy.
PUTEdit Schedule of cleanup policy.
PUTEdit Schedule of cleanup policy.
PUTEdit Scheduling User of cleanup policy. Hit this API with the delegation token of the required User.
Admin Workflows
POSTPause Multiple Workflows
POSTResume Multiple Workflows
POSTRestart Multiple Workflows
POSTCancel Multiple Workflows
GETRetrieves the status of workflow
GETGet Workflows
GETGet Workflows tasks
GETGet Workflow run Id details
Metrics
GETGet the Ingestion-metrics of the table with job_id
GETGet the Export-metrics of the table with job_id
GETGet the Pipeline-metrics of the table with job_id
GETGet Ingestion Metrics with job id.
GETGet job metrics with job id.
GETGet Export Metrics with job id.
GETGet Metrics for all tables in the source.
GETGet the Export-metrics of the table with job id
GETGet the ingestion-metrics of the table with job id
GETGet the ingestion-metrics for the table
GETGet the export-metrics for the table
POSTFetch the metrics for a given time period
Locked Entities
GETGet All Currently Locked Entities.
POSTUnlock Currently Locked Entities.
GETGet a specific currently Locked Entity.
POSTUnlock a Currently Locked Entity.
GETGet a specific currently Locked Entity.
GETGet All Currently Locked Entities.
POSTUnlock Currently Locked Entities.
Admin Subscribers
GETGet a list of subscribers.
POSTCreate a new subscriber.
GETGet a subscriber.
PUTUpdate a subscriber.
DELETEDelete a subscriber.
Admin Metadata Backup
GETGet Backup configs for metadata backup job
POSTAdd Backup configs for metadata backup job
Target Data Connections
GETGet the Target Data Connections
POSTCreate Target Data Connections
Self
GETGet the self details
Configurations
GETExports the source configuration
POSTImports the source configuration
Misc
POSTCheck if schema is unique
POSTCheck if path is unique
Audits
GETGet the audit logs of the source
GETGet the audit logs of the table
Admin Page
GETGet a list of all Users
POSTAdd a new user
GETGet a particular User
PUTAdd a new user
DELETEDelete a User
Subscribers
GETGet a list of subscribers.
GETGet a subscriber.

Infoworks Rest API V3 1.0

Infoworks Rest API V3

Server
{protocol}://{host}:{port}/v3
Server Variables

Authentication

http BearerAuth
http BasicAuth

Get `authentication_token` with `username` and `password`.

Get authentication_token with username and password.

Auth
GET /security/authenticate
curl --get \
--url 'http://localhost:3001/v3/security/authenticate' \
--header 'Authorization: Basic {token}'
Copy
Responses
200

Authentication success response

objectobject
messagestring
resultobject
authentication_tokenstring
is_authenticatedboolean
400

Request has invalid body or parameters.

401

Forbidden. User lacks access to specified resource.

406

Authentication Failed response

500

Internal Server Error.

Response
{
"message": "Authentication Success",
"result": {
"authentication_token": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MjUwMzc2MTcsInN1YiI6IntcbiAgXCJlbWFpbFwiIDogXCJhZG1pbkBpbmZvd29ya3MuaW9cIixcbiAgXCJzY29wZVwiIDoge1xuICAgIFwiYWN0aW9uXCIgOiBcInJlZnJlc2hfdG9rZW5cIlxuICB9XG59IiwianRpIjoiOTFlZGZkMWYtN2Y5My00NjM0LTg4MjctZTZlYjViYWJmNDJkIiwiZXhwIjoxNjI1MDM4NTE3fQ.aCTMjNebvC2Rf1CrJp_wA0dsozJd-uKpTcdEvDyigSU",
"is_authenticated": true
}
}
Copy

Get `authentication_token` with `refresh_token`.

Get authentication_token with refresh_token.

Auth
Headers
Authorizationstring

refresh token auth header put Basic {refresh_token}

GET /security/token/access
curl --get \
--url 'http://localhost:3001/v3/security/token/access' \
--header 'Authorization: zThziQ7MoJJPYAha+U/+PBSTZG944F+SHBDs+m/z2qn8+m/ax8Prpzla1MHzQ5EBLzB2Bw8a+Qs9r6En5BEN2DsmUVJ6sKFb2yI2'
Copy
Responses
200

Authentication success response

objectobject
messagestring
resultobject
authentication_tokenstring
is_authenticatedboolean
400

Request has invalid body or parameters.

401

Forbidden. User lacks access to specified resource.

406

Authentication Failed response

500

Internal Server Error.

Response
{
"message": "Authentication Success",
"result": {
"authentication_token": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MjUwMzc2MTcsInN1YiI6IntcbiAgXCJlbWFpbFwiIDogXCJhZG1pbkBpbmZvd29ya3MuaW9cIixcbiAgXCJzY29wZVwiIDoge1xuICAgIFwiYWN0aW9uXCIgOiBcInJlZnJlc2hfdG9rZW5cIlxuICB9XG59IiwianRpIjoiOTFlZGZkMWYtN2Y5My00NjM0LTg4MjctZTZlYjViYWJmNDJkIiwiZXhwIjoxNjI1MDM4NTE3fQ.aCTMjNebvC2Rf1CrJp_wA0dsozJd-uKpTcdEvDyigSU",
"is_authenticated": true
}
}
Copy

Purge authentication token

Purges authentication token and logs out the user. The user will need to generate a new authentication token for subsequent API calls.

Auth
DELETE /security/token/access
curl --request DELETE \
--url 'http://localhost:3001/v3/security/token/access' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200

ok

objectobject
messagestring
resultstring
400

Request has invalid body or parameters.

401

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response
{
"message": "Example Success Message",
"result": "Token successfully blacklisted"
}
Copy

Validate `authentication_token` if its active or not.

Validate authentication_token if its active or not.

Auth
GET /security/token/validate
curl --get \
--url 'http://localhost:3001/v3/security/token/validate' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200

Valid Token Response

objectobject
messagestring
resultobject
is_validboolean
400

Request has invalid body or parameters.

401

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response
{
"message": "{string}",
"result": {
"is_valid": true
}
}
Copy