Infoworks Rest API V3
Get `authentication_token` with `username` and `password`.
Get authentication_token with username and password.
Authentication success response
Request has invalid body or parameters.
Forbidden. User lacks access to specified resource.
Authentication Failed response
Internal Server Error.
Get `authentication_token` with `refresh_token`.
Get authentication_token with refresh_token.
Authentication success response
Request has invalid body or parameters.
Forbidden. User lacks access to specified resource.
Authentication Failed response
Internal Server Error.
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.
ok
Request has invalid body or parameters.
Forbidden. User lacks access to specified resource.
Internal Server Error.
Validate `authentication_token` if its active or not.
Validate authentication_token if its active or not.
Valid Token Response
Request has invalid body or parameters.
Forbidden. User lacks access to specified resource.
Internal Server Error.
Regenerate Refresh Token and blacklist old token.
Regenerate Refresh Token and blacklist old token.
Request has invalid body or parameters.
Forbidden. User lacks access to specified resource.
Internal Server Error.
Authorise User.
Authorise User.
Request has invalid body or parameters.
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get SAML Redirect URL.
Get SAML Redirect URL.
Valid Token Response
Request has invalid body or parameters.
Forbidden. User lacks access to specified resource.
Internal Server Error.
LDAP Authorise User.
LDAP Authorise User.
Request has invalid body or parameters.
Forbidden. User lacks access to specified resource.
Internal Server Error.
bulk sync (add/update) ldap user by providing login attribute
bulk sync (add/update) ldap user by providing login attribute
bulk ldap users sync response
Request has invalid body or parameters.
Forbidden. User lacks access to specified resource.
Authentication Failed response
Internal Server Error.
Users
Get the User details
Get the User details
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Create a new User
Create a new User
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the details of the user linked with the user_id
Get the details of the user linked with the user_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete a user.
Delete a user.
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update the User
Update the User
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Reset password for user
Reset password for user
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete all schedules for a specific user
Delete all schedules for a specific user
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Toggle user login ability
Toggle user login ability
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Add the domain to the user linked with the user_id
Add the domain to the user linked with the user_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the User details
Get the User details
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Create a new User
Create a new User
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the details of the user linked with the user_id
Get the details of the user linked with the user_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete a user.
Delete a user.
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update the User
Update the User
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Reset password for user
Reset password for user
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete all schedules for a specific user
Delete all schedules for a specific user
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Toggle user login ability
Toggle user login ability
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Add the domain to the user linked with the user_id
Add the domain to the user linked with the user_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Unlock the user
Unlock the user by providing email id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Environment
Get the list of environments
Retrieves the list of environments that are accessible to the user.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Create a new environment
Creates or clones a environment. To clone an existing environment, add the resource_id_to_clone query parameter.
Note: Cloning an environment will clone all its clusters and storages.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the environment id details
Get the environment id details
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete an Environment
Delete an Environment
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update an environment
Update an existing environment
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the environment id storage details
Get the environment id storage details
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Create storage for environment id
Create storage for environment id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the environment storage id storage details
Get the environment storage id storage details
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get list of pipelines using the storage
Get list of pipelines using the storage
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get List of ephemeral computes for environment
Get List of ephemeral computes for environment
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Create ephemeral cluster
Create ephemeral cluster
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get ephemeral computes for environment by id
Get ephemeral computes for environment by id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the list of environments interactive (persistent) templates
Get the list of environments interactive (persistent) templates
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Create an interactive compute
Create an interactive compute
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get persistent computes for environment by id
Get persistent computes for environment by id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the accessible domains present within an environment accessible by a user
Get the accessible domains present within an environment accessible by a user
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Gets all environment clusters.
Gets all environment clusters.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Sources
Get list of sources
Get list of sources
successful operation
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Create source
Create source
Source configurations
successful operation
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get Source Info
Get Source Info
successful operation
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Delete source
Delete source
successful operation
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Update source
Update source
Source configurations
successful operation
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Browse source
Browse source
successful operation
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Add query tables
Add query tables
Query table configurations
successful operation
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Crawl Entity Schema
Crawl Entity Schema
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Bulk Crawl Entity Schema
Bulk Crawl Entity Schema
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Check status for crawling
Check status for crawling
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Check status for bulk crawling
Check status for bulk crawling
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get source connection details
Get source connection details
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Update an existing source connection
Update an existing source connection
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Source Configurations
Add advanced configuration to the source
Add advanced configuration to the source
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get all advanced configuration of the source
Get all advanced configuration of the source
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get a source advanced configuration
Get a source advanced configuration
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Update a source advanced configuration
Update a source advanced configuration
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Delete a source advanced configuration
Delete a source advanced configuration
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get source Configuration
Get source Configuration
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Generic Source Types
Get Generic Source Types List
Get Generic Source Types List
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Register or Create Generic Source Type
Register or Create Generic Source Type
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Generic Source Type By Id
Get Generic Source Type By Id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update Generic Source Type By Id
Update Generic Source Type By Id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete Generic Source Type By Id
Delete Generic Source Type By Id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Generic Source Type Dependencies
Retrieves the dependencies for the Generic Source Type
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get all files in Generic Source Type by id
Get all files in Generic Source Type by generic_source_type_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
add file in Generic Source Type by id
add file in Generic Source Type by generic_source_type_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Topics
Get a list of all topics mapping.
Get a list of all topics mapping.
Topics Mapping
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Create Topic Mapping For Source
Create Topic Mapping For Source
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get topic mapping id.
Get topic mapping id.
Topics Mapping Id
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Update Topic Mapping For Source
Update Topic Mapping For Source
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Delete Topic Mapping For Source
Delete Topic Mapping For Source
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get topics From Source
Get topics From Source
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get topic Preview
Get topics Preview
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Crawl Schema For Topic Mapping
Crawl Schema For Topic Mapping
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get Table Schema From Mapping
Get Table Schema From Mapping
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Create Streaming Table
Create Streaming Table
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get Streaming Table
Get Streaming Table
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Delete Streaming Table
Delete Streaming Table
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Delete JSON Source Table
Delete JSON Source Table
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
File Mappings
Get File Mappings for JSON source
Get File Mappings for JSON source
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Create File Mapping For JSON Source
Create File Mapping For JSON Source
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get File Mappings for JSON source by id
Get File Mappings for JSON source by id
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Delete File Mapping For JSON Source
Delete File Mapping For JSON Source
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Update File Mapping For JSON Source
Update File Mapping For JSON Source
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get File Mapping Data Preview
Get File Mapping Data Preview
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Crawl Schema For File Mapping
Crawl Schema For File Mapping
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get Table Schema From Mapping
Get Table Schema From Mapping
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Create JSON Source Table
Create JSON Source Table
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get JSON Source Table
Get JSON Source Table
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Add/Edit Configuration for streaming options of a table group.
Add/Edit Configuration for streaming options of a table group.
Ok
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get streaming configuration of given table.
Get streaming configuration of given table.
Ok.
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get tables for whom streaming configurations are set in a particular source.
Get tables for whom streaming configurations are set in a particular source.
Ok
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get streaming table info.
Get streaming table info.
Ok
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Tables
Creates the file mapping (table) of the csv source.
Creates the previously configured file mapping (table) of the csv source.
This is the JSON body of request containing configured Table object.
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Modifies the file mapping (table) of the csv source.
Modifies the previously configured file mapping (table) of the csv source.
Ok
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Updates the file mapping (table) of the csv source.
Updates the previously configured file mapping (table) of the csv source.
Ok
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
update source metadata
update source metadata
Source Metadata
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
get source metadata
get source metadata
get source metadata
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
get whether staging fields can be edited
get whether staging fields can be edited
get whether staging fields can be edited
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get the list of Source Files paths of the table
Get the list of Source Files paths of the table
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get meta crawled table count
Get meta crawled table count
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get List of excluded tables
Get List of source table which are not yet ingested
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get Source schema
Get all distinct schema for a given source table
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
list all the tables in the source
list all the tables in the source
successful operation
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Add tables to a File Source
Add tables to a File Source
successful operation
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
list all the tables in the source
list all the tables in the source
successful operation
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get Table Info
Get Table Info
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Update the Table
Update the table Metadata
Update the table Metadata
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Delete Table for a source
Delete Table for a source
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Crawl Table Schema
Crawl Table Schema
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
add the tables to a source and crawl metadata of those added tables
add the tables to a source and crawl metadata of those added tables
successful operation
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Updates and configures the table for Ingestion
Sets ingestion configuration for a table.
Table ingestion Configuration
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get ingestion configuration of table
Get ingestion configuration of table
get the ingestion configuration of table
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get list of Entity advance configuration
Get list of Entity advance configuration
Limitby list of all the entity advance configuration sorted on the format user provided
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Add advance configuration for a table
Add advance configuration for a table
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get table advance configuration
Get table advance configuration
Ok
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
update advance configuration for a table
update advance configuration for a table
Table ingestion Configuration
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Delete advance configuration for a table
Delete advance configuration for a table
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
update table export configuration
update table export configuration
Table export Configuration
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
get table export configuration
get table export configuration
get table export configuration
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
update table column order
update table column order
Table Column Order
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
update table metadata
update table metadata
Table Metadata
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
get table metadata
get table metadata
get table metadata
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get table export configuration connection properties
Get table export configuration connection properties
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
update table export configuration Connection properties
update table export configuration Connection properties
Table export Configuration connection properties
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Start Segmentation on a Table
Start Segmentation on a Table
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Crawl Segments Metadata on a Table
Crawl Segments Metadata on a Table
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get Table Segments of a Table
Get Table Segments of a Table
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
End Segmentation on a Table
End Segmentation on a Table
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Cancel Segmentation on a Table
Cancel Segmentation on a Table
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get the schema of the table
Get the schema of the table
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Update the schema of the table
Update the schema of the table
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
configurations
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get a list of all table segments.
Get a list of all table segments.
Limitby list of all the tables segments sorted on the format user provided
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Gets Validation Specs for a Table.
Gets Validation Specs for a given TableId.
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Add Validation Specs to a Table.
Add Validation Specs to a Table.
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Updates the Validation Specs for a table.
Updates the Validation Specs for a table.
Ok
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Delete Validation Specs for a Table
Delete Validation Specs
successful operation
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get table preview.
Get table preview.
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Generate table preview.
Generate table preview.
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Generate query table preview.
Generate query table preview.
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get query table preview.
Get query table preview.
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get Preview Queries.
Gets Preview Queries.
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get multiple table Ids
Get multiple table Ids
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
update table metadata
update table metadata
Table Metadata
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
get table metadata
get table metadata
get table metadata
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
get table lineage
get table lineage
get table lineage
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Table Groups
Add a `Table Group`.
Add a Table Group.
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Gets `Table Group` list.
Gets Table Group list.
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Gets `Table Group` object for given id.
Gets Table Group object for given id.
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Update `Table Group` object for given id.
Update Table Group object for given id.
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
{table_group_id}
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
This will Configure particular `Table Group` with `tableGroupId`.
This will Configure particular Table Group with tableGroupId.
This is the JSON body of request containing configured Table group object.
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
This will fetch array of audit logs for table group with `tableGroupId`.
This will fetch array of audit logs for table group with tableGroupId.
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Gets `Table to Table Group` Mapping.
Gets Table to Table Group Mapping list.
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Table Group Schedule
Enable/Disable schedule for table groups
Get Table Group Schedule
Retrieves the table group schedule.
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Enable Table Group Schedule
Enables the table group schedule.
Ok
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Disable Table Group Schedule
Disables the table group schedule.
Ok
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Configure Table Group Schedule User
Configures the table group schedule user.
Ok
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Domains
Get the Target Data Connection
Get the Target Data Connection
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Edit the Target Data Connections Associated with a Domain
Edit the Target Data Connections Associated with a Domain
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Patch the Target Data Connection
Patch the Target Data Connection
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete the Target Data Connections Associated with a Domain
Delete the Target Data Connections Associated with a Domain
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get List of Domains
Get List of Domains
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get List of Domains
Get List of Domains
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get List of Domains Users
Get List of Domains Users
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get List of Accessible Domains
Get List of Accessible Domains
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get List of Domains Pipeline Extensions
Get List of Domains Pipeline Extensions
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get List of Domains
Get List of Domains
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Add a domain. (Requires Admin Access)
Add a domain. (Requires Admin Access)
ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get description of a domain_id. (Requires Admin Access)
Get description of a domain_id. (Requires Admin Access)
ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Edit name and description of a domain. (Requires Admin Access)
Edit name and description of a domain. (Requires Admin Access)
ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete a Domain (Requires Admin Access).
Delete a Domain (Requires Admin Access).
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get all the Sources associated with this Domain
Get all the Sources associated with this Domain
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Add Sources to this Domain (Requires Admin Access)
Add Sources to this Domain (Requires Admin Access)
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update Sources to this Domain (Requires Admin Access)
Update Sources to this Domain (Requires Admin Access)
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Remove Source from this Domain (Requires Admin Access)
Remove Source from this Domain (Requires Admin Access)
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get all the Domains associated with this Domain
Get all the Domains associated with this Domain
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Add Domains to this Domain (Requires Admin Access)
Add Domains to this Domain (Requires Admin Access)
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update accessible-domain in this Domain (Requires Admin Access)
Update accessible-domain in this Domain (Requires Admin Access)
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Remove Domain from this Domain (Requires Admin Access)
Remove Domain from this Domain (Requires Admin Access)
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get all the workflows associated with this Domain
Get all the workflows associated with this Domain
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get all the tablegroups associated with this Domain
Get all the tablegroups associated with this Domain
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get all the interactive computes associated with this Domain
Get all the interactive computes associated with this Domain
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get all the pipelines associated with this Domain
Get all the pipelines associated with this Domain
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get all the Pipeline Extensions associated with this Domain
Get all the Pipeline Extensions associated with this Domain
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update accessible-pipeline-extensions in this Domain (Requires Admin Access)
Update accessible-pipeline-extensions in this Domain (Requires Admin Access)
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Add Pipeline Extensions to this Domain (Requires Admin Access)
Add Pipeline Extensions to this Domain (Requires Admin Access)
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Remove Pipeline Extension from this Domain (Requires Admin Access)
Remove Pipeline Extension from this Domain (Requires Admin Access)
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
{key}
Domain Advanced Configurations
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
{key}
update advanced configs
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
{key}
delete advanced configs
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get recently used entities associated with this Domain
Get recently used entities associated with this Domain
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Add Recently Used Entity to this Domain
Add Recently Used Entity to this Domain
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get comments associated with this Domain
Get comments associated with this Domain
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Add comment to this Domain
Add comment to this Domain
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get notifications associated with this Domain
Get notifications associated with this Domain
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Table Orders With Hierachy
Get Table Orders With Hierachy
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Domains Pipeline and Accessibele Sources
Get Domains Pipeline and Accessibele Sources
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get all pipelines of all domains
Get all pipelines of all domains
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Change the active version of the Pipeline
Change the active version of the Pipeline
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get all pipelines for domain with `domain_id`
Get all pipelines for domain with domain_id
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
create new pipeline for domain with `domain_id`
create new pipeline for domain with domain_id
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Gets a `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
Gets a pipeline with {pipeline_id} in domain with {domain_id}.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Deletes a `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
Deletes a pipeline with {pipeline_id} in domain with {domain_id}.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Updates a `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
Updates a pipeline with {pipeline_id} in domain with {domain_id}.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Gets list of workflows using pipeline with `{pipeline_id}` in `domain` with `{domain_id}`.
Gets list of workflows using pipeline with {pipeline_id} in domain with `{domain_id}.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Gets all `pipeline analytics models` for ML Engine with `{pipeline_id}` in `domain` with `{domain_id}`.
Gets all pipeline analytics models for ML Engine with {pipeline_id} in domain with {domain_id}.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get list of all versions of Pipeline
Get list of all versions of Pipeline
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Create a pipeline version
Creates a new pipeline version
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Gets a `pipelineVersion` with `pipeline_version_id` of `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
Gets a pipelineVersion with pipeline_version_id of pipeline with {pipeline_id} in domain with {domain_id}.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Deletes a `pipelineVersion` with `pipeline_version_id` of `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
Deletes a pipelineVersion with pipeline_version_id of pipeline with {pipeline_id} in domain with {domain_id}.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update a `pipelineVersion` with `pipeline_version_id` of `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
Update a pipelineVersion with pipeline_version_id of pipeline with {pipeline_id} in domain with {domain_id}.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
importSql
import sql
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Exports the pipeline configuration
Exports the pipeline configuration to JSON format for pipeline with pipeline_id in domain with domain_id
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Imports the pipeline configuration
Imports the pipeline configuration from JSON format for pipeline with pipeline_id in domain with domain_id.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Gets lineage for Pipeline Column.
Gets lineage for Pipeline Column.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Validate a pipeline
Validates a pipeline version
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Refresh sample data
Refreshes the sample data
Success
Get node schema
Retrieves schema for a node in pipeline
Success
Get node data
Retrieves data for a node in pipeline
Success
Get node query
Retrieves query for a node in pipeline
Success
Get target SQL preview
Retrieves SQL query preview for target node
Success
Get Pipeline Version Audit Logs.
Get Pipeline Version Audit Logs
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update Pipeline Version Audit Logs
Update Pipeline Version Audit Logs
ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Pipeline Version Audit Logs.
Get Pipeline Version Audit Logs
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
getTablesfromPipelineSources
getTablesfromPipelineSources
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
File upload sql pipeline migration
File upload sql pipeline migration
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Import sql pipeline migration
Import sql pipeline migration
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Pipeline Extensions
Get Pipeline Extensions List
Get Pipeline Extensions List
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Pipeline Extensions List
Get Pipeline Extensions List
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Pipeline Extension by id
Get Pipeline Extension by pipeline_extension_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update Pipeline Extension by id
Update Pipeline Extension by pipeline_extension_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete Pipeline Extension by id
Delete Pipeline Extension by pipeline_extension_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get all files in Pipeline Extension by id
Get all files in Pipeline Extension by pipeline_extension_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
add file in Pipeline Extension by id
add file in Pipeline Extension by pipeline_extension_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Pipeline Extensions List
Get Pipeline Extensions List
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Source Extensions
Get Source Extensions List
Get Source Extensions List
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Source Extension by id
Get Source Extension by source_extension_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update Source Extension by id
Update Source Extension by source_extension_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete Source Extension by id
Delete Source Extension by source_extension_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get all files in Source Extension by id
Get all files in Source Extension by source_extension_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
add file in Source Extension by id
add file in Source Extension by source_extension_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete File from Source Extension by file name
Delete File from Source Extension by file_name
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get list of all Workflows for a `domain` with `{domain_id}`.
Get list of all Workflows for a domain with {domain_id}.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Create Workflow for a `domain` with `{domain_id}`.
Create Workflow for a domain with {domain_id}.
This is the JSON body of request containing configured Workflow object.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Gets a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`.
Gets a workflow with {workflow_id} in domain with {domain_id}.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Deletes a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`.
Deletes a workflow with {workflow_id} in domain with {domain_id}.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`.
Update a workflow with {workflow_id} in domain with {domain_id}.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Exports workflow configuration
Exports the workflow configuration to JSON format for workflow with workflow_id in domain with domain_id
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Imports workflow configuration
Imports the workflow configuration from JSON format for workflow with workflow_id in domain with domain_id.
This is the JSON body of request containing configuration of the Workflow object.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Runs the latest workflow
Runs the latest workflow with the provided workflow_id, domain_id, and returns workflow_run_id.
Optional Request Body containing Workflow Parameters to be submitted at Runtime and skip nodes to skip the workflow tasks at Runtime.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
This will pause all running builds of `workflow` with `{workflow_id}`.
This will pause all running builds of workflow with {workflow_id}.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
This will resume all paused builds of `workflow` with `{workflow_id}`.
This will resume all paused builds of workflow with {workflow_id}.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get workflow lineage
Retrieves the workflow lineage
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get workflow ancestors
Retrieves the workflow ancestors
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
This will get all builds of `workflow` with `{workflow_id}`.
This will get all builds of workflow with {workflow_id}.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
This will get a specific build of `workflow` with `{workflow_id}`.
This will get a specific build of workflow with {workflow_id}.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
This will restart running `workflow` with `{workflow_id}`.
This will restart running workflow with {workflow_id}.
Optional Request Body containing Skip Nodes to be skip workflow tasks at Runtime.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
This will cancel running `workflow` with `{workflow_id}` for build with `workflow_run_id`.
This will cancel running workflow with {workflow_id} for build with workflow_run_id.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get task logs for a workflow run
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.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Download task logs for a workflow run
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.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Gets parents workflow details of the workflow
Gets parents workflow details of the workflow.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Set workflow variables for a task in a workflow run
Set workflow variables for a task in a workflow run with {workflow_run_id} for workflow with {workflow_id} in domain with {domain_id}.
This is the JSON body of request containing workflow variable.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Workflows
Get Workflows runs (This operation is only for operations_analyst user)
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Retrieves the job details
Retrieve the details and status of any job. This is applicable only for the Operations Analyst user.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Restart Multiple Workflows
Restart Multiple Workflows (This operation is only for operations_analyst user)
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Cancel Multiple Workflows
Cancel Multiple Workflows (This operation is only for operations_analyst user)
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Workflow Versions
Workflow Versions CRUD Operations
Get all versions of a workflow
Get all versions of a workflow with {workflow_id} in domain with {domain_id}.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Create a new version of a workflow
Create a new version of a workflow with {workflow_id} in domain with {domain_id}.
This is the JSON body of request containing configured Workflow Version object.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get a specific version of a workflow
Get a specific version of a workflow with {workflow_id} in domain with {domain_id}.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update a specific version of a workflow
Update a specific version of a workflow with {workflow_id} in domain with {domain_id}.
This is the JSON body of request containing updated Workflow Version object.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete a specific version of a workflow
Delete a specific version of a workflow with {workflow_id} in domain with {domain_id}.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get audit logs for a specific version of a workflow
Get audit logs for a specific version of a workflow with {workflow_id} in domain with {domain_id}.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Set a specific version of a workflow as active
Set a specific version of a workflow with {workflow_id} in domain with {domain_id} as active.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Set workflow variables for a task in a specific version of a workflow
Set workflow variables for a task in a specific version of a workflow with {workflow_id} in domain with {domain_id}.
This is the JSON body of request containing workflow variable.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Workflows Schedules
Schedules of Workflows belonging to this Domain.
Schedules of Workflows belonging to this Domain.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Schedules of particular Workflow belonging to this Domain.
Schedules of particular Workflow belonging to this Domain.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Enable Workflow Schedule
Enable Workflow Schedule
Schedule Details
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Disable Workflow Schedule
Disable Workflow Schedule
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Change Workflow Schedule User
Change Workflow Schedule User
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Jobs
Get the jobs details
Get the jobs details
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the job details with `job_id`
Get the job details with job_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Resubmit Failed tables for ingestion
Resubmit Failed tables for ingestion
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the job log as text stream with `job_id`
Get the job log as text stream with job_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Download iw job logs zip for iw_job with job_id
Download iw job logs zip for iw_job with job_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get cluster jobs for iw_job with job_id
Get cluster jobs for iw_job with job_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get cluster job for iw_job with job_id and run_id
Get cluster job for iw_job with job_id and run_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Download cluster job logs zip for iw_job with job_id and run_id
Download cluster job logs zip for iw_job with job_id and run_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the admin-jobs details
Get the admin-jobs details
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get List of All jobs of this Source and it's artifacts.
Get List of All jobs of this Source and it's artifacts.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Initiates jobs for source and its artifacts
Initiates jobs for source and its artifacts. The job types that can be submitted are export_data, streaming_start, segmentation_load, truncate_reload, cdc_merge, cdc_restatement, truncate_table, source_test_connection, source_fetch_metadata, table_fetch_metadata.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get job with job id.
Get job with job id.
Ok.
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Resubmit Failed tables for ingestion
Resubmit Failed tables for ingestion
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get crawl job info.
Get crawl job info.
Ok.
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get Summary Logs for the Source Crawl Job.
Get Summary Logs for the Source Crawl Job.
Ok.
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get Summary Logs for the Source Crawl Job.
Get Summary Logs for the Source Crawl Job.
Ok.
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get List of All jobs of this Source and it's artifacts.
Get List of All jobs of this Source and it's artifacts.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Interactive Jobs List
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Interactive Job by id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update the job status for Interactive Job
Update the job status to failed for Interactive jobs
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Download Logs for Interactive Job
Downloads the dataplane logs for the source interactive job.
Ok.
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Gets Jobs Model for a Source.
Gets Jobs Model for a Source.
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Gets List of Pipeline Jobs.
Gets List of Pipeline Jobs.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Submit Pipeline Job.
Submit Pipeline Job.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Gets Pipeline Job.
Gets Pipeline Job.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Submit Pipeline Job.
Submit Pipeline Job.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the jobs details
Get the jobs details (This operation is only for operations_analyst user)
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the job details with `job_id`
Get the job details with job_id (This operation is only for operations_analyst user)
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Cancel the job with `job_id`
Cancel the job with job_id (This operation is only for operations_analyst user)
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Resubmit Failed tables for ingestion
Resubmit Failed tables for ingestion (This operation is only for operations_analyst user)
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Gets List of Pipeline Jobs.
Gets List of Pipeline Jobs.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Submit Pipeline Job.
Submit Pipeline Job.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Gets Pipeline Groups Job.
Gets Pipeline Groups Job.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Gets Pipeline Groups Job.
Gets Pipeline Groups Job.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Gets Pipeline Groups Job.
Gets Pipeline Groups Job.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the job log as text stream with `job_id`
Get the job log as text stream with job_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Download iw job logs zip for iw_job with job_id
Download iw job logs zip for iw_job with job_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Job Hooks
Get Job Hooks List
Get Job Hooks List
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Create a Job Hook
Create a Job Hook
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Job Hook By Id
Get Job Hook By Id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update Job Hook Type By Id
Update Job Hook Type By Id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete Job Hook By Id
Delete Job Hook By Id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get all files in Job Hook by id
Get all files in Job Hook by job_hook_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
add file in Job Hook by id
add file in Job Hook by job_hook_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Global Audit Job Hooks List
Get Global Audit Job Hooks List
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Audit Job Hooks List
Get Audit Job Hooks List
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Global Audit Pipeline Extension List
Get Global Audit Pipeline Extension List
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Audit Pipeline Extension List
Get Audit Pipeline Extension List
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Global Audit Source Extension List
Get Global Audit Source Extension List
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Audit Source Extension List
Get Audit Source Extension List
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Active License Violations
Get Active License Violations
ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Active License
Get Active License
ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get All Licenses
Get All Licenses
ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Pipeline Groups
Get all pipeline groups
Get all pipeline groups
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Create Pipeline Groups
Create Pipeline Groups
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get all pipeline groups for domain with `domain_id`
Get all pipeline groups for domain with domain_id
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get pipeline group
Get pipeline group
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete Pipeline Group
Delete Pipeline Group
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update Pipeline Group
Update Pipeline Group
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Accessible pipeline group
Get Accessible pipeline group
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Gets List of Advance Config pipeline group.
Gets List of Advance Config pipeline group.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Advance Configuration Pipeline Group.
Advance Configuration Pipeline Group.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Pipelinegroup advance configuration
Get Pipelinegroup advance configuration
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
update advance configuration for a pipeline group
update advance configuration for a pipeline group
Table ingestion Configuration
OK
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete advance configuration for a pipeline group
Delete advance configuration for a pipeline group
OK
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Service Authentication
CRUD Operations to manage Service Authentication mechanisms
List service authentication mechanisms
Get a list of service authentication mechanisms
List of service authentication mechanisms.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Create a service authentication mechanism
Create a service authentication mechanism
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get service authentication mechanism
Get service authentication mechanism
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update service authentication mechanism
Update service authentication mechanism
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete service authentication mechanism
Delete service authentication mechanism
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Secret Store
CRUD Operations to manage Secret Stores
List secret stores
List secret stores
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Create secret store
Create secret store
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get secret store
Get secret store
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update secret store
Update secret store
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete secret store
Delete secret store
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
List secrets
Retrieves the list of secrets that are accessible to the user.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Create secret
Create secret
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get secret
Get secret
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update secret
Update secret
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete secret
Delete secret
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Event Notifications
Read Operation for event notifications
List event notifications
Get a list of event notification
List of event notifications.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Engagement Metrics
Read Operation for engagement metrics
Aggregate details
Get Aggregate datails
List of Data Aggregate.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
List Job status
Get Job status
List of Job Status Response.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Data Catalog
Read Operation for Data Catalog
Data Model Details
Get Data Model details
List of Data Models.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Favorite Entity Details
Get Favorite Entity details
List of Favorite Entities.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Pipeline Version Locks
CRUD operations from pipeline version locks
Get all pipeline version locks for pipeline with pipeline_id
Get all pipeline version locks for pipeline with pipeline_id
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Jobflows
Operations to manage Jobflows
List Jobflows
Retrieves the list of all jobflows
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Jobflow
Retrieves the jobflow details
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Environment Cluster
Environment Cluster to start/stop/restart cluster
Get Persistent Cluster Status
Get Persistent Cluster Status
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Environment Status
Get Environment Status
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Stop the persistent cluster
Stop the persistent cluster
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Terminate the persistent cluster
Terminate the persistent cluster
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Restart the cluster
Restart the cluster
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Stop the cluster
Stop the cluster
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Create the cluster
Create the cluster
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get daily billing metering data
Get daily billing metering data
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get billing information
Get billing information
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get snowflake daily billing metering data
Get snowflake daily billing metering data
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get snowflake billing information
Get snowflake billing information
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get metrics configuration
Get metrics configuration
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Submit a request for refreshing billing details
Submit a request for refreshing billing details
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get a particular entity schedule details
Get a particular entity schedule details
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Used to check whether scheduler service is working or not
Used to check whether scheduler service is working or not
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Used to save a particular entity schedule detailsDeprecated
Used to save a particular entity schedule details
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Used to save a particular entity schedule user detailsDeprecated
Used to save a particular entity schedule user details
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Used to save a particular entity schedule and its user details
Used to save a particular entity schedule and its user details
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Use to validate entity names
Use to validate entity names
Ok.
Used to verify users refresh token
Used to verify users refresh token
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Exports the source configuration
Exports the source configuration to JSON format.
Ok.
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Imports the source configuration
Imports the source configuration from JSON format.
Ok.
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Upload config migration json file
Upload config migration json file
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Getting Server Timezone
Use to get server timezone
Use to get server timezone
Ok.
Target Data Connections
Target Data Connections
Get the Target Data Connections
Get the Target Data Connections
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Create Target Data Connections
Create Target Data Connections to use in pipeline or sources
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the Data Connections for each subtype
Get the Data Connections for each subtype
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Add Custom tags
Custom tags
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get List of Custom Tags
Get List of Custom Tags
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get custom tags
Get custom tags
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update Custom tags
Custom tags
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update Custom tags
Custom tags
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Presets
CRUD Operations to manage user specific presets
List presets
Get a list of presets of a particular type for a user
List of presets.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Create a preset
Creates a user-defined preset
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get preset
Get preset details
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update preset
Update preset
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete preset
Delete preset
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Admin Configurations
Get all General Configurations for Infoworks.
Get all General Configurations for Infoworks.
ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Replace General Configurations for Infoworks.
Replace General Configurations for Infoworks.
ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Gets `Mongo Backups` list.
Gets Mongo Backups list.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Gets Mongo Backup With Specified Id.
Gets Mongo Backup With Specified Id.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Start Mongo Backup
Start Mongo Backup.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the Schedule of the Mongo Backup.
Get the Schedule of the Mongo Backup.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Schedule Mongo Backup.
Schedule Mongo Backup.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Schedule Mongo Backup.
Schedule Mongo Backup.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the type of the Authentication and associated properties.
Get the type of the Authentication and associated properties.
ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Change the Authentication Mechanism
Change the Authentication Mechanism
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Change the Authentication Mechanism
Change the Authentication Mechanism
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Test the Authentication Mechanism's Connection.
Test the Authentication Mechanism's Connection.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Test the Authentication Connection for LDAP user.
Test the Authentication Connection for LDAP user.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
General Configs
Get general configuration with key
Get general configuration with key
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Admin Metadata Cleanup
Get metadata cleanup policies.
Get metadata cleanup policies.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Jobs cleanup policy.
Get Jobs cleanup policy.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Edit the Jobs Cleanup Policy
Edit the Jobs Cleanup Policy
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Audits cleanup policy.
Get Audits cleanup policy.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Edit the Audits Cleanup Policy
Edit the Audits Cleanup Policy
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Metrics cleanup policy.
Get Metrics cleanup policy.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Edit the Metrics Cleanup Policy
Edit the Metrics Cleanup Policy
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Schedule of cleanup policy.
Get Schedule of cleanup policy.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Edit Schedule of cleanup policy.
Edit Schedule of cleanup policy.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Edit Schedule of cleanup policy.
Edit Schedule of cleanup policy.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Edit Scheduling User of cleanup policy. Hit this API with the delegation token of the required User.
Edit Scheduling User of cleanup policy. Hit this API with the delegation token of the required User.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Pause Multiple Workflows
Pause Multiple Workflows
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Resume Multiple Workflows
Resume Multiple Workflows
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Restart Multiple Workflows
Restart Multiple Workflows
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Cancel Multiple Workflows
Cancel Multiple Workflows
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Retrieves the status of workflow
Retrieves the status of workflows for the Admin user.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Gets workflow versions
Retrieves the list of workflow versions for the Admin user.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Workflows
Get Workflows runs
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Workflows tasks
Get Workflows tasks
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Workflow run Id details
Get Workflow run Id details
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Metrics
Get the Ingestion-metrics of the table with job_id
Get the Ingestion-metrics of the table with job_id
OK
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the Export-metrics of the table with job_id
Get the Export-metrics of the table with job_id
OK
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the Pipeline-metrics of the table with job_id
Get the Pipeline-metrics of the table with job_id
OK
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Job Status Metrics
Get Job Status Metrics
Successful response with job status metrics.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Ingestion Metrics with job id.
Get Ingestion Metrics with job id.
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get job metrics with job id.
Get job metrics with job id.
Success
Get Export Metrics with job id.
Get Export Metrics with job id.
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get Metrics for all tables in the source.
Get Metrics for all tables in the source.
Success
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get the Export-metrics of the table with job id
Get the Export-metrics of the table with job id
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get the ingestion-metrics of the table with job id
Get the ingestion-metrics of the table with job id
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get the ingestion-metrics for the table
Get the ingestion-metrics for the table
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Download ingestion metrics for the table
Download ingestion metrics for the table
Ok.
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Download List of All jobs of this Source and it's artifacts.
Download List of All jobs of this Source and it's artifacts.
Ok.
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get the export-metrics for the table
Get the export-metrics for the table
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Fetch the metrics for a given time period
Fetch the metrics for a given time period
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get All Currently Locked Entities.
Get All Currently Locked Entities.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Unlock Currently Locked Entities.
Unlocks all Currently Locked Entities.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get a specific currently Locked Entity.
Get a specific currently Locked Entity.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Unlock a Currently Locked Entity.
Unlock a Currently Locked Entity.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get a specific currently Locked Entity.
Get a specific currently Locked Entity for Prodops user.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get All Currently Locked Entities.
Get All Currently Locked Entities.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Unlock Currently Locked Entities.
Unlocks all Currently Locked Entities.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get a list of subscribers.
Get a list of subscribers.
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Create a new subscriber.
Create a new subscriber.
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get a subscriber.
Get a subscriber.
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update a subscriber.
Update a subscriber.
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete a subscriber.
Delete a subscriber.
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get a Subscription List for a subscriber.
Get a Subscription List for a subscriber.
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete all the subscription for a subscriber.
Delete all the subscription for a subscriber.
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get a list of all external and internal users.
Get a list of all external and internal users.
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Admin Metadata Backup
Get Backup configs for metadata backup job
Get Backup configs for metadata backup job
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Add Backup configs for metadata backup job
Add Backup configs for metadata backup job
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the self details
Get the self details
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the self details
Get the self details
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Admin Schedules
Get details of all running schedules.
Get details of all running schedules.
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get the Custom Audit Column
Get the Custom Audit Column
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Patch the Custom Audit Column
Patch the Custom Audit Column
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete the Custom Audit Column
Delete the Custom Audit Column
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Custom Audit Columns
Get Custom Audit Columns
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Create Custom Audit Column
Create Custom Audit Column
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Custom Audit Column Audits
Get Custom Audit Columns Audits
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Clear Cache
To clear Admin cache
To clear Admin cache
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Stop Streaming
Stops the streaming jobs for tables listed in request.
Stops the streaming jobs for tables listed in request.
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Check if schema is unique
Check if schema is unique
Source configurations
successful operation
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Check if path is unique
Check if path is unique
Source configurations
successful operation
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get the audit logs of the source
Get the audit logs of the source
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Get the audit logs of the table
Get the audit logs of the table
OK
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Check entity favorite tag
Check entity favorite tag
Ok
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Toggle entity favorite tag
Toggle entity favorite tag
Ok
Bad Request
Unauthorized Request
Forbidden Access
Internal Server Error
Subscribers
Get a list of subscribers.
Get a list of subscribers.
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get a subscriber.
Get a subscriber.
Ok
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Service Authentication Cache
Clear cache for service authentication or secret
Clear cache in infoworks services for authentication or secrets value.
Success.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Pipeline Version Lock
Put pipeline version lock for pipeline with pipeline_id and pipeline version with pipeline_version_id
Put pipeline version lock for pipeline with pipeline_id and pipeline version with pipeline_version_id
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Put pipeline version lock for pipeline with pipeline_id and pipeline version with pipeline_version_id
Put pipeline version lock for pipeline with pipeline_id and pipeline version with pipeline_version_id
Pipeline version lock configuration
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Delete pipeline version lock for pipeline_id, pipeline_version_id
Delete pipeline version lock pipeline_id, pipeline_version_id
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
get pipeline version lock status for pipeline_id, pipeline_version_id
get pipeline version lock status for pipeline_id, pipeline_version_id
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Workflow Run Metering Variables
Get workflow run metering variables
Get workflow run metering variables
Success
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Server Time
Get Server Timezone Offset
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get values for 4 general configs(login_contact_info, login_welcome_text, login_message, is_quiescent_enabled)
Get values for 4 general configs(login_contact_info, login_welcome_text, login_message, is_quiescent_enabled)
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get connection parameters for generic jdbc sources
Get connection parameters for generic jdbc sources
Ok.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Get Entity Subscriber
Get Entity Subscriber
List of User Notification Subscribe.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Update Entity Subscriber
Update Entity Subscriber
List of User Notification Subscribe.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Subscribe Notification
Subscribe Notification
List of User Aggregate.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.
Unsubscribe Notification
Unsubscribe Notification
List of Job Status Response.
Request has invalid body or parameters.
Authentication Failed. Please check your Credentials
Forbidden. User lacks access to specified resource.
Internal Server Error.