Infoworks Rest API V3

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

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

Get authentication_token with username and password.

Auth
Query String
service_idnumber

Used to represent the way user has login into infoworks

GET /security/authenticate
Responses
200

Authentication success response

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Forbidden. User lacks access to specified resource.

406

Authentication Failed response

500

Internal Server Error.

Response

Get `authentication_token` with `refresh_token`.

Get authentication_token with refresh_token.

Auth
Headers
Authorizationstring

refresh token auth header put Basic {refresh_token}

GET /security/token/access
Responses
200

Authentication success response

objectobject
messagestring
resultobject
authentication_tokenstring
400

Request has invalid body or parameters.

401

Forbidden. User lacks access to specified resource.

406

Authentication Failed response

500

Internal Server Error.

Response

Purge authentication token

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

Auth
DELETE /security/token/access
Responses
200

ok

objectobject
messagestring
resultstring
400

Request has invalid body or parameters.

401

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Validate `authentication_token` if its active or not.

Validate authentication_token if its active or not.

Auth
GET /security/token/validate
Responses
200

Valid Token Response

objectobject
messagestring
resultobject
is_validboolean
400

Request has invalid body or parameters.

401

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Regenerate Refresh Token and blacklist old token.

Regenerate Refresh Token and blacklist old token.

Auth
DELETE /security/token/refresh
Responses
200
objectobject
messagestring
resultstring
400

Request has invalid body or parameters.

401

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Authorise User.

Authorise User.

Auth
Request Body
objectobject
entityTypestring
actionstring
entityIdstring
POST /security/authorise/user
Responses
200
objectobject
messagestring
resultobject
delegation_tokenstring
is_authorisedboolean
400

Request has invalid body or parameters.

401

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get SAML Redirect URL.

Get SAML Redirect URL.

Auth
GET /security/sso/initialise
Responses
200

Valid Token Response

objectobject
Locationstring
400

Request has invalid body or parameters.

401

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

LDAP Authorise User.

LDAP Authorise User.

Auth
Request Body
objectobject
userIdsarray[string]
searchAttributestring
POST /security/get/user/data
Responses
200
objectobject
usersarray[string]
400

Request has invalid body or parameters.

401

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

bulk sync (add/update) ldap user by providing login attribute

bulk sync (add/update) ldap user by providing login attribute

Auth
Request Body
objectobject
search_onstring
search_listarray[string]
should_updateboolean

Default: true

should_addboolean

Default: true

POST /security/bulk-ldap-sync
Responses
200

bulk ldap users sync response

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Forbidden. User lacks access to specified resource.

406

Authentication Failed response

500

Internal Server Error.

Response

Get the User details

Get the User details

Auth
GET /admin/users
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Create a new User

Create a new User

Auth
Request Body
objectobject
profileobject
namestring
emailstring
rolesarray[string]
passwordstring
accessible_domainsarray[string]
POST /admin/users
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the details of the user linked with the user_id

Get the details of the user linked with the user_id

Auth
GET /admin/users/{user_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete a user.

Delete a user.

Auth
DELETE /admin/users/{user_id}
Responses
200

Ok

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update the User

Update the User

Auth
Request Body
objectobject
profileobject
namestring
emailstring
rolesarray[string]
accessible_domainsarray[string]
passwordstring
PATCH /admin/users/{user_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Reset password for user

Reset password for user

Auth
Request Body
objectobject
old_passwordstring
new_passwordstring
PATCH /admin/users/{user_id}/reset-password
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete all schedules for a specific user

Delete all schedules for a specific user

Auth
DELETE /admin/users/{user_id}/delete-schedules
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Toggle user login ability

Toggle user login ability

Auth
PATCH /admin/users/{user_id}/toggle-user-login
Responses
200

Ok.

objectobject
messagestring
resultobject
login_disabledboolean
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Add the domain to the user linked with the user_id

Add the domain to the user linked with the user_id

Auth
Request Body
objectobject
entity_idsarray
POST /admin/users/{user_id}/accessible-domains
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the User details

Get the User details

Auth
GET /users
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Create a new User

Create a new User

Auth
Request Body
objectobject
profileobject
namestring
emailstring
rolesarray[string]
passwordstring
POST /users
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the details of the user linked with the user_id

Get the details of the user linked with the user_id

Auth
GET /users/{user_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete a user.

Delete a user.

Auth
DELETE /users/{user_id}
Responses
200

Ok

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update the User

Update the User

Auth
Request Body
objectobject
profileobject
namestring
emailstring
rolesarray[string]
passwordstring
PATCH /users/{user_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Reset password for user

Reset password for user

Auth
Request Body
objectobject
old_passwordstring
new_passwordstring
PATCH /users/{user_id}/reset-password
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete all schedules for a specific user

Delete all schedules for a specific user

Auth
DELETE /users/{user_id}/delete-schedules
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Toggle user login ability

Toggle user login ability

Auth
PATCH /users/{user_id}/toggle-user-login
Responses
200

Ok.

objectobject
messagestring
resultobject
login_disabledboolean
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Add the domain to the user linked with the user_id

Add the domain to the user linked with the user_id

Auth
Request Body
objectobject
entity_idsarray
POST /users/{user_id}/accessible-domains
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Unlock the user

Unlock the user by providing email id

Auth
Query String
user_emailstring
POST /users/unlock
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the list of environments

Retrieves the list of environments that are accessible to the user.

Auth
Query String
fetch_allboolean

Use this parameter to retrieve the list of all environments. (Only for admin user).

Default: null

GET /admin/environment
Responses
200

Ok.

objectobject
messagestring
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

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.

Auth
Query String
resource_id_to_clonestring

Id of environment to be cloned. Request body will be ignored when this parameter is passed.

Request Body
objectobject
namestring

pattern: ^[a-z0-9A-Z_-]+$

platformstring
compute_enginestring
connection_configurationobject
filesfile
metastoreobject
POST /admin/environment
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the environment id details

Get the environment id details

Auth
GET /admin/environment/{environment_id}
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete an Environment

Delete an Environment

Auth
DELETE /admin/environment/{environment_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update an environment

Update an existing environment

Auth
Request Body
objectobject
namestring

pattern: ^[a-z0-9A-Z_-]+$

connection_configurationobject
filesfile
metastoreobject
PATCH /admin/environment/{environment_id}
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the environment id storage details

Get the environment id storage details

Auth
GET /admin/environment/{environment_id}/environment-storage
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Create storage for environment id

Create storage for environment id

Auth
Request Body
objectobject
namestring

pattern: ^[a-z0-9A-Z_-]+$

descriptionstring
regionstring
storage_typestring
storage_authenticationobject
is_default_storageboolean
filesfile
POST /admin/environment/{environment_id}/environment-storage
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the environment storage id storage details

Get the environment storage id storage details

Auth
GET /admin/environment/{environment_id}/environment-storage/{environment_storage_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get list of pipelines using the storage

Get list of pipelines using the storage

Auth
GET /admin/environment/{environment_id}/environment-storage/{environment_storage_id}/pipelines
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray
idstring
namestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get List of ephemeral computes for environment

Get List of ephemeral computes for environment

Auth
GET /admin/environment/{environment_id}/environment-compute-template
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Create ephemeral cluster

Create ephemeral cluster

Auth
Request Body
objectobject
descriptionstring
namestring

pattern: ^[a-z0-9A-Z_-]+$

compute_enginestring
launch_strategystring
compute_configurationobject
POST /admin/environment/{environment_id}/environment-compute-template
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get ephemeral computes for environment by id

Get ephemeral computes for environment by id

Auth
GET /admin/environment/{environment_id}/environment-compute-template/{environment_compute_template_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the list of environments interactive (persistent) templates

Get the list of environments interactive (persistent) templates

Auth
GET /admin/environment/{environment_id}/environment-interactive-clusters
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Create an interactive compute

Create an interactive compute

Auth
Request Body
objectobject
descriptionstring
namestring

pattern: ^[a-z0-9A-Z_-]+$

compute_enginestring
launch_strategystring
compute_configurationobject
POST /admin/environment/{environment_id}/environment-interactive-clusters
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get persistent computes for environment by id

Get persistent computes for environment by id

Auth
GET /admin/environment/{environment_id}/environment-interactive-clusters/{environment_interactive_clusters_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the accessible domains present within an environment accessible by a user

Get the accessible domains present within an environment accessible by a user

Auth
GET /admin/environment/{environment_id}/accessible-domains
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
namestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Gets all environment clusters.

Gets all environment clusters.

Auth
GET /admin/environment/{environment_id}/environment-clusters
Responses
200

Success

objectobject
messagestring
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get list of sources

Get list of sources

Auth
Query String
limitinteger

The numbers of items to return

Default: 10

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

resolve_refboolean

To get entity details and created by user name

GET /sources
Responses
200

successful operation

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Create source

Create source

Auth
Request Body

Source configurations

objectobject
namestring
environment_idstring
storage_idstring
data_lake_schemastring
data_lake_pathstring
typestring
is_source_ingestedboolean
storagestring
is_publicboolean
sub_typestring

Enum: redshift,saphana,sybaseiq,vertica,mongodb,rest_generic

is_oem_connectorboolean
connection
objectobject
connection_modestring

Enum: jdbc

connection_urlstring
source_schemastring
usernamestring
password
stringstring

minLength: 1

databasestring
snowflake_profilestring
warehousestring
enable_log_based_cdcboolean
staging_databasestring
enable_dictionary_rebuild_for_each_jobboolean
dictionary_pathstring
dictionary_typestring

Enum: online,offline,redo_log

POST /sources
Responses
200

successful operation

objectobject
resultobject
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get Source Info

Get Source Info

Auth
GET /sources/{source_id}
Responses
200

successful operation

objectobject
resultobject
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Delete source

Delete source

Auth
DELETE /sources/{source_id}
Responses
200

successful operation

objectobject
resultobject
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Update source

Update source

Auth
Request Body

Source configurations

objectobject
namestring
PATCH /sources/{source_id}
Responses
200

successful operation

objectobject
resultobject
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Browse source

Browse source

Auth
GET /sources/{source_id}/source_tables
Responses
200

successful operation

objectobject
messagestring
resultobject
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Add query tables

Add query tables

Auth
Request Body

Query table configurations

objectobject
tables_to_addobject
POST /sources/{source_id}/tables/query_tables
Responses
200

successful operation

objectobject
messagestring
resultobject
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Crawl Entity Schema

Crawl Entity Schema

Auth
GET /sources/{source_id}/crawl-schema
Responses
200
objectobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Bulk Crawl Entity Schema

Bulk Crawl Entity Schema

Auth
GET /sources/{source_id}/bulk-crawl-schema
Responses
200
objectobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Check status for crawling

Check status for crawling

Auth
GET /sources/{source_id}/crawl-status
Responses
200
objectobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Check status for bulk crawling

Check status for bulk crawling

Auth
GET /sources/{source_id}/bulk-crawl-status
Responses
200
objectobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get source connection details

Get source connection details

Auth
GET /sources/{source_id}/configurations/connection
Responses
200

OK

objectobject
messagestring
enable_log_based_cdcboolean
driver_namestring
connection_urlstring
source_schemastring
connection_modestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Update an existing source connection

Update an existing source connection

Auth
Request Body
objectobject
connection_modestring

Enum: jdbc

connection_urlstring
source_schemastring
usernamestring
password
stringstring

minLength: 1

databasestring
snowflake_profilestring
warehousestring
enable_log_based_cdcboolean
staging_databasestring
enable_dictionary_rebuild_for_each_jobboolean
dictionary_pathstring
dictionary_typestring

Enum: online,offline,redo_log

PUT /sources/{source_id}/configurations/connection
Responses
200

OK

objectobject
resultobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Add advanced configuration to the source

Add advanced configuration to the source

Auth
Request Body
objectobject
keystring
valuestring
descriptionstring
is_activeboolean
entity_idstring
entity_typestring
POST /sources/{source_id}/configurations/advance
Responses
200

OK

objectobject
resultobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get all advanced configuration of the source

Get all advanced configuration of the source

Auth
GET /sources/{source_id}/configurations/advance
Responses
200

OK

objectobject
resultarray
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get a source advanced configuration

Get a source advanced configuration

Auth
GET /sources/{source_id}/configurations/advance/{key}
Responses
200

OK

objectobject
messagestring
resultobject
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Update a source advanced configuration

Update a source advanced configuration

Auth
Request Body
objectobject
keystring
valuestring
descriptionstring
is_activeboolean
entity_idstring
entity_typestring
PUT /sources/{source_id}/configurations/advance/{key}
Responses
200

OK

objectobject
resultobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Delete a source advanced configuration

Delete a source advanced configuration

Auth
DELETE /sources/{source_id}/configurations/advance/{key}
Responses
200

OK

objectobject
resultobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get source Configuration

Get source Configuration

Auth
GET /sources/{source_id}/configurations
Responses
200

OK

objectobject
resultobject
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get Generic Source Types List

Get Generic Source Types List

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/generic-source-type
Responses
200

Ok.

objectobject
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Register or Create Generic Source Type

Register or Create Generic Source Type

Auth
Request Body
objectobject
namestring

pattern: ^[a-z0-9A-Z_-]+$

driver_class_namestring
upload_optionstring
filesfile

Required files if upload_option is fileUpload

folder_pathstring

Required folder_path if upload_option is serverLocation

POST /admin/generic-source-type
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Generic Source Type By Id

Get Generic Source Type By Id

Auth
GET /admin/generic-source-type/{generic_source_type_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update Generic Source Type By Id

Update Generic Source Type By Id

Auth
Request Body
objectobject
upload_optionstring

Enum: fileUpload,serverLocation

folder_pathstring

Required folder_path if upload_option is serverLocation

filesfile

Required files if upload_option is fileUpload

PATCH /admin/generic-source-type/{generic_source_type_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete Generic Source Type By Id

Delete Generic Source Type By Id

Auth
DELETE /admin/generic-source-type/{generic_source_type_id}
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Generic Source Type Dependencies

Retrieves the dependencies for the Generic Source Type

Auth
GET /admin/generic-source-type/{generic_source_type_id}/dependencies
Responses
200

Ok.

objectobject
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get all files in Generic Source Type by id

Get all files in Generic Source Type by generic_source_type_id

Auth
GET /admin/generic-source-type/{generic_source_type_id}/files
Responses
200

Ok.

objectobject
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

add file in Generic Source Type by id

add file in Generic Source Type by generic_source_type_id

Auth
Request Body
filefile
POST /admin/generic-source-type/{generic_source_type_id}/files
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get a list of all topics mapping.

Get a list of all topics mapping.

Auth
GET /sources/{source_id}/topic-mappings
Responses
200

Topics Mapping

objectobject
messagestring
total_countinteger

Total count of topic mappings

minimum: 0

400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Create Topic Mapping For Source

Create Topic Mapping For Source

Auth
Request Body
namestring
topic_identifierobject
POST /sources/{source_id}/topic-mappings
Responses
200

Success

objectobject
messagestring
resultstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get topic mapping id.

Get topic mapping id.

Auth
GET /sources/{source_id}/topic-mappings/{topic_mapping_id}
Responses
200

Topics Mapping Id

objectobject
messagestring
resultobject
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Update Topic Mapping For Source

Update Topic Mapping For Source

Auth
Request Body
namestring
topic_identifierobject
PATCH /sources/{source_id}/topic-mappings/{topic_mapping_id}
Responses
200

Success

objectobject
messagestring
resultstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Delete Topic Mapping For Source

Delete Topic Mapping For Source

Auth
DELETE /sources/{source_id}/topic-mappings/{topic_mapping_id}
Responses
200

Success

objectobject
messagestring
resultstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get topics From Source

Get topics From Source

Auth
GET /sources/{source_id}/topics
Responses
200

Success

objectobject
messagestring
resultobject
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get topic Preview

Get topics Preview

Auth
GET /sources/{source_id}/topic-mappings/{topic_mapping_id}/preview
Responses
200

Success

objectobject
messagestring
resultobject
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Crawl Schema For Topic Mapping

Crawl Schema For Topic Mapping

Auth
GET /sources/{source_id}/topic-mappings/{topic_mapping_id}/crawl-schema
Responses
200

Success

objectobject
messagestring
resultobject
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get Table Schema From Mapping

Get Table Schema From Mapping

Auth
Query String
selected_keysstring
GET /sources/{source_id}/topic-mappings/{topic_mapping_id}/table-schema
Responses
200

Success

objectobject
messagestring
resultobject
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Create Streaming Table

Create Streaming Table

Auth
Request Body
objectobject
POST /sources/{source_id}/topic-mappings/{topic_mapping_id}/tables
Responses
200

Success

objectobject
messagestring
resultstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get Streaming Table

Get Streaming Table

Auth
GET /sources/{source_id}/topic-mappings/{topic_mapping_id}/tables/{table_id}
Responses
200

Success

objectobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Delete Streaming Table

Delete Streaming Table

Auth
DELETE /sources/{source_id}/topic-mappings/{topic_mapping_id}/tables/{table_id}
Responses
200

Success

objectobject
messagestring
resultstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Delete JSON Source Table

Delete JSON Source Table

Auth
DELETE /sources/{source_id}/file-mappings/{file_mapping_id}/tables/{table_id}
Responses
200

Success

objectobject
messagestring
resultstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get File Mappings for JSON source

Get File Mappings for JSON source

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

resolve_refboolean

To get entity details and created by user name

GET /sources/{source_id}/file-mappings
Responses
200

Success

objectobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Create File Mapping For JSON Source

Create File Mapping For JSON Source

Auth
Request Body
namestring
source_relative_pathstring
record_scopestring

Enum: file,line

include_subdirectoriesboolean
character_encodingstring
include_filename_regexstring
exclude_filename_regexstring
POST /sources/{source_id}/file-mappings
Responses
200

Success

objectobject
messagestring
resultstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get File Mappings for JSON source by id

Get File Mappings for JSON source by id

Auth
GET /sources/{source_id}/file-mappings/{file_mapping_id}
Responses
200

Success

objectobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Delete File Mapping For JSON Source

Delete File Mapping For JSON Source

Auth
DELETE /sources/{source_id}/file-mappings/{file_mapping_id}
Responses
200

Success

objectobject
messagestring
resultstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Update File Mapping For JSON Source

Update File Mapping For JSON Source

Auth
Request Body
namestring
source_relative_pathstring
record_scopestring

Enum: file,line

include_subdirectoriesboolean
character_encodingstring
include_filename_regexstring
exclude_filename_regexstring
PATCH /sources/{source_id}/file-mappings/{file_mapping_id}
Responses
200

Success

objectobject
messagestring
resultstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get File Mapping Data Preview

Get File Mapping Data Preview

Auth
GET /sources/{source_id}/file-mappings/{file_mapping_id}/preview
Responses
200

Success

objectobject
messagestring
resultobject
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Crawl Schema For File Mapping

Crawl Schema For File Mapping

Auth
GET /sources/{source_id}/file-mappings/{file_mapping_id}/crawl-schema
Responses
200

Success

objectobject
messagestring
resultobject
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get Table Schema From Mapping

Get Table Schema From Mapping

Auth
Query String
selected_keysstring
GET /sources/{source_id}/file-mappings/{file_mapping_id}/table-schema
Responses
200

Success

objectobject
messagestring
resultobject
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Create JSON Source Table

Create JSON Source Table

Auth
Request Body
objectobject
POST /sources/{source_id}/file-mappings/{file_mapping_id}/tables
Responses
200

Success

objectobject
messagestring
resultstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get JSON Source Table

Get JSON Source Table

Auth
GET /sources/{source_id}/file-mappings/{file_mapping_id}/tables/{table_id}
Responses
200

Success

objectobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Add/Edit Configuration for streaming options of a table group.

Add/Edit Configuration for streaming options of a table group.

Auth
Request Body
objectobject
statestring

Enum: enabled,disabled

engineobject
topic_identifierobject
typestring

Enum: list,regex

valuestring
streaming_frequencystring

Enum: minutes,hours,days

streaming_valueinteger
record_typeobject
PUT /sources/{source_id}/table/{table_id}/configurations/streaming
Responses
200

Ok

objectobject
resultobject
statusstring
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get streaming configuration of given table.

Get streaming configuration of given table.

Auth
GET /sources/{source_id}/table/{table_id}/configurations/streaming
Responses
200

Ok.

objectobject
table_idstring
statusstring
job_idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get tables for whom streaming configurations are set in a particular source.

Get tables for whom streaming configurations are set in a particular source.

Auth
Query String
filterstring

Filter results query

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

GET /sources/{source_id}/streaming-tables
Responses
200

Ok

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
resultobject
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get streaming table info.

Get streaming table info.

Auth
GET /sources/{source_id}/streaming-tables/{table_id}
Responses
200

Ok

objectobject
table_idstring
statusstring
job_idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Tables

Creates the file mapping (table) of the csv source.

Creates the previously configured file mapping (table) of the csv source.

Auth
Request Body

This is the JSON body of request containing configured Table object.

objectobject
header_rows_countint64
column_separatorstring
column_enclosed_bystring
escape_characterstring
encodingstring
enable_pk_chunkboolean
record_width_typestring
record_separatorstring
columns_configurationarray
column_widthinteger
POST /sources/{source_id}/tables/{table_id}/configurations/file-mapping
Responses
200

Success

objectobject
resultobject
statusstring
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Modifies the file mapping (table) of the csv source.

Modifies the previously configured file mapping (table) of the csv source.

Auth
Request Body
objectobject
header_rows_countint64
column_separatorstring
column_enclosed_bystring
escape_characterstring
encodingstring
enable_pk_chunkboolean
record_width_typestring
record_separatorstring
columns_configurationarray
column_widthinteger
PUT /sources/{source_id}/tables/{table_id}/configurations/file-mapping
Responses
200

Ok

objectobject
resultobject
statusstring
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Updates the file mapping (table) of the csv source.

Updates the previously configured file mapping (table) of the csv source.

Auth
Request Body
objectobject
header_rows_countint64
column_separatorstring
column_enclosed_bystring
escape_characterstring
encodingstring
enable_pk_chunkboolean
record_width_typestring
record_separatorstring
columns_configurationarray
column_widthinteger
PATCH /sources/{source_id}/tables/{table_id}/configurations/file-mapping
Responses
200

Ok

objectobject
resultobject
statusstring
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

update source metadata

update source metadata

Auth
Request Body

Source Metadata

objectobject
tags_to_addarray[string]
tags_to_removearray[string]
is_favoriteboolean
descriptionstring
PUT /sources/{source_id}/metadata
Responses
200

OK

objectobject
resultobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

get source metadata

get source metadata

Auth
GET /sources/{source_id}/metadata
Responses
200

get source metadata

objectobject
tagsarray[string]
is_favoriteboolean
descriptionstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

get whether staging fields can be edited

get whether staging fields can be edited

Auth
GET /sources/{source_id}/edit-staging-fields
Responses
200

get whether staging fields can be edited

objectobject
messagestring
resultboolean
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get the list of Source Files paths of the table

Get the list of Source Files paths of the table

Auth
GET /sources/{source_id}/tables/{table_id}/jobs/{job_id}/reports/sourceFilesPath
Responses
200

OK

objectobject
resultarray[object]
resultarray[string]
limitinteger
offsetinteger
linksobject
total_countinteger
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get meta crawled table count

Get meta crawled table count

Auth
GET /sources/{source_id}/meta-crawled-table-count
Responses
200

OK

objectobject
messagestring
countnumber
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get List of excluded tables

Get List of source table which are not yet ingested

Auth
GET /sources/{source_id}/source_tables/excluded-tables
Responses
200

OK

objectobject
messagestring
resultarray[object]
idstring
tableNamestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get Source schema

Get all distinct schema for a given source table

Auth
GET /sources/{source_id}/source_tables/schema-for-source
Responses
200

OK

objectobject
messagestring
resultarray[object]
schemaNamestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

list all the tables in the source

list all the tables in the source

Auth
Query String
limitinteger

The numbers of items to return

Default: 10

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

resolve_refboolean

To get entity details and created by user name

GET /sources/{source_id}/tables
Responses
200

successful operation

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray[object]
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Add tables to a File Source

Add tables to a File Source

Auth
Request Body
objectobject
namestring
sourcestring

It refers to the source id to which tables needs to be added

configurationobject
record_header_namearray[string]

This is required in case the recordType field is Variable Length Custom Header(VCH) or Variable Block Custom Header(VBCH)

main_copybookobject

Upload the main copy file

custom_copybookobject

This is required in case the recordType field is Variable Length Custom Header(VCH) or Variable Block Custom Header(VBCH)

comment_up_to_char_arrayarray[integer]

This is required in case the recordType field is Variable Length Custom Header(VCH) or Variable Block Custom Header(VBCH)

comment_after_char_arrayarray[integer]

This is required in case the recordType field is Variable Length Custom Header(VCH) or Variable Block Custom Header(VBCH)

update_objectobject

Required only in case of patch request

POST /sources/{source_id}/tables
Responses
200

successful operation

objectobject
messagestring
resultobject
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

list all the tables in the source

list all the tables in the source

Auth
Query String
limitinteger

The numbers of items to return

Default: 10

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

resolve_refboolean

To get entity details and created by user name

filterstring

Filter results query

POST /sources/{source_id}/fetch-tables
Responses
200

successful operation

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray[object]
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get Table Info

Get Table Info

Auth
GET /sources/{source_id}/tables/{table_id}
Responses
200
objectobject
messagestring
resultobject
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Update the Table

Update the table Metadata

Auth
Request Body

Update the table Metadata

objectobject
namestring
sourcestring

It refers to the source id to which tables needs to be added

configurationobject
record_header_namearray[string]

This is required in case the recordType field is Variable Length Custom Header(VCH) or Variable Block Custom Header(VBCH)

main_copybookobject

Upload the main copy file

custom_copybookobject

This is required in case the recordType field is Variable Length Custom Header(VCH) or Variable Block Custom Header(VBCH)

comment_up_to_char_arrayarray[integer]

This is required in case the recordType field is Variable Length Custom Header(VCH) or Variable Block Custom Header(VBCH)

comment_after_char_arrayarray[integer]

This is required in case the recordType field is Variable Length Custom Header(VCH) or Variable Block Custom Header(VBCH)

update_objectobject

Required only in case of patch request

PATCH /sources/{source_id}/tables/{table_id}
Responses
200

OK

objectobject
resultobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Delete Table for a source

Delete Table for a source

Auth
DELETE /sources/{source_id}/tables/{table_id}
Responses
200

Success

objectobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Crawl Table Schema

Crawl Table Schema

Auth
GET /sources/{source_id}/tables/{table_id}/crawl-schema
Responses
200
objectobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

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

Auth
Request Body
objectobject
tables_to_addarray[object]
POST /sources/{source_id}/tables/source_tables
Responses
200

successful operation

objectobject
messagestring
resultobject
added_tablesarray[string]
job_createdstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Updates and configures the table for Ingestion

Sets ingestion configuration for a table.

Auth
Request Body

Table ingestion Configuration

objectobject
sync_typestring

Enum: full-load,cdc-ogg,cdc-timestamp-column,cdc-query,cdc-batch-id,cdc-log

read_supported_enginesarray[string]

Enum: delta,avro,parquet,orc

typestring
subTypestring
sourceSubTypestring
target_table_namestring
target_schema_namestring
cdc_typestring
querystring
schema_namestring
table_namestring
exclude_legacy_audit_columnsstring
is_table_case_sensitivestring
is_schema_case_sensitivestring
is_database_case_sensitivestring
watermark_columnstring
capture_table_namestring
update_strategystring
fetch_mechanismstring
use_jdbcboolean
use_capture_tableboolean
is_scd2_tableboolean
ingest_subdirectoriesboolean
is_archive_enabledboolean
generate_history_viewboolean
enable_lower_bound_watermark_offsetboolean
does_table_contain_databoolean
lower_bound_watermark_offsetobject
partition_keysarray[object]
is_table_user_managedboolean
target_database_namestring
data_fetch_typestring
crawl_data_filter_enabledboolean
crawl_filter_conditionsarray[object]
split_by_keyobject
segmented_load_columnsarray[object]
PUT /sources/{source_id}/tables/{table_id}/configurations/ingestion
Responses
200

OK

objectobject
resultobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get ingestion configuration of table

Get ingestion configuration of table

Auth
GET /sources/{source_id}/tables/{table_id}/configurations/ingestion
Responses
200

get the ingestion configuration of table

objectobject
messagestring
json_schemaarray[object]
json_schema_breadcrumbarray
crawl_data_filter_enabledboolean
crawl_filter_conditionsarray
max_num_of_recordsinteger
streaming_modestring
streaming_frequency_typestring
streaming_frequency_numberinteger
error_thresholdinteger
source_file_typestring
natural_keysarray[string]
partition_keysarray[string]
target_relative_pathstring
update_strategystring
write_supported_enginesarray[string]
read_supported_enginesarray[string]
target_table_namestring
storage_formatstring
target_schema_namestring
sync_typestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get list of Entity advance configuration

Get list of Entity advance configuration

Auth
GET /sources/{source_id}/tables/{table_id}/configurations/advance
Responses
200

Limitby list of all the entity advance configuration sorted on the format user provided

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
resultsarray
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Add advance configuration for a table

Add advance configuration for a table

Auth
Request Body
objectobject
keystring
valuestring
descriptionstring
is_activeboolean
entity_idstring
entity_typestring
POST /sources/{source_id}/tables/{table_id}/configurations/advance
Responses
200

OK

objectobject
resultobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get table advance configuration

Get table advance configuration

Auth
GET /sources/{source_id}/tables/{table_id}/configurations/advance/{key}
Responses
200

Ok

objectobject
messagestring
keystring
valuestring
descriptionstring
isActiveboolean
entityIdstring
entityTypestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

update advance configuration for a table

update advance configuration for a table

Auth
Request Body

Table ingestion Configuration

arrayarray[object]
keystring
valuestring
entityIdstring
entityTypestring

Enum: table,pipeline

PUT /sources/{source_id}/tables/{table_id}/configurations/advance/{key}
Responses
200

OK

objectobject
resultobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Delete advance configuration for a table

Delete advance configuration for a table

Auth
DELETE /sources/{source_id}/tables/{table_id}/configurations/advance/{key}
Responses
200

OK

objectobject
resultobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

update table export configuration

update table export configuration

Auth
Request Body

Table export Configuration

objectobject
sync_typestring

Enum: DISABLED,OVERWRITE,APPEND,MERGE

target_typestring

Enum: BIG_QUERY,AZURE_SQL_DW,SNOWFLAKE,COSMOS_DB,DELIMITED,POSTGRES,TERADATA,ORACLE,SQLSERVER

columnsarray[object]
target_configurationobject
connection
objectobject
auth_typestring
connection_stringstring
databasestring
driver_namestring
password
stringstring

minLength: 1

tablestring
usernamestring
schemastring
query_tagstring
PUT /sources/{source_id}/tables/{table_id}/configurations/export
Responses
200

OK

objectobject
resultobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

get table export configuration

get table export configuration

Auth
GET /sources/{source_id}/tables/{table_id}/configurations/export
Responses
200

get table export configuration

objectobject
sync_typestring

Enum: DISABLED,OVERWRITE,APPEND,MERGE

target_typestring

Enum: BIG_QUERY,AZURE_SQL_DW,SNOWFLAKE,COSMOS_DB,DELIMITED,POSTGRES,TERADATA,ORACLE,SQLSERVER

columnsarray[object]
target_configurationobject
connection
objectobject
auth_typestring
connection_stringstring
databasestring
driver_namestring
password
stringstring

minLength: 1

tablestring
usernamestring
schemastring
query_tagstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

update table column order

update table column order

Auth
Request Body

Table Column Order

objectobject
namestring
target_column_positionnumber
PATCH /sources/{source_id}/tables/{table_id}/column-order
Responses
200

OK

objectobject
resultobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

update table metadata

update table metadata

Auth
Request Body

Table Metadata

objectobject
tags_to_addarray[string]
tags_to_removearray[string]
is_favoriteboolean
descriptionstring
PUT /sources/{source_id}/tables/{table_id}/metadata
Responses
200

OK

objectobject
resultobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

get table metadata

get table metadata

Auth
GET /sources/{source_id}/tables/{table_id}/metadata
Responses
200

get table metadata

objectobject
tagsarray[string]
is_favoriteboolean
descriptionstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get table export configuration connection properties

Get table export configuration connection properties

Auth
GET /sources/{source_id}/tables/{table_id}/configurations/export/connection
Responses
200

OK

objectobject
resultobject
schema
objectobject
auth_typestring
connection_stringstring
databasestring
driver_namestring
password
stringstring

minLength: 1

tablestring
usernamestring
schemastring
query_tagstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

update table export configuration Connection properties

update table export configuration Connection properties

Auth
Request Body

Table export Configuration connection properties

objectobject
auth_typestring
connection_stringstring
databasestring
driver_namestring
password
stringstring

minLength: 1

tablestring
usernamestring
schemastring
query_tagstring
PUT /sources/{source_id}/tables/{table_id}/configurations/export/connection
Responses
200

OK

objectobject
resultobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Start Segmentation on a Table

Start Segmentation on a Table

Auth
Path Params
source_idstring

Source Id.

table_idstring

Table Id.

Request Body
derive_formatstring

Enum: yyyy,MM,dd,yyyyMM,MMdd,yyyyMMdd

derive_functionstring

Enum: year,month,day num in month,year month,month day,year month day

extract_from_columnboolean
namestring
sql_typeinteger
POST /sources/{source_id}/tables/{table_id}/segmentation/start
Responses
200

Success

objectobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Crawl Segments Metadata on a Table

Crawl Segments Metadata on a Table

Auth
Path Params
source_idstring

Source Id.

table_idstring

Table Id.

POST /sources/{source_id}/tables/{table_id}/segmentation/crawl
Responses
200

Success

objectobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get Table Segments of a Table

Get Table Segments of a Table

Auth
Path Params
source_idstring

Source Id.

table_idstring

Table Id.

Query String
crawl_segmentsstring

if true, crawls Segments Metadata if they haven't been already crawled, default is false

GET /sources/{source_id}/tables/{table_id}/segmentation
Responses
200

Success

objectobject
messagestring
idstring
segmented_ingested_countinteger
total_segments_countinteger
total_countinteger
table_idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

End Segmentation on a Table

End Segmentation on a Table

Auth
Path Params
source_idstring

Source Id.

table_idstring

Table Id.

POST /sources/{source_id}/tables/{table_id}/segmentation/end
Responses
200

Success

objectobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Cancel Segmentation on a Table

Cancel Segmentation on a Table

Auth
Path Params
source_idstring

Source Id.

table_idstring

Table Id.

POST /sources/{source_id}/tables/{table_id}/segmentation/cancel
Responses
200

Success

objectobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get the schema of the table

Get the schema of the table

Auth
GET /sources/{source_id}/tables/{table_id}/configurations/schema
Responses
200

OK

objectobject
resultarray
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Update the schema of the table

Update the schema of the table

Auth
Request Body
objectobject
typestring

Enum: column

columnsarray[object]
PUT /sources/{source_id}/tables/{table_id}/configurations/schema
Responses
200

OK

objectobject
resultobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

configurations

Auth
GET /sources/{source_id}/tables/{table_id}/configurations
Responses
200

OK

objectobject
json_schemaarray[object]
json_schema_breadcrumbarray
crawl_data_filter_enabledboolean
crawl_filter_conditionsarray
topic_identifierobject
typestring
listarray
max_num_of_recordsinteger
streaming_modestring
streaming_frequency_typestring
streaming_frequency_numberinteger
error_thresholdinteger
source_file_typestring
target_relative_pathstring
update_strategystring
write_supported_enginesarray[string]
read_supported_enginesarray[string]
target_table_namestring
storage_formatstring
target_schema_namestring
sync_typestring
advance_configurationarray
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get a list of all table segments.

Get a list of all table segments.

Auth
GET /sources/{source_id}/tables/{table_id}/segments
Responses
200

Limitby list of all the tables segments sorted on the format user provided

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
resultsarray[object]
valuestring
connection_quotastring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Gets Validation Specs for a Table.

Gets Validation Specs for a given TableId.

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /sources/{source_id}/tables/{table_id}/validation-specs
Responses
200

Success

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Add Validation Specs to a Table.

Add Validation Specs to a Table.

Auth
Request Body
objectobject
namestring
column_namestring
table_idstring
typestring
regex_expressionstring
POST /sources/{source_id}/tables/{table_id}/validation-specs
Responses
200

Success

objectobject
messagestring
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Updates the Validation Specs for a table.

Updates the Validation Specs for a table.

Auth
Request Body
objectobject
namestring
column_namestring
table_idstring
typestring
regex_expressionstring
PATCH /sources/{source_id}/tables/{table_id}/validation-specs/{validation_spec_id}
Responses
200

Ok

objectobject
resultobject
statusstring
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Delete Validation Specs for a Table

Delete Validation Specs

Auth
DELETE /sources/{source_id}/tables/{table_id}/validation-specs/{validation_spec_id}
Responses
200

successful operation

objectobject
resultobject
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get table preview.

Get table preview.

Auth
GET /sources/{source_id}/table/{source_table_id}/get-preview
Responses
200

Success

objectobject
messagestring
resultobject
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Generate table preview.

Generate table preview.

Auth
GET /sources/{source_id}/table/{source_table_id}/generate-preview
Responses
200

Success

objectobject
messagestring
resultobject
statusstring
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Generate query table preview.

Generate query table preview.

Auth
GET /sources/{source_id}/query_table/generate-preview
Responses
200

Success

objectobject
messagestring
resultobject
statusstring
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get query table preview.

Get query table preview.

Auth
GET /sources/{source_id}/query_table/get-preview
Responses
200

Success

objectobject
messagestring
resultobject
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get Preview Queries.

Gets Preview Queries.

Auth
GET /sources/{source_id}/tables/{table_id}/generateQueries
Responses
200

Success

objectobject
messagestring
resultobject
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get multiple table Ids

Get multiple table Ids

Auth
GET /tables/
Responses
200

OK

objectobject
messagestring
resultarray[object]
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

update table metadata

update table metadata

Auth
Request Body

Table Metadata

objectobject
tags_to_addarray[string]
tags_to_removearray[string]
is_favoriteboolean
descriptionstring
columns_descriptionsarray[object]
namestring
descriptionstring
PATCH /tables/{table_id}/metadata
Responses
200

OK

objectobject
resultobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

get table metadata

get table metadata

Auth
GET /tables/{table_id}/metadata
Responses
200

get table metadata

objectobject
tagsarray[string]
is_favoriteboolean
descriptionstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

get table lineage

get table lineage

Auth
GET /tables/{table_id}/lineage
Responses
200

get table lineage

objectobject
tableobject
domainsobject
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Add a `Table Group`.

Add a Table Group.

Auth
Request Body
objectobject
idstring
sourcestring
environment_compute_template_idstring
namestring
max_connectionsinteger
max_parallel_entitiesinteger
tablesarray
compute_cluster_namestring
POST /sources/{source_id}/table-groups
Responses
200

Success

objectobject
messagestring
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Gets `Table Group` list.

Gets Table Group list.

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

resolve_refboolean

To get entity details and created by user name

GET /sources/{source_id}/table-groups
Responses
200

Success

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Gets `Table Group` object for given id.

Gets Table Group object for given id.

Auth
Query String
resolve_refboolean

To get entity details and created by user name

GET /sources/{source_id}/table-groups/{table_group_id}
Responses
200

Success

objectobject
messagestring
idstring
sourcestring
environment_compute_template_idstring
namestring
max_connectionsinteger
max_parallel_entitiesinteger
tablesarray
compute_cluster_namestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Update `Table Group` object for given id.

Update Table Group object for given id.

Auth
Request Body
objectobject
environment_compute_template_idstring
namestring
max_connectionsinteger
max_parallel_entitiesinteger
query_tagstring
tablesarray
table_idstring
connection_quotainteger
PUT /sources/{source_id}/table-groups/{table_group_id}
Responses
200

Success

objectobject
resultobject
messagestring
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

{table_group_id}

Auth
DELETE /sources/{source_id}/table-groups/{table_group_id}
Responses
200

Success

messagestring
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

This will Configure particular `Table Group` with `tableGroupId`.

This will Configure particular Table Group with tableGroupId.

Auth
Request Body

This is the JSON body of request containing configured Table group object.

objectobject
tablesarray[object]
table_idstring
connection_quotainteger
POST /sources/{source_id}/table-groups/{table_group_id}/configurations
Responses
200

Success

objectobject
resultobject
statusstring
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

This will fetch array of audit logs for table group with `tableGroupId`.

This will fetch array of audit logs for table group with tableGroupId.

Auth
GET /sources/{source_id}/table-groups/{table_group_id}/audit-logs
Responses
200

Success

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Gets `Table to Table Group` Mapping.

Gets Table to Table Group Mapping list.

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /sources/{source_id}/tables-to-table-groups-mapping
Responses
200

Success

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultobject
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get Table Group Schedule

Retrieves the table group schedule.

Auth
GET /sources/{source_id}/table-groups/{table_group_id}/schedules
Responses
200

Success

objectobject
messagestring
entity_idstring
schedule_typestring

Enum: workflow-build,metadata_cleanup,mongo-backup,table-group-cdc,table

schedule_usernamestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Enable Table Group Schedule

Enables the table group schedule.

Auth
Request Body
Generic Scheduleobject

Generic schedule object

schedule_statusstring

Enum: enabled,disabled

start_datestring

Start time should be after current time.

pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$

start_hourinteger

maximum: 23

minimum: 0

start_mininteger

maximum: 59

minimum: 0

repeat_interval_unitstring

Enum: NEVER,MINUTE,HOUR,DAY,WEEK,MONTH

Default: NEVER

repeat_interval_measureinteger

minimum: 1

repeat_on_last_dayboolean

specified_days must be provided if repeat_on_last_day is false. Applicable for repeat_interval_unit=MONTH

Default: false

specified_daysarray[integer]

Applicable when repeat_interval_unit is WEEK or MONTH.

minLength: 1

endsboolean

end_date, end_hour, end_min must be provided if ends is true.

Default: false

end_datestring

End time should be after start time.

pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$

end_hourinteger

maximum: 23

minimum: 0

end_mininteger

maximum: 59

minimum: 0

is_custom_jobboolean

custom_job_details must be provided when is_custom_job=true. Applicable when repeat_interval_unit is DAY, WEEK or MONTH.

Default: false

custom_job_detailsobject
PUT /sources/{source_id}/table-groups/{table_group_id}/schedules/enable
Responses
200

Ok

objectobject
messagestring
resultobject
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Disable Table Group Schedule

Disables the table group schedule.

Auth
PUT /sources/{source_id}/table-groups/{table_group_id}/schedules/disable
Responses
200

Ok

objectobject
messagestring
resultobject
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Configure Table Group Schedule User

Configures the table group schedule user.

Auth
PUT /sources/{source_id}/table-groups/{table_group_id}/schedules/user
Responses
200

Ok

objectobject
messagestring
resultobject
idstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Domains

Get the Target Data Connection

Get the Target Data Connection

Auth
GET /admin/data-connections/{data_connection_id}
Responses
200

Ok

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Edit the Target Data Connections Associated with a Domain

Edit the Target Data Connections Associated with a Domain

Auth
Request Body
typestring
namestring
connection_urlstring
account_namestring
usernamestring
passwordstring
warehousestring
additional_paramsstring
PUT /admin/data-connections/{data_connection_id}
Responses
200

Ok

objectobject
messagestring
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Patch the Target Data Connection

Patch the Target Data Connection

Auth
Request Body
typestring
namestring
connection_urlstring
account_namestring
usernamestring
passwordstring
warehousestring
additional_paramsstring
PATCH /admin/data-connections/{data_connection_id}
Responses
200

Ok

objectobject
messagestring
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete the Target Data Connections Associated with a Domain

Delete the Target Data Connections Associated with a Domain

Auth
DELETE /admin/data-connections/{data_connection_id}
Responses
200

Ok

objectobject
messagestring
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get List of Domains

Get List of Domains

Auth
Query String
filterstring

Filter results query

limitinteger

The numbers of items to return

Default: 10

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

sort_bystring

Sort result on field

GET /admin/domains
Responses
200

Ok

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get List of Domains

Get List of Domains

Auth
Query String
filterstring

Filter results query

limitinteger

The numbers of items to return

Default: 10

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

sort_bystring

Sort result on field

GET /admin/domains/{domain_id}/accessible-sources-to-add
Responses
200

Ok

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
resultarray[array]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get List of Domains Users

Get List of Domains Users

Auth
Query String
filterstring

Filter results query

limitinteger

The numbers of items to return

Default: 10

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

sort_bystring

Sort result on field

GET /admin/domains/{domain_id}/domain-users
Responses
200

Ok

objectobject
messagestring
limitinteger
offsetinteger
linksobject
total_countinteger
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get List of Accessible Domains

Get List of Accessible Domains

Auth
Query String
filterstring

Filter results query

limitinteger

The numbers of items to return

Default: 10

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

sort_bystring

Sort result on field

GET /admin/domains/{domain_id}/accessible-domains-to-add
Responses
200

Ok

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
resultarray[array]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get List of Domains Pipeline Extensions

Get List of Domains Pipeline Extensions

Auth
Query String
filterstring

Filter results query

limitinteger

The numbers of items to return

Default: 10

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

sort_bystring

Sort result on field

GET /admin/domains/{domain_id}/accessible-pipeline-extensions-to-add
Responses
200

Ok

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
resultarray[array]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get List of Domains

Get List of Domains

Auth
Query String
filterstring

Filter results query

limitinteger

The numbers of items to return

Default: 10

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

sort_bystring

Sort result on field

GET /domains
Responses
200

Ok

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Add a domain. (Requires Admin Access)

Add a domain. (Requires Admin Access)

Auth
Request Body
objectobject
namestring
descriptionstring
secretsarray[string]
environment_idsarray[string]
usersarray[string]
POST /domains
Responses
200

ok

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get description of a domain_id. (Requires Admin Access)

Get description of a domain_id. (Requires Admin Access)

Auth
Path Params
domain_idstring
GET /domains/{domain_id}
Responses
200

ok

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Edit name and description of a domain. (Requires Admin Access)

Edit name and description of a domain. (Requires Admin Access)

Auth
Path Params
domain_idstring
Request Body
objectobject
namestring
PATCH /domains/{domain_id}
Responses
200

ok

objectobject
idstring
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete a Domain (Requires Admin Access).

Delete a Domain (Requires Admin Access).

Auth
Path Params
domain_idstring
DELETE /domains/{domain_id}
Responses
200

Ok.

objectobject
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get all the Sources associated with this Domain

Get all the Sources associated with this Domain

Auth
Path Params
domain_idstring
Query String
filterstring

Filter results query

limitinteger

The numbers of items to return

Default: 10

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

sort_bystring

Sort result on field

GET /domains/{domain_id}/accessible-sources
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Add Sources to this Domain (Requires Admin Access)

Add Sources to this Domain (Requires Admin Access)

Auth
Path Params
domain_idstring
Request Body
objectobject
entity_idsarray[string]
POST /domains/{domain_id}/accessible-sources
Responses
200

Ok.

objectobject
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update Sources to this Domain (Requires Admin Access)

Update Sources to this Domain (Requires Admin Access)

Auth
Path Params
domain_idstring
Request Body
objectobject
entity_idsarray[string]
PUT /domains/{domain_id}/accessible-sources
Responses
200

Ok.

objectobject
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Remove Source from this Domain (Requires Admin Access)

Remove Source from this Domain (Requires Admin Access)

Auth
Path Params
domain_idstring
DELETE /domains/{domain_id}/accessible-sources
Responses
200

Ok.

objectobject
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get all the Domains associated with this Domain

Get all the Domains associated with this Domain

Auth
Path Params
domain_idstring
Query String
filterstring

Filter results query

limitinteger

The numbers of items to return

Default: 10

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

sort_bystring

Sort result on field

GET /domains/{domain_id}/accessible-domains
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Add Domains to this Domain (Requires Admin Access)

Add Domains to this Domain (Requires Admin Access)

Auth
Path Params
domain_idstring
Request Body
objectobject
entity_idsarray[string]
POST /domains/{domain_id}/accessible-domains
Responses
200

Ok.

objectobject
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update accessible-domain in this Domain (Requires Admin Access)

Update accessible-domain in this Domain (Requires Admin Access)

Auth
Path Params
domain_idstring
Request Body
objectobject
entity_idsarray[string]
PUT /domains/{domain_id}/accessible-domains
Responses
200

Ok.

objectobject
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Remove Domain from this Domain (Requires Admin Access)

Remove Domain from this Domain (Requires Admin Access)

Auth
Path Params
domain_idstring
DELETE /domains/{domain_id}/accessible-domains
Responses
200

Ok.

objectobject
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get all the workflows associated with this Domain

Get all the workflows associated with this Domain

Auth
Path Params
domain_idstring
GET /domains/{domain_id}/accessible-workflows
Responses
200

Ok.

objectobject
messagestring
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get all the tablegroups associated with this Domain

Get all the tablegroups associated with this Domain

Auth
Path Params
domain_idstring
GET /domains/{domain_id}/accessible-table-groups
Responses
200

Ok.

objectobject
messagestring
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get all the interactive computes associated with this Domain

Get all the interactive computes associated with this Domain

Auth
Path Params
domain_idstring
GET /domains/{domain_id}/accessible-interactive-computes
Responses
200

Ok.

objectobject
messagestring
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get all the pipelines associated with this Domain

Get all the pipelines associated with this Domain

Auth
Path Params
domain_idstring
GET /domains/{domain_id}/accessible-pipelines
Responses
200

Ok.

objectobject
messagestring
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get all the Pipeline Extensions associated with this Domain

Get all the Pipeline Extensions associated with this Domain

Auth
Path Params
domain_idstring
Query String
filterstring

Filter results query

limitinteger

The numbers of items to return

Default: 10

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

sort_bystring

Sort result on field

GET /domains/{domain_id}/accessible-pipeline-extensions
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update accessible-pipeline-extensions in this Domain (Requires Admin Access)

Update accessible-pipeline-extensions in this Domain (Requires Admin Access)

Auth
Path Params
domain_idstring
Request Body
objectobject
entity_idsarray[string]
PUT /domains/{domain_id}/accessible-pipeline-extensions
Responses
200

Ok.

objectobject
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Add Pipeline Extensions to this Domain (Requires Admin Access)

Add Pipeline Extensions to this Domain (Requires Admin Access)

Auth
Path Params
domain_idstring
Request Body
objectobject
entity_idsarray[string]
POST /domains/{domain_id}/accessible-pipeline-extensions
Responses
200

Ok.

objectobject
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Remove Pipeline Extension from this Domain (Requires Admin Access)

Remove Pipeline Extension from this Domain (Requires Admin Access)

Auth
Path Params
domain_idstring
DELETE /domains/{domain_id}/accessible-pipeline-extensions
Responses
200

Ok.

objectobject
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

{key}

Domain Advanced Configurations

Auth
Path Params
domain_idstring
keystring
Request Body
valuestring
descriptionstring
isActiveboolean
PUT /domains/{domain_id}/configurations/advance/{key}
Responses
200

Ok.

objectobject
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

{key}

update advanced configs

Auth
Path Params
domain_idstring
keystring
Request Body
valuestring
PATCH /domains/{domain_id}/configurations/advance/{key}
Responses
200

Ok.

objectobject
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

{key}

delete advanced configs

Auth
Path Params
domain_idstring
keystring
DELETE /domains/{domain_id}/configurations/advance/{key}
Responses
200

Ok.

objectobject
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get recently used entities associated with this Domain

Get recently used entities associated with this Domain

Auth
GET /domains/{domain_id}/recently-used-entities
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Add Recently Used Entity to this Domain

Add Recently Used Entity to this Domain

Auth
Path Params
domain_idstring
Request Body
objectobject
entity_typestring
entity_idstring
POST /domains/{domain_id}/recently-used-entities
Responses
200

Ok.

objectobject
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get comments associated with this Domain

Get comments associated with this Domain

Auth
GET /domains/{domain_id}/comments
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray[object]
commentstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Add comment to this Domain

Add comment to this Domain

Auth
Path Params
domain_idstring
Request Body
objectobject
commentstring
POST /domains/{domain_id}/comments
Responses
200

Ok.

objectobject
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get notifications associated with this Domain

Get notifications associated with this Domain

Auth
GET /domains/{domain_id}/notifications
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Table Orders With Hierachy

Get Table Orders With Hierachy

Auth
GET /domains/{domain_id}/pipelines/{pipeline_id}/versions/{version_id}/node/{node_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Domains Pipeline and Accessibele Sources

Get Domains Pipeline and Accessibele Sources

Auth
GET /domains/{domain_id}/environment_details_pipelines_accessible_sources
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Pipelines

Get all pipelines of all domains

Get all pipelines of all domains

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/pipelines
Responses
200

Success

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray
idstring
namestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Change the active version of the Pipeline

Change the active version of the Pipeline

Auth
Path Params
domain_idstring
pipeline_idstring
version_idstring
Query String
filterstring

Filter results query

limitinteger

The numbers of items to return

Default: 10

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

sort_bystring

Sort result on field

POST /domains/{domain_id}//pipelines/{pipeline_id}/versions/{version_id}/set-active
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get all pipelines for domain with `domain_id`

Get all pipelines for domain with domain_id

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /domains/{domain_id}/pipelines
Responses
200

Success

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray
environmentobject
ephemeral_computearray[object]
interactive_computearray[object]
storagearray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

create new pipeline for domain with `domain_id`

create new pipeline for domain with domain_id

Auth
Request Body
objectobject
namestring
batch_enginestring

Enum: SPARK,BIGQUERY,SNOWFLAKE

storage_idstring
compute_template_idstring
ml_enginestring

Enum: SPARK

snowflake_profilestring
snowflake_warehousestring
POST /domains/{domain_id}/pipelines
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Gets a `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.

Gets a pipeline with {pipeline_id} in domain with {domain_id}.

Auth
GET /domains/{domain_id}/pipelines/{pipeline_id}
Responses
200

Success

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Deletes a `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.

Deletes a pipeline with {pipeline_id} in domain with {domain_id}.

Auth
DELETE /domains/{domain_id}/pipelines/{pipeline_id}
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Updates a `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.

Updates a pipeline with {pipeline_id} in domain with {domain_id}.

Auth
Request Body
objectobject
namestring
descriptionstring
compute_template_idstring
active_version_idstring
query_tagstring
PUT /domains/{domain_id}/pipelines/{pipeline_id}
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

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}.

Auth
GET /domains/{domain_id}/pipelines/{pipeline_id}/impacted-workflows
Responses
200

Success

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

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}.

Auth
GET /domains/{domain_id}/pipelines/{pipeline_id}/analytics-models
Responses
200

Success

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get list of all versions of Pipeline

Get list of all versions of Pipeline

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /domains/{domain_id}/pipelines/{pipeline_id}/versions
Responses
200

Success

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Create a pipeline version

Creates a new pipeline version

Auth
Request Body
objectobject
descriptionstring
is_activeboolean
tagsobject
typestring

For sql type pipeline version, query field will contain the encrypted value of SQL query. For visual type pipeline version, model field will contain the model information. If no value is specified for this field, by default it will be inferred as visual.

Enum: visual,sql

Default: visual

querystring
modelobject
pipeline_parametersarray[object]
keystring
valuestring
POST /domains/{domain_id}/pipelines/{pipeline_id}/versions
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

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}.

Auth
GET /domains/{domain_id}/pipelines/{pipeline_id}/versions/{version_id}
Responses
200

Success

objectobject
idstring
created_atstring
created_bystring
modified_atstring
modified_bystring
pipeline_idstring
versionnumber

minimum: 1

descriptionstring
is_activeboolean
tagsobject
typestring

For sql type pipeline version, query field will contain the encrypted value of SQL query. For visual type pipeline version, model field will contain the model information. If no value is specified for this field, by default it will be inferred as visual.

Enum: visual,sql

Default: visual

querystring
modelobject
pipeline_parametersarray[object]
keystring
valuestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

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}.

Auth
DELETE /domains/{domain_id}/pipelines/{pipeline_id}/versions/{version_id}
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

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}.

Auth
Request Body
objectobject
descriptionstring
is_activeboolean
tagsobject
generalarray[object]
modelobject
view_optionsobject
PATCH /domains/{domain_id}/pipelines/{pipeline_id}/versions/{version_id}
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

importSql

import sql

Auth
Headers
Content-Typestring

Http content type

Enum: application/json,multipart/form-data,text/plain

Default: application/json

Path Params
domain_idstring
pipeline_idstring
Query String
flag_pipeline_version_activeboolean

Flag to specify whether imported pipeline should be active or not

Default: true

Request Body
objectobject
dry_runboolean
sqlstring
sql_import_configurationobject
quoted_identifierstring
sql_dialectstring
POST /domains/{domain_id}/pipelines/{pipeline_id}/sql-import
Responses
200

Success

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Exports the pipeline configuration

Exports the pipeline configuration to JSON format for pipeline with pipeline_id in domain with domain_id

Auth
Query String
version_idstring
download_fileboolean

Default: false

GET /domains/{domain_id}/pipelines/{pipeline_id}/config-migration
Responses
200

Success

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Imports the pipeline configuration

Imports the pipeline configuration from JSON format for pipeline with pipeline_id in domain with domain_id.

Auth
Query String
use_uploaded_fileboolean

Default: false

Request Body
objectobject
configurationobject
dry_runboolean
import_configsobject
POST /domains/{domain_id}/pipelines/{pipeline_id}/config-migration
Responses
200

Success

objectobject
messagestring
result
objectobject
entity_idstring
to_entity_idstring
entity_typestring
recommendationobject
table_upsert_statusobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Gets lineage for Pipeline Column.

Gets lineage for Pipeline Column.

Auth
GET /domains/{domain_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/lineage
Responses
200

Success

objectobject
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Validate a pipeline

Validates a pipeline version

Auth
GET /domains/{domain_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/validate
Responses
200

Success

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Refresh sample data

Refreshes the sample data

Auth
GET /domains/{domain_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/refresh-sample-data
Responses
200

Success

objectobject
messagestring
resultobject
Response

Get node schema

Retrieves schema for a node in pipeline

Auth
GET /domains/{domain_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/nodes/{node_id}/schema
Responses
200

Success

objectobject
messagestring
resultobject
Response

Get node data

Retrieves data for a node in pipeline

Auth
GET /domains/{domain_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/nodes/{node_id}/data
Responses
200

Success

objectobject
messagestring
resultobject
Response

Get node query

Retrieves query for a node in pipeline

Auth
GET /domains/{domain_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/nodes/{node_id}/query
Responses
200

Success

objectobject
messagestring
resultobject
Response

Get target SQL preview

Retrieves SQL query preview for target node

Auth
GET /domains/{domain_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/nodes/{node_id}/sql-inspection
Responses
200

Success

objectobject
messagestring
resultobject
Response

Get Pipeline Version Audit Logs.

Get Pipeline Version Audit Logs

Auth
GET /domains/{domain_id}/pipelines/{pipeline_id}/versions/{version_id}/pipeline-version-audits
Responses
200

Success

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update Pipeline Version Audit Logs

Update Pipeline Version Audit Logs

Auth
Path Params
domain_idstring
Request Body
objectobject
auditsarray[object]
PATCH /domains/{domain_id}/pipelines/{pipeline_id}/versions/{version_id}/pipeline-version-audits
Responses
200

ok

objectobject
idstring
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Pipeline Version Audit Logs.

Get Pipeline Version Audit Logs

Auth
GET /domains/{domain_id}/pipelines/{pipeline_id}/pipeline-audits
Responses
200

Success

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

getTablesfromPipelineSources

getTablesfromPipelineSources

Auth
GET /domains/{domain_id}/accessible-tables-pipeline-sources
Responses
200

Success

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

File upload sql pipeline migration

File upload sql pipeline migration

Auth
Request Body
objectobject
filesfile

SQL File to be uploaded

PUT /domains/{domain_id}/pipelines/{pipeline_id}/upload-sql-file-pipeline
Responses
200

Ok

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Import sql pipeline migration

Import sql pipeline migration

Auth
Request Body
objectobject
dry_runboolean
sqlstring
sql_import_configurationobject
sql_dialectstring
quoted_identifierstring
import_jsonobject
PUT /domains/{domain_id}/pipelines/{pipeline_id}/import-sql-mappings
Responses
200

Success

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Pipeline Extensions List

Get Pipeline Extensions List

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/pipeline-extensions
Responses
200

Ok.

objectobject
messagestring
limitinteger
offsetinteger
linksobject
total_countinteger
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Pipeline Extensions List

Get Pipeline Extensions List

Auth
Headers
Content-Typestring

Http content type

Enum: application/json,multipart/form-data,text/plain

Default: application/json

Request Body
objectobject
namestring

pattern: ^[a-z0-9A-Z_-]+$

typestring

Enum: custom_transformation,custom_target

execution_typestring

Enum: JAVA,PYTHON

transformationsarray[object]
aliasstring
class_namestring
upload_optionstring

Enum: fileUpload,serverLocation

filesfile

Required files if upload_option is fileUpload

pathstring

Required folder_path if upload_option is serverLocation

additional_config_parametersarray[object]
POST /admin/pipeline-extensions
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Pipeline Extension by id

Get Pipeline Extension by pipeline_extension_id

Auth
GET /admin/pipeline-extensions/{pipeline_extension_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update Pipeline Extension by id

Update Pipeline Extension by pipeline_extension_id

Auth
Request Body
objectobject
namestring

pattern: ^[a-z0-9A-Z_-]+$

transformationsarray[object]

this will replace array wont append new transformations array

aliasstring
class_namestring
upload_optionstring

Enum: fileUpload,serverLocation

filesfile

Required files if upload_option is fileUpload

pathstring

Required folder_path if upload_option is serverLocation

additional_config_parametersarray[object]
PUT /admin/pipeline-extensions/{pipeline_extension_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete Pipeline Extension by id

Delete Pipeline Extension by pipeline_extension_id

Auth
DELETE /admin/pipeline-extensions/{pipeline_extension_id}
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get all files in Pipeline Extension by id

Get all files in Pipeline Extension by pipeline_extension_id

Auth
GET /admin/pipeline-extensions/{pipeline_extension_id}/files
Responses
200

Ok.

objectobject
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

add file in Pipeline Extension by id

add file in Pipeline Extension by pipeline_extension_id

Auth
Request Body
filefile
POST /admin/pipeline-extensions/{pipeline_extension_id}/files
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Pipeline Extensions List

Get Pipeline Extensions List

Auth
Headers
Content-Typestring

Http content type

Enum: application/json,multipart/form-data,text/plain

Default: application/json

Request Body
objectobject
namestring

pattern: ^[a-z0-9A-Z_-]+$

extension_typestring

Enum: Hive_UDF,Custom

execution_typestring

Enum: JAVA

upload_optionstring

Enum: fileUpload,serverLocation

transformationsarray[object]
server_pathstring

Required folder_path if upload_option is serverLocation

registered_udfboolean
ingestion_extension_typestring

Enum: source_extension,streaming_extension

POST /admin/source-extensions
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Source Extensions List

Get Source Extensions List

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/source-extensions
Responses
200

Ok.

objectobject
messagestring
limitinteger
offsetinteger
linksobject
total_countinteger
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Source Extension by id

Get Source Extension by source_extension_id

Auth
GET /admin/source-extensions/{source_extension_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update Source Extension by id

Update Source Extension by source_extension_id

Auth
Request Body
objectobject
namestring

pattern: ^[a-z0-9A-Z_-]+$

transformationsarray[object]

this will replace array wont append new transformations array

upload_optionstring

Enum: fileUpload,serverLocation

server_pathstring

Required folder_path if upload_option is serverLocation

registered_udfboolean
ingestion_extension_typestring

Enum: source_extension,streaming_extension

PUT /admin/source-extensions/{source_extension_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete Source Extension by id

Delete Source Extension by source_extension_id

Auth
DELETE /admin/source-extensions/{source_extension_id}
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get all files in Source Extension by id

Get all files in Source Extension by source_extension_id

Auth
GET /admin/source-extensions/{source_extension_id}/files
Responses
200

Ok.

objectobject
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

add file in Source Extension by id

add file in Source Extension by source_extension_id

Auth
Request Body
filefile
POST /admin/source-extensions/{source_extension_id}/files
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete File from Source Extension by file name

Delete File from Source Extension by file_name

Auth
DELETE /admin/source-extensions/{source_extension_id}/files/{file_name}
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get list of all Workflows for a `domain` with `{domain_id}`.

Get list of all Workflows for a domain with {domain_id}.

Auth
Headers
Content-Typestring

Http content type

Enum: application/json,multipart/form-data,text/plain

Default: application/json

Path Params
domain_idstring
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /domains/{domain_id}/workflows
Responses
200

Success

objectobject
messagestring
limitinteger
offsetinteger
linksobject
total_countinteger
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Create Workflow for a `domain` with `{domain_id}`.

Create Workflow for a domain with {domain_id}.

Auth
Headers
Content-Typestring

Http content type

Enum: application/json,multipart/form-data,text/plain

Default: application/json

Path Params
domain_idstring
Request Body

This is the JSON body of request containing configured Workflow object.

objectobject
namestring
descriptionstring
active_version_idstring
child_workflow_idsarray[string]
impactnumber
POST /domains/{domain_id}/workflows
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Gets a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`.

Gets a workflow with {workflow_id} in domain with {domain_id}.

Auth
Path Params
domain_idstring
workflow_idstring
GET /domains/{domain_id}/workflows/{workflow_id}
Responses
200

Success

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Deletes a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`.

Deletes a workflow with {workflow_id} in domain with {domain_id}.

Auth
Path Params
domain_idstring
workflow_idstring
DELETE /domains/{domain_id}/workflows/{workflow_id}
Responses
200

Success

objectobject
messagestring
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`.

Update a workflow with {workflow_id} in domain with {domain_id}.

Auth
Path Params
domain_idstring
workflow_idstring
Request Body
objectobject
namestring
descriptionstring
active_version_idstring
child_workflow_idsarray[string]
impactnumber
PATCH /domains/{domain_id}/workflows/{workflow_id}
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Exports workflow configuration

Exports the workflow configuration to JSON format for workflow with workflow_id in domain with domain_id

Auth
Path Params
domain_idstring
workflow_idstring
Query String
version_idstring

ID of the workflow version to run. If omitted, the active version is used.

GET /domains/{domain_id}/workflows/{workflow_id}/config-migration
Responses
200

Success

objectobject
messagestring
configurationobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Imports workflow configuration

Imports the workflow configuration from JSON format for workflow with workflow_id in domain with domain_id.

Auth
Path Params
domain_idstring
workflow_idstring
Request Body

This is the JSON body of request containing configuration of the Workflow object.

objectobject
configurationobject
dry_runboolean
import_configsobject
map_active_versionboolean
PUT /domains/{domain_id}/workflows/{workflow_id}/config-migration
Responses
200

Success

objectobject
messagestring
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Runs the latest workflow

Runs the latest workflow with the provided workflow_id, domain_id, and returns workflow_run_id.

Auth
Path Params
domain_idstring
workflow_idstring
Query String
workflow_version_idstring

ID of the workflow version to run. If omitted, the active version is used.

Request Body

Optional Request Body containing Workflow Parameters to be submitted at Runtime and skip nodes to skip the workflow tasks at Runtime.

objectobject
workflow_parametersarray[object]
keystring
valuestring
skip_nodesarray[string]
POST /domains/{domain_id}/workflows/{workflow_id}/start
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

This will pause all running builds of `workflow` with `{workflow_id}`.

This will pause all running builds of workflow with {workflow_id}.

Auth
Path Params
domain_idstring
workflow_idstring
Query String
workflow_version_idstring

ID of the workflow version to pause.

POST /domains/{domain_id}/workflows/{workflow_id}/pause
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

This will resume all paused builds of `workflow` with `{workflow_id}`.

This will resume all paused builds of workflow with {workflow_id}.

Auth
Path Params
domain_idstring
workflow_idstring
Query String
workflow_version_idstring

ID of the workflow version to resume.

POST /domains/{domain_id}/workflows/{workflow_id}/resume
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get workflow lineage

Retrieves the workflow lineage

Auth
Path Params
domain_idstring
workflow_idstring
GET /domains/{domain_id}/workflows/{workflow_id}/lineage
Responses
200

Success

objectobject
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get workflow ancestors

Retrieves the workflow ancestors

Auth
Path Params
domain_idstring
workflow_idstring
GET /domains/{domain_id}/workflows/{workflow_id}/ancestors
Responses
200

Success

objectobject
messagestring
resultarray[string]

Workflow IDs of ancestors

400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

This will get all builds of `workflow` with `{workflow_id}`.

This will get all builds of workflow with {workflow_id}.

Auth
Headers
Content-Typestring

Http content type

Enum: application/json,multipart/form-data,text/plain

Default: application/json

Path Params
domain_idstring
workflow_idstring
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /domains/{domain_id}/workflows/{workflow_id}/runs
Responses
200

Success

objectobject
messagestring
limitinteger
offsetinteger
linksobject
total_countinteger
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

This will get a specific build of `workflow` with `{workflow_id}`.

This will get a specific build of workflow with {workflow_id}.

Auth
Headers
Content-Typestring

Http content type

Enum: application/json,multipart/form-data,text/plain

Default: application/json

Path Params
domain_idstring
workflow_idstring
workflow_run_idstring
GET /domains/{domain_id}/workflows/{workflow_id}/runs/{workflow_run_id}
Responses
200

Success

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

This will restart running `workflow` with `{workflow_id}`.

This will restart running workflow with {workflow_id}.

Auth
Path Params
domain_idstring
workflow_idstring
workflow_run_idstring
Request Body

Optional Request Body containing Skip Nodes to be skip workflow tasks at Runtime.

objectobject
skip_nodesarray[string]
POST /domains/{domain_id}/workflows/{workflow_id}/runs/{workflow_run_id}/restart
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

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.

Auth
Path Params
domain_idstring
workflow_idstring
workflow_run_idstring
POST /domains/{domain_id}/workflows/{workflow_id}/runs/{workflow_run_id}/cancel
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

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.

Auth
Path Params
domain_idstring
workflow_idstring
workflow_run_idstring
task_idstring
Query String
try_numberinteger

minimum: 1

GET /domains/{domain_id}/workflows/{workflow_id}/runs/{workflow_run_id}/tasks/{task_id}/logs
Responses
200

Success

Headers
try-numberinteger

Attempt number for retrieved task logs

total-attemptsinteger

Total attempts for the task

Body
stringstring

Task log

400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

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.

Auth
Path Params
domain_idstring
workflow_idstring
workflow_run_idstring
task_idstring
GET /domains/{domain_id}/workflows/{workflow_id}/runs/{workflow_run_id}/tasks/{task_id}/logs/download
Responses
200

Success

filefile
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Gets parents workflow details of the workflow

Gets parents workflow details of the workflow.

Auth
Path Params
domain_idstring
workflow_idstring
GET /domains/{domain_id}/workflows/{workflow_id}/parents
Responses
200

Success

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

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}.

Auth
Path Params
domain_idstring
workflow_idstring
workflow_run_idstring
task_idstring
Request Body

This is the JSON body of request containing workflow variable.

objectobject
keystring
valuestring
POST /domains/{domain_id}/workflows/{workflow_id}/runs/{workflow_run_id}/tasks/{task_id}/variables
Responses
200

Success

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Workflows

Get Workflows runs (This operation is only for operations_analyst user)

Auth
Request Body
objectobject
date_range
objectobject
typestring
unitstring

Enum: day,hour

valueinteger
order_bystring

Enum: asc,desc

minLength: 1

Default: desc

sort_bystring

minLength: 1

offsetinteger

minimum: 0

limitinteger

minimum: -1

Default: 20

run_time_hourinteger

minimum: 0

Default: Infinity

domain_idsarray[string]
source_idsarray[string]
entity_typestring

Enum: pipeline,source

minLength: 1

statusstring

Enum: success,failed,pending,running

minLength: 1

additional_filtersobject
POST /prodops/workflow_runs
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Retrieves the job details

Retrieve the details and status of any job. This is applicable only for the Operations Analyst user.

Auth
GET /prodops/workflow_runs/{run_id}/jobs
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Restart Multiple Workflows

Restart Multiple Workflows (This operation is only for operations_analyst user)

Auth
Request Body
objectobject
idsarray[object]
POST /prodops/workflows/restart
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Cancel Multiple Workflows

Cancel Multiple Workflows (This operation is only for operations_analyst user)

Auth
Request Body
objectobject
idsarray[object]
POST /prodops/workflows/cancel
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get all versions of a workflow

Get all versions of a workflow with {workflow_id} in domain with {domain_id}.

Auth
Path Params
domain_idstring
workflow_idstring
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /domains/{domain_id}/workflows/{workflow_id}/versions
Responses
200

Success

objectobject
messagestring
limitinteger
offsetinteger
linksobject
total_countinteger
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Create a new version of a workflow

Create a new version of a workflow with {workflow_id} in domain with {domain_id}.

Auth
Path Params
domain_idstring
workflow_idstring
Query String
source_workflow_version_idstring
Request Body

This is the JSON body of request containing configured Workflow Version object.

objectobject
versionnumber
descriptionstring
workflow_graphobject
child_workflow_version_idsarray[string]
workflow_parametersarray[object]
keystring
valuestring
view_optionsobject
is_pausedboolean
is_activeboolean
POST /domains/{domain_id}/workflows/{workflow_id}/versions
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get a specific version of a workflow

Get a specific version of a workflow with {workflow_id} in domain with {domain_id}.

Auth
Path Params
domain_idstring
workflow_idstring
workflow_version_idstring
GET /domains/{domain_id}/workflows/{workflow_id}/versions/{workflow_version_id}
Responses
200

Success

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update a specific version of a workflow

Update a specific version of a workflow with {workflow_id} in domain with {domain_id}.

Auth
Path Params
domain_idstring
workflow_idstring
workflow_version_idstring
Request Body

This is the JSON body of request containing updated Workflow Version object.

objectobject
versionnumber
descriptionstring
workflow_graphobject
child_workflow_version_idsarray[string]
workflow_parametersarray[object]
keystring
valuestring
view_optionsobject
is_pausedboolean
is_activeboolean
PUT /domains/{domain_id}/workflows/{workflow_id}/versions/{workflow_version_id}
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete a specific version of a workflow

Delete a specific version of a workflow with {workflow_id} in domain with {domain_id}.

Auth
Path Params
domain_idstring
workflow_idstring
workflow_version_idstring
DELETE /domains/{domain_id}/workflows/{workflow_id}/versions/{workflow_version_id}
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

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}.

Auth
Path Params
domain_idstring
workflow_idstring
workflow_version_idstring
Query String
resolve_refboolean

Default: false

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

GET /domains/{domain_id}/workflows/{workflow_id}/versions/{workflow_version_id}/audits
Responses
200

Success

objectobject
messagestring
limitinteger
offsetinteger
linksobject
total_countinteger
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

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.

Auth
Path Params
domain_idstring
workflow_idstring
workflow_version_idstring
POST /domains/{domain_id}/workflows/{workflow_id}/versions/{workflow_version_id}/set-active
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

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}.

Auth
Path Params
domain_idstring
workflow_idstring
workflow_version_idstring
task_idstring
Request Body

This is the JSON body of request containing workflow variable.

objectobject
keystring
valuestring
POST /domains/{domain_id}/workflows/{workflow_id}/versions/{workflow_version_id}/tasks/{task_id}/variables
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Schedules of Workflows belonging to this Domain.

Schedules of Workflows belonging to this Domain.

Auth
Path Params
domain_idstring
GET /domains/{domain_id}/schedules
Responses
200

Ok.

objectobject
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Schedules of particular Workflow belonging to this Domain.

Schedules of particular Workflow belonging to this Domain.

Auth
Path Params
domain_idstring
workflow_idstring
GET /domains/{domain_id}/workflows/{workflow_id}/schedules
Responses
200

Ok.

objectobject
messagestring
entity_idstring
schedule_typestring

Enum: workflow-build,metadata_cleanup,mongo-backup,table-group-cdc,table

schedule_usernamestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Enable Workflow Schedule

Enable Workflow Schedule

Auth
Path Params
domain_idstring
workflow_idstring
Request Body

Schedule Details

Generic Scheduleobject

Generic schedule object

schedule_statusstring

Enum: enabled,disabled

start_datestring

Start time should be after current time.

pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$

start_hourinteger

maximum: 23

minimum: 0

start_mininteger

maximum: 59

minimum: 0

repeat_interval_unitstring

Enum: NEVER,MINUTE,HOUR,DAY,WEEK,MONTH

Default: NEVER

repeat_interval_measureinteger

minimum: 1

repeat_on_last_dayboolean

specified_days must be provided if repeat_on_last_day is false. Applicable for repeat_interval_unit=MONTH

Default: false

specified_daysarray[integer]

Applicable when repeat_interval_unit is WEEK or MONTH.

minLength: 1

endsboolean

end_date, end_hour, end_min must be provided if ends is true.

Default: false

end_datestring

End time should be after start time.

pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$

end_hourinteger

maximum: 23

minimum: 0

end_mininteger

maximum: 59

minimum: 0

is_custom_jobboolean

custom_job_details must be provided when is_custom_job=true. Applicable when repeat_interval_unit is DAY, WEEK or MONTH.

Default: false

custom_job_detailsobject
PUT /domains/{domain_id}/workflows/{workflow_id}/schedules/enable
Responses
200

Ok

objectobject
messagestring
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Disable Workflow Schedule

Disable Workflow Schedule

Auth
Path Params
domain_idstring
workflow_idstring
PUT /domains/{domain_id}/workflows/{workflow_id}/schedules/disable
Responses
200

Ok

objectobject
messagestring
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Change Workflow Schedule User

Change Workflow Schedule User

Auth
Path Params
domain_idstring
workflow_idstring
PUT /domains/{domain_id}/workflows/{workflow_id}/schedules/user
Responses
200

Ok

objectobject
messagestring
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Jobs

Get the jobs details

Get the jobs details

Auth
Query String
limitinteger

The numbers of items to return

Default: 10

filterstring

Filter results query

resolve_refboolean

To get entity details and created by user name

GET /admin/jobs
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the job details with `job_id`

Get the job details with job_id

Auth
GET /admin/jobs/{job_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Resubmit Failed tables for ingestion

Resubmit Failed tables for ingestion

Auth
POST /admin/jobs/{job_id}/resubmit
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the job log as text stream with `job_id`

Get the job log as text stream with job_id

Auth
GET /admin/jobs/{job_id}/logs
Responses
200

Ok.

stringstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Download iw job logs zip for iw_job with job_id

Download iw job logs zip for iw_job with job_id

Auth
GET /admin/jobs/{job_id}/logs/download
Responses
200

Ok.

filefile
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get cluster jobs for iw_job with job_id

Get cluster jobs for iw_job with job_id

Auth
GET /admin/jobs/{job_id}/runs
Responses
200

Ok.

objectobject
messagestring
limitinteger
offsetinteger
linksobject
total_countinteger
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get cluster job for iw_job with job_id and run_id

Get cluster job for iw_job with job_id and run_id

Auth
GET /admin/jobs/{job_id}/runs/{run_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

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

Auth
GET /admin/jobs/{job_id}/runs/{run_id}/logs
Responses
200

Ok.

filefile
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the admin-jobs details

Get the admin-jobs details

Auth
GET /admin/admin-jobs
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get List of All jobs of this Source and it's artifacts.

Get List of All jobs of this Source and it's artifacts.

Auth
Query String
filterstring

Filter results query

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

GET /sources/{source_id}/jobs
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

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.

Auth
Request Body
DeleteEntityJobRequestSchemaobject
job_typestring

Enum: source_delete

purge_metadataboolean
POST /sources/{source_id}/jobs
Responses
200

Success

objectobject
messagestring
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get job with job id.

Get job with job id.

Auth
GET /sources/{source_id}/jobs/{job_id}
Responses
200

Ok.

objectobject
resultobject
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Resubmit Failed tables for ingestion

Resubmit Failed tables for ingestion

Auth
POST /sources/{source_id}/jobs/{job_id}/resubmit
Responses
200

Success

objectobject
resultobject
statusstring
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get crawl job info.

Get crawl job info.

Auth
GET /sources/{source_id}/jobs/{job_id}/summary
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray[object]
messagestring
timestampstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get Summary Logs for the Source Crawl Job.

Get Summary Logs for the Source Crawl Job.

Auth
Query String
num_linesinteger
GET /sources/{source_id}/jobs/{job_id}/logs
Responses
200

Ok.

stringstring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get Summary Logs for the Source Crawl Job.

Get Summary Logs for the Source Crawl Job.

Auth
GET /sources/{source_id}/jobs/{job_id}/logs/download
Responses
200

Ok.

filefile
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get List of All jobs of this Source and it's artifacts.

Get List of All jobs of this Source and it's artifacts.

Auth
Query String
filterstring

Filter results query

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

GET /sources/:source_id/reports/jobs/ingestion-metrics
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Interactive Jobs List

Auth
GET /sources/{source_id}/interactive-jobs
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Interactive Job by id

Auth
GET /sources/{source_id}/interactive-jobs/{interactive_job_id}
Responses
200

Ok.

objectobject
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update the job status for Interactive Job

Update the job status to failed for Interactive jobs

Auth
PATCH /sources/{source_id}/interactive-jobs/{interactive_job_id}
Responses
200

Success

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Download Logs for Interactive Job

Downloads the dataplane logs for the source interactive job.

Auth
GET /sources/{source_id}/interactive-jobs/{interactive_job_id}/logs/download
Responses
200

Ok.

filefile
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Gets Jobs Model for a Source.

Gets Jobs Model for a Source.

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /sources/{source_id}/jobs_for_source_job_type
Responses
200

Success

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultobject
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Gets List of Pipeline Jobs.

Gets List of Pipeline Jobs.

Auth
Query String
filterstring

Filter results query

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

GET /domains/{domain_id}/pipelines/{pipeline_id}/jobs
Responses
200

Success

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Submit Pipeline Job.

Submit Pipeline Job.

Auth
Request Body
objectobject
job_typestring

Enum: pipeline_build,pipeline_metadata

version_idstring

if not provided it will build pipeline with active version_id

updated_pipeline_parametersarray[object]
keystring
valuestring
POST /domains/{domain_id}/pipelines/{pipeline_id}/jobs
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Gets Pipeline Job.

Gets Pipeline Job.

Auth
GET /domains/{domain_id}/pipelines/{pipeline_id}/jobs/{job_id}
Responses
200

Success

objectobject
idstring
build_idinteger
namestring
statusstring

Enum: completed,pending,aborted,blocked,failed,running,canceled,succeeded

percentageinteger
typestring

Enum: source_test_connection,fetch_metadata,source_structured_fetch_metadata,source_crawl,source_crawl_chunk_load,source_cdc,source_unstructured_crawl,source_structured_crawl,source_semistructured_crawl,delete_entity,pipeline_metadata,pipeline_build,pipeline_build_restatement,full_load,cdc,source_merge,source_structured_cdc_merge,source_structured_cdc,source_cdc_merge,source_cdc_restatement,source_semistructured_cdc_merge,source_semistructured_cdc,metadata_cleanup_policy

entity_idstring
entity_typestring

Enum: source,pipeline,workflow

sub_entity_idstring
sub_entity_typestring
durationinteger

This is duration of the job.

cluster_idstring

Extenal clusterId

compute_idstring

Infoworks compute cluster id

compute_namestring

Infoworks compute name

created_atdate-time
created_bystring

UserId of user who triggered the job.

last_updatedstring
processed_atstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Submit Pipeline Job.

Submit Pipeline Job.

Auth
Request Body
objectobject
job_typestring

Enum: pipeline_build,pipeline_metadata

version_idstring

if not provided it will build pipeline with active version_id

updated_pipeline_parametersarray[object]
keystring
valuestring
POST /domains/{domain_id}/pipelines/{pipeline_id}/version/{pipeline_version_id}/jobs
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the jobs details

Get the jobs details (This operation is only for operations_analyst user)

Auth
Request Body
objectobject
date_range
objectobject
typestring
unitstring

Enum: day,hour

valueinteger
order_bystring

Enum: asc,desc

minLength: 1

Default: desc

sort_bystring

minLength: 1

offsetinteger

minimum: 0

limitinteger

minimum: -1

Default: 20

run_time_hourinteger

minimum: 0

Default: Infinity

domain_idsarray[string]
source_idsarray[string]
job_typesarray[string]

Enum: source_test_connection,fetch_metadata,source_structured_fetch_metadata,source_crawl,source_crawl_chunk_load,source_cdc,dictionary_crawl,source_unstructured_crawl,source_structured_crawl,source_semistructured_crawl,delete_entity,generate_sample,pipeline_metadata,pipeline_build,full_load,cdc,source_merge,source_structured_cdc_merge,source_structured_cdc,source_cdc_merge,source_cdc_restatement,source_semistructured_cdc_merge,source_semistructured_cdc,metadata_cleanup_policy,metadata_backup,export_data

entity_typestring

Enum: pipeline,source

minLength: 1

statusstring

Enum: pending,aborted,blocked,failed,running,canceled,completed,succeeded,toprocess,terminated

minLength: 1

additional_filtersobject
POST /prodops/jobs
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the job details with `job_id`

Get the job details with job_id (This operation is only for operations_analyst user)

Auth
GET /prodops/jobs/{job_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Cancel the job with `job_id`

Cancel the job with job_id (This operation is only for operations_analyst user)

Auth
GET /prodops/jobs/{job_id}/cancel
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Resubmit Failed tables for ingestion

Resubmit Failed tables for ingestion (This operation is only for operations_analyst user)

Auth
GET /prodops/jobs/{job_id}/resubmit
Responses
200

Success

objectobject
resultobject
statusstring
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Gets List of Pipeline Jobs.

Gets List of Pipeline Jobs.

Auth
Headers
Content-Typestring

Http content type

Enum: application/json,multipart/form-data,text/plain

Default: application/json

Path Params
domain_idstring
Query String
filterstring

Filter results query

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

GET /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/jobs
Responses
200

Success

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Submit Pipeline Job.

Submit Pipeline Job.

Auth
Request Body
objectobject
job_typestring

Enum: pipeline_group_build

POST /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/jobs
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Gets Pipeline Groups Job.

Gets Pipeline Groups Job.

Auth
GET /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/jobs/{job_id}
Responses
200

Success

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Gets Pipeline Groups Job.

Gets Pipeline Groups Job.

Auth
GET /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/jobs/{job_id}/pipeline-jobs
Responses
200

Success

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultobject
job_typestring

Enum: pipeline_group_build

400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Gets Pipeline Groups Job.

Gets Pipeline Groups Job.

Auth
GET /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/jobs/{job_id}/runs
Responses
200

Success

objectobject
idstring
build_idinteger
namestring
statusstring

Enum: completed,pending,aborted,blocked,failed,running,canceled,succeeded

percentageinteger
typestring

Enum: source_test_connection,fetch_metadata,source_structured_fetch_metadata,source_crawl,source_crawl_chunk_load,source_cdc,source_unstructured_crawl,source_structured_crawl,source_semistructured_crawl,delete_entity,pipeline_metadata,pipeline_build,pipeline_build_restatement,full_load,cdc,source_merge,source_structured_cdc_merge,source_structured_cdc,source_cdc_merge,source_cdc_restatement,source_semistructured_cdc_merge,source_semistructured_cdc,metadata_cleanup_policy

entity_idstring
entity_typestring

Enum: source,pipeline,workflow

sub_entity_idstring
sub_entity_typestring
durationinteger

This is duration of the job.

cluster_idstring

Extenal clusterId

compute_idstring

Infoworks compute cluster id

compute_namestring

Infoworks compute name

created_atdate-time
created_bystring

UserId of user who triggered the job.

last_updatedstring
processed_atstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the job log as text stream with `job_id`

Get the job log as text stream with job_id

Auth
GET /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/jobs/{job_id}/logs
Responses
200

Ok.

stringstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Download iw job logs zip for iw_job with job_id

Download iw job logs zip for iw_job with job_id

Auth
GET /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/jobs/{job_id}/logs/download
Responses
200

Ok.

filefile
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Job Hooks List

Get Job Hooks List

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/job-hooks
Responses
200

Ok.

objectobject
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Create a Job Hook

Create a Job Hook

Auth
Request Body
objectobject
namestring

pattern: ^[a-z0-9A-Z_-]+$

execution_typestring

Enum: BASH,PYTHON

executable_file_namestring
failJobIfHookFailsboolean
parametersstring
filesfile

Required files if upload_option is fileUpload

environment_variables_confarray[object]

Additional environment variables to pass in process

POST /admin/job-hooks
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Job Hook By Id

Get Job Hook By Id

Auth
GET /admin/job-hooks/{job_hook_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update Job Hook Type By Id

Update Job Hook Type By Id

Auth
Request Body
objectobject
namestring

pattern: ^[a-z0-9A-Z_-]+$

execution_typestring

Enum: BASH,PYTHON

executable_file_namestring
failJobIfHookFailsboolean
parametersstring
filesfile

Required files if upload_option is fileUpload

environment_variables_confarray[object]

Additional environment variables to pass in process

PATCH /admin/job-hooks/{job_hook_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete Job Hook By Id

Delete Job Hook By Id

Auth
DELETE /admin/job-hooks/{job_hook_id}
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get all files in Job Hook by id

Get all files in Job Hook by job_hook_id

Auth
GET /admin/job-hooks/{job_hook_id}/files
Responses
200

Ok.

objectobject
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

add file in Job Hook by id

add file in Job Hook by job_hook_id

Auth
Request Body
filefile
POST /admin/job-hooks/{job_hook_id}/files
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Global Audit Job Hooks List

Get Global Audit Job Hooks List

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/audit/job-hooks/global
Responses
200

Ok.

objectobject
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Audit Job Hooks List

Get Audit Job Hooks List

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/audit/job-hooks/{extension_id}
Responses
200

Ok.

objectobject
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Global Audit Pipeline Extension List

Get Global Audit Pipeline Extension List

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/audit/pipeline-extensions/global
Responses
200

Ok.

objectobject
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Audit Pipeline Extension List

Get Audit Pipeline Extension List

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/audit/pipeline-extensions/{extension_id}
Responses
200

Ok.

objectobject
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Global Audit Source Extension List

Get Global Audit Source Extension List

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/audit/source-extensions/global
Responses
200

Ok.

objectobject
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Audit Source Extension List

Get Audit Source Extension List

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/audit/source-extensions/{extension_id}
Responses
200

Ok.

objectobject
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Active License Violations

Get Active License Violations

Auth
GET /licenses/active/violations
Responses
200

ok

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Active License

Get Active License

Auth
GET /licenses/active
Responses
200

ok

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get All Licenses

Get All Licenses

Auth
GET /licenses
Responses
200

ok

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get all pipeline groups

Get all pipeline groups

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/pipeline-groups
Responses
200

Success

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray
idstring
namestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Create Pipeline Groups

Create Pipeline Groups

Auth
Headers
Content-Typestring

Http content type

Enum: application/json,multipart/form-data,text/plain

Default: application/json

Path Params
domain_idstring
Request Body
objectobject
namestring
descriptionstring
snowflake_profilestring
snowflake_warehousestring
data_environmentstring
compute_clusterstring
batch_enginestring
pipelines
objectobject
pipeline_idstring
run_active_versionboolean
execution_ordernumber
versionnumber
custom_tagsarray[string]
query_tags
objectobject
query_tag_idstring
POST /domains/{domain_id}/pipeline-groups
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get all pipeline groups for domain with `domain_id`

Get all pipeline groups for domain with domain_id

Auth
Path Params
domain_idstring
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

include_accessible_pipeline_groupsboolean

include pipeline groups from accessible domains to current domain as well

Default: false

GET /domains/{domain_id}/pipeline-groups
Responses
200

Success

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get pipeline group

Get pipeline group

Auth
Headers
Content-Typestring

Http content type

Enum: application/json,multipart/form-data,text/plain

Default: application/json

Path Params
domain_idstring
GET /domains/{domain_id}/pipeline-groups/{pipeline_group_id}
Responses
200

Ok.

objectobject
messagestring
result
objectobject
idstring
namestring
descriptionstring
snowflake_profilestring
snowflake_warehousestring
data_environmentstring
compute_clusterstring
batch_enginestring
pipelines
objectobject
pipeline_idstring
run_active_versionboolean
execution_ordernumber
versionnumber
custom_tagsarray[string]
query_tags
objectobject
query_tag_idstring
created_atstring
created_bystring
modified_atstring
modified_bystring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete Pipeline Group

Delete Pipeline Group

Auth
Headers
Content-Typestring

Http content type

Enum: application/json,multipart/form-data,text/plain

Default: application/json

Path Params
domain_idstring
DELETE /domains/{domain_id}/pipeline-groups/{pipeline_group_id}
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update Pipeline Group

Update Pipeline Group

Auth
Headers
Content-Typestring

Http content type

Enum: application/json,multipart/form-data,text/plain

Default: application/json

Path Params
domain_idstring
Request Body
objectobject
namestring
descriptionstring
snowflake_profilestring
snowflake_warehousestring
data_environmentstring
compute_clusterstring
batch_enginestring
pipelines
objectobject
pipeline_idstring
run_active_versionboolean
execution_ordernumber
versionnumber
custom_tagsarray[string]
query_tags
objectobject
query_tag_idstring
PATCH /domains/{domain_id}/pipeline-groups/{pipeline_group_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Accessible pipeline group

Get Accessible pipeline group

Auth
Headers
Content-Typestring

Http content type

Enum: application/json,multipart/form-data,text/plain

Default: application/json

Path Params
domain_idstring
GET /domains/{domain_id}/accessible-pipeline-groups
Responses
200

Ok.

objectobject
messagestring
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Gets List of Advance Config pipeline group.

Gets List of Advance Config pipeline group.

Auth
Query String
filterstring

Filter results query

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

GET /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/configurations/advance/
Responses
200

Success

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
resultsarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Advance Configuration Pipeline Group.

Advance Configuration Pipeline Group.

Auth
Request Body
objectobject
keystring
valuestring
descriptionstring
is_activeboolean
entity_idstring
entity_typestring
POST /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/configurations/advance/
Responses
200

Success

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Pipelinegroup advance configuration

Get Pipelinegroup advance configuration

Auth
GET /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/configurations/advance/{key}
Responses
200

Ok

objectobject
messagestring
keystring
valuestring
descriptionstring
isActiveboolean
entityIdstring
entityTypestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

update advance configuration for a pipeline group

update advance configuration for a pipeline group

Auth
Request Body

Table ingestion Configuration

arrayarray[object]
keystring
valuestring
entityIdstring
entityTypestring

Enum: table,pipeline

PUT /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/configurations/advance/{key}
Responses
200

OK

objectobject
resultobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete advance configuration for a pipeline group

Delete advance configuration for a pipeline group

Auth
DELETE /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/configurations/advance/{key}
Responses
200

OK

objectobject
resultobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

List service authentication mechanisms

Get a list of service authentication mechanisms

Auth
Query String
resolve_refboolean

Fetch username of user who created and last modified the resource

Default: null

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/manage-secrets/service-auth
Responses
200

List of service authentication mechanisms.

objectobject
messagestring
limitinteger
offsetinteger
linksobject
total_countinteger
result
objectobject
idstring
namestring
descriptionstring
service_typestring

Enum: azure

authentication_typestring

Enum: service_principal,managed_identity

entity_typestring

Enum: secret_store_authentication,authentication_service

authentication_propertiesobject
created_atstring
created_bystring
modified_atstring
modified_bystring
created_by_usernamestring

This field is returned only when resolve_ref is set to true

modified_by_usernamestring

This field is returned only when resolve_ref is set to true

400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Create a service authentication mechanism

Create a service authentication mechanism

Auth
Request Body
objectobject
namestring
descriptionstring
service_typestring

Enum: azure

authentication_typestring

Enum: service_principal,managed_identity

entity_typestring

Enum: secret_store_authentication,authentication_service

authentication_propertiesobject
POST /admin/manage-secrets/service-auth
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get service authentication mechanism

Get service authentication mechanism

Auth
Query String
resolve_refboolean

Fetch username of user who created and last modified the resource

Default: null

GET /admin/manage-secrets/service-auth/{service_auth_id}
Responses
200

Ok.

objectobject
messagestring
result
objectobject
idstring
namestring
descriptionstring
service_typestring

Enum: azure

authentication_typestring

Enum: service_principal,managed_identity

entity_typestring

Enum: secret_store_authentication,authentication_service

authentication_propertiesobject
created_atstring
created_bystring
modified_atstring
modified_bystring
created_by_usernamestring

This field is returned only when resolve_ref is set to true

modified_by_usernamestring

This field is returned only when resolve_ref is set to true

400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update service authentication mechanism

Update service authentication mechanism

Auth
Request Body
namestring
descriptionstring
service_typestring

Enum: azure

authentication_typestring

Enum: managed_identity,service_principal

entity_typestring

Enum: secret_store_authentication,authentication_service

authentication_propertiesobject
PATCH /admin/manage-secrets/service-auth/{service_auth_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete service authentication mechanism

Delete service authentication mechanism

Auth
DELETE /admin/manage-secrets/service-auth/{service_auth_id}
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

List secret stores

List secret stores

Auth
Query String
resolve_refboolean

Fetch username of user who created and last modified the resource

Default: null

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/manage-secrets/secret-store
Responses
200

Ok.

objectobject
messagestring
limitinteger
offsetinteger
linksobject
total_countinteger
result
objectobject
idstring
namestring
descriptionstring
service_typestring

Enum: azure

key_vault_uristring
service_authenticationstring
created_atstring
created_bystring
modified_atstring
modified_bystring
created_by_usernamestring

This field is returned only when resolve_ref is set to true

modified_by_usernamestring

This field is returned only when resolve_ref is set to true

400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Create secret store

Create secret store

Auth
Request Body
objectobject
namestring
descriptionstring
service_typestring

Enum: azure

key_vault_uristring
service_authenticationstring
POST /admin/manage-secrets/secret-store
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get secret store

Get secret store

Auth
Query String
resolve_refboolean

Fetch username of user who created and last modified the resource

Default: null

GET /admin/manage-secrets/secret-store/{secret_store_id}
Responses
200

Ok.

objectobject
messagestring
result
objectobject
idstring
namestring
descriptionstring
service_typestring

Enum: azure

key_vault_uristring
service_authenticationstring
created_atstring
created_bystring
modified_atstring
modified_bystring
created_by_usernamestring

This field is returned only when resolve_ref is set to true

modified_by_usernamestring

This field is returned only when resolve_ref is set to true

400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update secret store

Update secret store

Auth
Request Body
namestring
descriptionstring
service_typestring

Enum: azure

key_vault_uristring
service_authenticationstring
PATCH /admin/manage-secrets/secret-store/{secret_store_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete secret store

Delete secret store

Auth
DELETE /admin/manage-secrets/secret-store/{secret_store_id}
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

List secrets

Retrieves the list of secrets that are accessible to the user.

Auth
Query String
resolve_refboolean

Fetch username of user who created and last modified the resource

Default: null

fetch_allboolean

Use this parameter to retrieve the list of all secrets. (Only for admin user).

Default: null

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/manage-secrets/secrets
Responses
200

Ok.

objectobject
messagestring
limitinteger
offsetinteger
linksobject
total_countinteger
result
objectobject
idstring
namestring
descriptionstring
secret_storestring
secret_store_service_typestring

This field is returned only when resolve_ref is set to true

Enum: azure

domainsarray[string]

Ids of domains in which the secret is accessible.

secret_namestring
created_atstring
created_bystring
modified_atstring
modified_bystring
created_by_usernamestring

This field is returned only when resolve_ref is set to true

modified_by_usernamestring

This field is returned only when resolve_ref is set to true

400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Create secret

Create secret

Auth
Request Body
objectobject
namestring
descriptionstring
secret_storestring
domainsarray[string]

Ids of domains in which the secret is accessible.

secret_namestring
POST /admin/manage-secrets/secrets
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get secret

Get secret

Auth
Query String
resolve_refboolean

Fetch username of user who created and last modified the resource

Default: null

GET /admin/manage-secrets/secrets/{secret_id}
Responses
200

Ok.

objectobject
messagestring
result
objectobject
idstring
namestring
descriptionstring
secret_storestring
secret_store_service_typestring

This field is returned only when resolve_ref is set to true

Enum: azure

domainsarray[string]

Ids of domains in which the secret is accessible.

secret_namestring
created_atstring
created_bystring
modified_atstring
modified_bystring
created_by_usernamestring

This field is returned only when resolve_ref is set to true

modified_by_usernamestring

This field is returned only when resolve_ref is set to true

400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update secret

Update secret

Auth
Request Body
namestring
descriptionstring
secret_storestring
secret_namestring
domainsarray[string]

Ids of domains in which the secret is accessible.

PATCH /admin/manage-secrets/secrets/{secret_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete secret

Delete secret

Auth
DELETE /admin/manage-secrets/secrets/{secret_id}
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Event Notifications

Read Operation for event notifications

List event notifications

Get a list of event notification

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /event-notifications
Responses
200

List of event notifications.

objectobject
messagestring
limitinteger
offsetinteger
linksobject
total_countinteger
result
objectobject
idstring
eventobject
created_atstring
created_bystring
entities_affectedarray[string]
readboolean
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Engagement Metrics

Read Operation for engagement metrics

Aggregate details

Get Aggregate datails

Auth
Query String
interval_typestring

Default: null

durationstring

Default: null

timestampstring

Default: null

top_limitstring

Default: null

jobs_count_limitstring

Fetch username of user who created and last modified the resource

Default: null

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /engagement/data/aggregate
Responses
200

List of Data Aggregate.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

List Job status

Get Job status

Auth
Query String
interval_typestring

Default: null

durationstring

Default: null

timestampstring

Default: null

limitstring

Default: null

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /engagement/jobs/job-status
Responses
200

List of Job Status Response.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Data Catalog

Read Operation for Data Catalog

Data Model Details

Get Data Model details

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /data-catalog/data-models
Responses
200

List of Data Models.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Favorite Entity Details

Get Favorite Entity details

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /data-catalog/favorites
Responses
200

List of Favorite Entities.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

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

Auth
Path Params
pipeline_idstring
GET /pipeline-version-locks/pipelines/{pipeline_id}
Responses
200

Success

arrayarray[object]
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Jobflows

Operations to manage Jobflows

List Jobflows

Retrieves the list of all jobflows

Auth
Query String
limitinteger

The numbers of items to return

Default: 10

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/jobflows
Responses
200

Success

objectobject
messagestring
limitinteger
offsetinteger
linksobject
total_countinteger
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Jobflow

Retrieves the jobflow details

Auth
GET /admin/jobflows/{jobflow_id_or_name}
Responses
200

Ok.

objectobject
messagestring
result
objectobject
idstring
namestring
custom_tagsarray
descriptionstring
created_atdate-time
created_bystring
modified_atdate-time
jobflow_graphobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Persistent Cluster Status

Get Persistent Cluster Status

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/environment/cluster/compute-template/{compute_template_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Environment Status

Get Environment Status

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/environment/cluster/{environment_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Stop the persistent cluster

Stop the persistent cluster

Auth
Request Body
objectobject
compute_template_idstring
POST /admin/environment/cluster/service/stop
Responses
200

Ok.

objectobject
messagestring
resultobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Terminate the persistent cluster

Terminate the persistent cluster

Auth
Request Body
objectobject
compute_template_idstring
PUT /admin/environment/cluster/terminate-async
Responses
200

Ok.

objectobject
messagestring
resultobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Restart the cluster

Restart the cluster

Auth
Request Body
objectobject
compute_template_idstring
typestring
PUT /admin/environment/cluster/restart
Responses
200

Ok.

objectobject
messagestring
resultobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Stop the cluster

Stop the cluster

Auth
Request Body
objectobject
compute_template_idstring
typestring
PUT /admin/environment/cluster/stop
Responses
200

Ok.

objectobject
messagestring
resultobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Create the cluster

Create the cluster

Auth
Request Body
objectobject
compute_template_idstring
typestring
POST /admin/environment/cluster/
Responses
200

Ok.

objectobject
messagestring
resultobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get daily billing metering data

Get daily billing metering data

Auth
Query String
start-datenumber

Starting Date - timestamp

end-datenumber

Ending Date - timestamp

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

GET /billing/daily-metering-data
Responses
200

Success

objectobject
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get billing information

Get billing information

Auth
Query String
start-datenumber

Starting Date - timestamp

end-datenumber

Ending Date - timestamp

GET /billing/billing-information
Responses
200

Success

objectobject
messagestring
result
objectobject
idstring
jobs_countinteger
total_time_countinteger
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get snowflake daily billing metering data

Get snowflake daily billing metering data

Auth
Query String
start-datenumber

Starting Date - timestamp

end-datenumber

Ending Date - timestamp

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

GET /billing/snowflake-daily-metering-data
Responses
200

Success

objectobject
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get snowflake billing information

Get snowflake billing information

Auth
Query String
start-datenumber

Starting Date - timestamp

end-datenumber

Ending Date - timestamp

GET /billing/snowflake-billing-information
Responses
200

Success

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get metrics configuration

Get metrics configuration

Auth
GET /billing/metrics-config
Responses
200

Success

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Submit a request for refreshing billing details

Submit a request for refreshing billing details

Auth
POST /billing/refresh-billing-details
Responses
200

Success

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get a particular entity schedule details

Get a particular entity schedule details

Auth
Query String
entity_idstring

Entity ID

entity_typestring

Entity Type

Enum: workflow,metadata_cleanup_policy,system_config,table_group,table

GET /schedules/entity-schedule
Responses
200

Success

objectobject
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Used to check whether scheduler service is working or not

Used to check whether scheduler service is working or not

Auth
GET /schedules/check-service
Responses
200

Success

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Used to save a particular entity schedule detailsDeprecated

Used to save a particular entity schedule details

Auth
Query String
entity_idstring

Entity ID

entity_typestring

Entity Type

Enum: workflow,metadata_cleanup_policy,system_config,table_group,table

Request Body
objectobject
entity_idstring
schedule_typestring

Enum: workflow-build,metadata_cleanup,mongo-backup,table-group-cdc,table

schedule_usernamestring
PUT /save-entity-schedule
Responses
200

Success

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Used to save a particular entity schedule user detailsDeprecated

Used to save a particular entity schedule user details

Auth
Query String
entity_idstring

Entity ID

entity_typestring

Entity Type

Enum: workflow,metadata_cleanup_policy,system_config,table_group,table

Request Body
objectobject
scheduler_usernamestring
scheduler_auth_tokenstring
PUT /save-entity-user
Responses
200

Success

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Used to save a particular entity schedule and its user details

Used to save a particular entity schedule and its user details

Auth
Query String
entity_idstring

Entity ID

entity_typestring

Entity Type

Enum: workflow,metadata_cleanup_policy,system_config,table_group,table

Request Body
objectobject
scheduler_usernamestring
scheduler_auth_tokenstring
schedule
Generic Scheduleobject

Generic schedule object

schedule_statusstring

Enum: enabled,disabled

start_datestring

Start time should be after current time.

pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$

start_hourinteger

maximum: 23

minimum: 0

start_mininteger

maximum: 59

minimum: 0

repeat_interval_unitstring

Enum: NEVER,MINUTE,HOUR,DAY,WEEK,MONTH

Default: NEVER

repeat_interval_measureinteger

minimum: 1

repeat_on_last_dayboolean

specified_days must be provided if repeat_on_last_day is false. Applicable for repeat_interval_unit=MONTH

Default: false

specified_daysarray[integer]

Applicable when repeat_interval_unit is WEEK or MONTH.

minLength: 1

endsboolean

end_date, end_hour, end_min must be provided if ends is true.

Default: false

end_datestring

End time should be after start time.

pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$

end_hourinteger

maximum: 23

minimum: 0

end_mininteger

maximum: 59

minimum: 0

is_custom_jobboolean

custom_job_details must be provided when is_custom_job=true. Applicable when repeat_interval_unit is DAY, WEEK or MONTH.

Default: false

custom_job_detailsobject
PUT /save-entity-user-and-schedule
Responses
200

Success

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Use to validate entity names

Use to validate entity names

Auth
Query String
target_typestring

Specify Target Type

entity_namesstring

Entity names object should be passed as JSON string

GET /validate-entity-names
Responses
200

Ok.

objectobject
messagestring
Response

Used to verify users refresh token

Used to verify users refresh token

Auth
Request Body
objectobject
scheduler_usernamestring
scheduler_auth_tokenstring
PUT /verify-refresh-token
Responses
200

Ok

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Exports the source configuration

Exports the source configuration to JSON format.

Auth
GET /sources/{source_id}/config-migration
Responses
200

Ok.

objectobject
resultobject
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Imports the source configuration

Imports the source configuration from JSON format.

Auth
Request Body
objectobject
dry_runboolean
run_pipeline_metadata_buildboolean
is_pipeline_version_activeboolean
include_optional_propertiesboolean
import_data_connectionboolean
configurationobject
POST /sources/{source_id}/config-migration
Responses
200

Ok.

objectobject
resultarray
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Upload config migration json file

Upload config migration json file

Auth
Query String
entity_typestring

Enum: source,workflow,pipeline

entity_idstring
Request Body
filefile
PUT /config-migration-file-upload
Responses
200

Success

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Getting Server Timezone

Use to get server timezone

Use to get server timezone

Auth
GET /server-timezone
Responses
200

Ok.

objectobject
messagestring
resultstring
Response

Get the Target Data Connections

Get the Target Data Connections

Auth
Query String
filterstring

Filter results query

limitinteger

The numbers of items to return

Default: 10

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

sort_bystring

Sort result on field

GET /admin/data-connections
Responses
200

Ok

objectobject
messagestring
limitinteger
offsetinteger
linksobject
total_countinteger
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Create Target Data Connections

Create Target Data Connections to use in pipeline or sources

Auth
Request Body
typestring
namestring
connection_urlstring
account_namestring
usernamestring
passwordstring
warehousestring
additional_paramsstring
POST /admin/data-connections
Responses
200

Ok

objectobject
messagestring
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the Data Connections for each subtype

Get the Data Connections for each subtype

Auth
Query String
environment_platformstring

Specify environment platform

GET /data-connections-subtypes
Responses
200

Ok

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Add Custom tags

Custom tags

Auth
Request Body
objectobject
keystring
valuestring
descriptionstring
POST /admin/custom-tags
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get List of Custom Tags

Get List of Custom Tags

Auth
Query String
filterstring

Filter results query

limitinteger

The numbers of items to return

Default: 10

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

sort_bystring

Sort result on field

GET /admin/custom-tags
Responses
200

Ok

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get custom tags

Get custom tags

Auth
GET /admin/custom-tags/{custom_tag_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update Custom tags

Custom tags

Auth
Request Body
objectobject
valuestring
descriptionstring
PATCH /admin/custom-tags/{custom_tag_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update Custom tags

Custom tags

Auth
DELETE /admin/custom-tags/{custom_tag_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

List presets

Get a list of presets of a particular type for a user

Auth
Query String
typestring

Type of presets to fetch for the user

Enum: prodops_filter

offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /users/self/presets
Responses
200

List of presets.

objectobject
messagestring
limitinteger
offsetinteger
linksobject
total_countinteger
result
objectobject
idstring
user_idstring
namestring
typestring
configurationobject
is_defaultboolean
created_atdate-time
modified_atdate-time
usernamestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Create a preset

Creates a user-defined preset

Auth
Request Body
objectobject
namestring
typestring
configurationobject
is_defaultboolean
POST /users/self/presets
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get preset

Get preset details

Auth
GET /users/self/presets/{preset_id}
Responses
200

Ok.

objectobject
messagestring
result
objectobject
idstring
user_idstring
namestring
typestring
configurationobject
is_defaultboolean
created_atdate-time
modified_atdate-time
usernamestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update preset

Update preset

Auth
Request Body
objectobject
namestring
typestring
configurationobject
is_defaultboolean
PATCH /users/self/presets/{preset_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete preset

Delete preset

Auth
DELETE /users/self/presets/{preset_id}
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get all General Configurations for Infoworks.

Get all General Configurations for Infoworks.

Auth
GET /admin/configuration/general
Responses
200

ok.

objectobject
messagestring
resultobject
valuestring
descriptionstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Replace General Configurations for Infoworks.

Replace General Configurations for Infoworks.

Auth
Request Body
objectobject
valuestring
descriptionstring
PUT /admin/configuration/general
Responses
200

ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Gets `Mongo Backups` list.

Gets Mongo Backups list.

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/mongo-backup
Responses
200

Success

objectobject
messagestring
limitinteger
offsetinteger
linksobject
total_countinteger
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Gets Mongo Backup With Specified Id.

Gets Mongo Backup With Specified Id.

Auth
Path Params
mongo_backup_idstring
GET /admin/mongo-backup/{mongo_backup_id}
Responses
200

Success

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Start Mongo Backup

Start Mongo Backup.

Auth
POST /admin/mongo-backup/run
Responses
200

Success

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the Schedule of the Mongo Backup.

Get the Schedule of the Mongo Backup.

Auth
GET /admin/mongo-backup/schedule
Responses
200

Ok.

resultobject
schedule_typestring
schedule_details
Generic Scheduleobject

Generic schedule object

schedule_statusstring

Enum: enabled,disabled

start_datestring

Start time should be after current time.

pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$

start_hourinteger

maximum: 23

minimum: 0

start_mininteger

maximum: 59

minimum: 0

repeat_interval_unitstring

Enum: NEVER,MINUTE,HOUR,DAY,WEEK,MONTH

Default: NEVER

repeat_interval_measureinteger

minimum: 1

repeat_on_last_dayboolean

specified_days must be provided if repeat_on_last_day is false. Applicable for repeat_interval_unit=MONTH

Default: false

specified_daysarray[integer]

Applicable when repeat_interval_unit is WEEK or MONTH.

minLength: 1

endsboolean

end_date, end_hour, end_min must be provided if ends is true.

Default: false

end_datestring

End time should be after start time.

pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$

end_hourinteger

maximum: 23

minimum: 0

end_mininteger

maximum: 59

minimum: 0

is_custom_jobboolean

custom_job_details must be provided when is_custom_job=true. Applicable when repeat_interval_unit is DAY, WEEK or MONTH.

Default: false

custom_job_detailsobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Schedule Mongo Backup.

Schedule Mongo Backup.

Auth
Request Body
Generic Scheduleobject

Generic schedule object

schedule_statusstring

Enum: enabled,disabled

start_datestring

Start time should be after current time.

pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$

start_hourinteger

maximum: 23

minimum: 0

start_mininteger

maximum: 59

minimum: 0

repeat_interval_unitstring

Enum: NEVER,MINUTE,HOUR,DAY,WEEK,MONTH

Default: NEVER

repeat_interval_measureinteger

minimum: 1

repeat_on_last_dayboolean

specified_days must be provided if repeat_on_last_day is false. Applicable for repeat_interval_unit=MONTH

Default: false

specified_daysarray[integer]

Applicable when repeat_interval_unit is WEEK or MONTH.

minLength: 1

endsboolean

end_date, end_hour, end_min must be provided if ends is true.

Default: false

end_datestring

End time should be after start time.

pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$

end_hourinteger

maximum: 23

minimum: 0

end_mininteger

maximum: 59

minimum: 0

is_custom_jobboolean

custom_job_details must be provided when is_custom_job=true. Applicable when repeat_interval_unit is DAY, WEEK or MONTH.

Default: false

custom_job_detailsobject
PUT /admin/mongo-backup/schedule/enable
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Schedule Mongo Backup.

Schedule Mongo Backup.

Auth
PUT /admin/mongo-backup/schedule/disable
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the type of the Authentication and associated properties.

Get the type of the Authentication and associated properties.

Auth
GET /admin/configuration/authentication
Responses
200

ok.

objectobject
messagestring
resultarray
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Change the Authentication Mechanism

Change the Authentication Mechanism

Auth
Request Body
objectobject
is_activeboolean
authentication_typestring

Enum: mongo

PUT /admin/configuration/authentication
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Change the Authentication Mechanism

Change the Authentication Mechanism

Auth
Request Body
objectobject
is_activeboolean
authentication_typestring

Enum: mongo

PATCH /admin/configuration/authentication
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Test the Authentication Mechanism's Connection.

Test the Authentication Mechanism's Connection.

Auth
POST /admin/configuration/authentication/test-connection
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Test the Authentication Connection for LDAP user.

Test the Authentication Connection for LDAP user.

Auth
Request Body
objectobject
hoststring
portstring
is_sslboolean
test_bind_dnstring
test_bind_passwordstring
POST /admin/configuration/authentication/test-ldap-connection
Responses
200

Ok.

objectobject
messagestring
resultobject
statusstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

General Configs

Get general configuration with key

Get general configuration with key

Auth
Request Body
objectobject
config_typestring
componentstring
configuration_keysarray[string]
POST /admin/configuration
Responses
200

Ok.

objectobject
messagestring
resultobject
key_1string
key_2string
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get metadata cleanup policies.

Get metadata cleanup policies.

Auth
GET /admin/metadata-cleanup/policies
Responses
200

Ok.

objectobject
messagestring
result
actionstring

Enum: archive,delete,disabled

retention_period_in_daysinteger
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Jobs cleanup policy.

Get Jobs cleanup policy.

Auth
GET /admin/metadata-cleanup/policies/jobs
Responses
200

Ok.

objectobject
messagestring
actionstring

Enum: archive,delete,disabled

retention_period_in_daysinteger
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Edit the Jobs Cleanup Policy

Edit the Jobs Cleanup Policy

Auth
Request Body
actionstring

Enum: archive,delete,disabled

retention_period_in_daysinteger
collection_group_namestring
PUT /admin/metadata-cleanup/policies/jobs
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Audits cleanup policy.

Get Audits cleanup policy.

Auth
GET /admin/metadata-cleanup/policies/audits
Responses
200

Ok.

objectobject
messagestring
actionstring

Enum: archive,delete,disabled

retention_period_in_daysinteger
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Edit the Audits Cleanup Policy

Edit the Audits Cleanup Policy

Auth
Request Body
actionstring

Enum: archive,delete,disabled

retention_period_in_daysinteger
collection_group_namestring
PUT /admin/metadata-cleanup/policies/audits
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Metrics cleanup policy.

Get Metrics cleanup policy.

Auth
GET /admin/metadata-cleanup/policies/metrics
Responses
200

Ok.

objectobject
messagestring
actionstring

Enum: archive,delete,disabled

retention_period_in_daysinteger
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Edit the Metrics Cleanup Policy

Edit the Metrics Cleanup Policy

Auth
Request Body
actionstring

Enum: archive,delete,disabled

retention_period_in_daysinteger
collection_group_namestring
PUT /admin/metadata-cleanup/policies/metrics
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Schedule of cleanup policy.

Get Schedule of cleanup policy.

Auth
GET /admin/metadata-cleanup/schedule
Responses
200

Ok.

schedule_usernamestring
schedule_typestring

Enum: metadata_cleanup

400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Edit Schedule of cleanup policy.

Edit Schedule of cleanup policy.

Auth
Request Body
Generic Scheduleobject

Generic schedule object

schedule_statusstring

Enum: enabled,disabled

start_datestring

Start time should be after current time.

pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$

start_hourinteger

maximum: 23

minimum: 0

start_mininteger

maximum: 59

minimum: 0

repeat_interval_unitstring

Enum: NEVER,MINUTE,HOUR,DAY,WEEK,MONTH

Default: NEVER

repeat_interval_measureinteger

minimum: 1

repeat_on_last_dayboolean

specified_days must be provided if repeat_on_last_day is false. Applicable for repeat_interval_unit=MONTH

Default: false

specified_daysarray[integer]

Applicable when repeat_interval_unit is WEEK or MONTH.

minLength: 1

endsboolean

end_date, end_hour, end_min must be provided if ends is true.

Default: false

end_datestring

End time should be after start time.

pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$

end_hourinteger

maximum: 23

minimum: 0

end_mininteger

maximum: 59

minimum: 0

is_custom_jobboolean

custom_job_details must be provided when is_custom_job=true. Applicable when repeat_interval_unit is DAY, WEEK or MONTH.

Default: false

custom_job_detailsobject
PUT /admin/metadata-cleanup/schedule/enable
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Edit Schedule of cleanup policy.

Edit Schedule of cleanup policy.

Auth
PUT /admin/metadata-cleanup/schedule/disable
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

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.

Auth
PUT /admin/metadata-cleanup/schedule/user
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Pause Multiple Workflows

Pause Multiple Workflows

Auth
Request Body
objectobject
workflowsarray[object]

List of workflows and their versions to pause or resume.

workflow_idstring
workflow_version_idstring
POST /admin/workflows/pause
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Resume Multiple Workflows

Resume Multiple Workflows

Auth
Request Body
objectobject
workflowsarray[object]

List of workflows and their versions to pause or resume.

workflow_idstring
workflow_version_idstring
POST /admin/workflows/resume
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Restart Multiple Workflows

Restart Multiple Workflows

Auth
Request Body
objectobject
idsarray[object]
POST /admin/workflows/restart
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Cancel Multiple Workflows

Cancel Multiple Workflows

Auth
Request Body
objectobject
idsarray[object]
POST /admin/workflows/cancel
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Retrieves the status of workflow

Retrieves the status of workflows for the Admin user.

Auth
GET /admin/workflows
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Gets workflow versions

Retrieves the list of workflow versions for the Admin user.

Auth
GET /admin/workflow-versions
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray[object]

List of workflow version objects.

400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Workflows

Get Workflows runs

Auth
GET /admin/workflows/runs
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Workflows tasks

Get Workflows tasks

Auth
GET /admin/workflows/tasks
Responses
200

Ok.

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Workflow run Id details

Get Workflow run Id details

Auth
GET /admin/workflows/{workflow_id}/runs/{run_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the Ingestion-metrics of the table with job_id

Get the Ingestion-metrics of the table with job_id

Auth
GET /admin/jobs/{job_id}/reports/ingestion-metrics
Responses
200

OK

objectobject
resultarray[object]
limitinteger
offsetinteger
linksobject
total_countinteger
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the Export-metrics of the table with job_id

Get the Export-metrics of the table with job_id

Auth
GET /admin/jobs/{job_id}/reports/export-metrics
Responses
200

OK

objectobject
resultarray[object]
limitinteger
offsetinteger
linksobject
total_countinteger
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the Pipeline-metrics of the table with job_id

Get the Pipeline-metrics of the table with job_id

Auth
GET /admin/jobs/{job_id}/reports/pipeline-metrics
Responses
200

OK

objectobject
resultarray[object]
limitinteger
offsetinteger
linksobject
total_countinteger
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Job Status Metrics

Get Job Status Metrics

Auth
Query String
created_at_windowinteger

Job run in last some hours.

Default: 24

countinteger

Number of last jobs to make a query to return.

Default: 50

statusstring

Comma-separated list of job statuses to filter by.

Enum: running,blocked,pending,completed,failed,canceled

GET /admin/job-status-metrics
Responses
200

Successful response with job status metrics.

objectobject
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Ingestion Metrics with job id.

Get Ingestion Metrics with job id.

Auth
GET /sources/{source_id}/jobs/{job_id}/reports/ingestion-metrics
Responses
200

Success

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray[object]
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get job metrics with job id.

Get job metrics with job id.

Auth
GET /sources/{source_id}/jobs/{job_id}/reports/job-metrics
Responses
200

Success

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray[object]
Response

Get Export Metrics with job id.

Get Export Metrics with job id.

Auth
GET /sources/{source_id}/jobs/{job_id}/reports/export-metrics
Responses
200

Success

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray[object]
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get Metrics for all tables in the source.

Get Metrics for all tables in the source.

Auth
GET /sources/{source_id}/reports/table-metrics
Responses
200

Success

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray[object]
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get the Export-metrics of the table with job id

Get the Export-metrics of the table with job id

Auth
GET /sources/{source_id}/tables/{table_id}/jobs/{job_id}/reports/export-metrics
Responses
200

OK

objectobject
resultarray[object]
limitinteger
offsetinteger
linksobject
total_countinteger
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get the ingestion-metrics of the table with job id

Get the ingestion-metrics of the table with job id

Auth
GET /sources/{source_id}/tables/{table_id}/jobs/{job_id}/reports/ingestion-metrics
Responses
200

OK

objectobject
resultarray[object]
limitinteger
offsetinteger
linksobject
total_countinteger
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get the ingestion-metrics for the table

Get the ingestion-metrics for the table

Auth
GET /sources/{source_id}/tables/{table_id}/reports/ingestion-metrics
Responses
200

OK

objectobject
resultarray[object]
limitinteger
offsetinteger
linksobject
total_countinteger
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Download ingestion metrics for the table

Download ingestion metrics for the table

Auth
GET /sources/{source_id}/tables/{table_id}/reports/ingestion-metrics/download
Responses
200

Ok.

filefile
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Download List of All jobs of this Source and it's artifacts.

Download List of All jobs of this Source and it's artifacts.

Auth
GET /sources/:source_id/reports/jobs/ingestion-metrics/download
Responses
200

Ok.

filefile
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get the export-metrics for the table

Get the export-metrics for the table

Auth
GET /sources/{source_id}/tables/{table_id}/reports/export-metrics
Responses
200

OK

objectobject
resultarray[object]
limitinteger
offsetinteger
linksobject
total_countinteger
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Fetch the metrics for a given time period

Fetch the metrics for a given time period

Auth
Request Body
objectobject
date_rangeobject
POST /prodops/metrics
Responses
200

Ok.

workflowobject
pipelineobject
onboardingobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get All Currently Locked Entities.

Get All Currently Locked Entities.

Auth
GET /admin/locked-entities
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Unlock Currently Locked Entities.

Unlocks all Currently Locked Entities.

Auth
POST /admin/unlock-entities
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get a specific currently Locked Entity.

Get a specific currently Locked Entity.

Auth
GET /admin/locked-entities/{entity_id}
Responses
200

Ok.

objectobject
messagestring
entity_statestring
entity_typestring
entity_namestring
entity_idstring
job_idstring
job_typestring
job_statusstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Unlock a Currently Locked Entity.

Unlock a Currently Locked Entity.

Auth
POST /admin/unlock-entities/{entity_id}
Responses
200

Ok.

objectobject
messagestring
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get a specific currently Locked Entity.

Get a specific currently Locked Entity for Prodops user.

Auth
GET /prodops/locked-entities/{locked_entity_id}
Responses
200

Ok.

objectobject
messagestring
entity_statestring
entity_typestring
entity_namestring
entity_idstring
job_idstring
job_typestring
job_statusstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get All Currently Locked Entities.

Get All Currently Locked Entities.

Auth
GET /prodops/locked-entities
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Unlock Currently Locked Entities.

Unlocks all Currently Locked Entities.

Auth
POST /prodops/unlock-entities
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get a list of subscribers.

Get a list of subscribers.

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/subscribers
Responses
200

Ok

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Create a new subscriber.

Create a new subscriber.

Auth
Request Body
profileobject
namestring
emailstring
POST /admin/subscribers
Responses
200

Ok

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get a subscriber.

Get a subscriber.

Auth
GET /admin/subscribers/{subscriber_id}
Responses
200

Ok

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update a subscriber.

Update a subscriber.

Auth
Request Body
profileobject
namestring
emailstring
PUT /admin/subscribers/{subscriber_id}
Responses
200

Ok

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete a subscriber.

Delete a subscriber.

Auth
DELETE /admin/subscribers/{subscriber_id}
Responses
200

Ok

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get a Subscription List for a subscriber.

Get a Subscription List for a subscriber.

Auth
GET /admin/subscriptions/{subscriber_id}
Responses
200

Ok

objectobject
messagestring
entity_idstring
entity_namestring
entity_typestring
notify_eventsarray[object]
event_job_typestring
notify_onarray[string]
notify_viaarray[string]
updated_atstring
updated_bystring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete all the subscription for a subscriber.

Delete all the subscription for a subscriber.

Auth
DELETE /admin/subscriptions/{subscriber_id}
Responses
200

Ok

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get a list of all external and internal users.

Get a list of all external and internal users.

Auth
GET /admin/allUsers
Responses
200

Ok

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Backup configs for metadata backup job

Get Backup configs for metadata backup job

Auth
GET /admin/mongo-backup/configuration
Responses
200

Ok.

objectobject
messagestring
result
objectobject
backup_typestring

Enum: local

target_pathstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Add Backup configs for metadata backup job

Add Backup configs for metadata backup job

Auth
Request Body
objectobject
backup_typestring

Enum: local

target_pathstring
POST /admin/mongo-backup/configuration
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the self details

Get the self details

Auth
GET /admin/self
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the self details

Get the self details

Auth
GET /users/self
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Admin Schedules

Get details of all running schedules.

Get details of all running schedules.

Auth
GET /admin/schedules
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get the Custom Audit Column

Get the Custom Audit Column

Auth
GET /admin/custom-audit-columns/{custom_audit_column_id}
Responses
200

Ok

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Patch the Custom Audit Column

Patch the Custom Audit Column

Auth
Request Body
objectobject
column_namestring
descriptionstring
entity_typestring
functionstring
PATCH /admin/custom-audit-columns/{custom_audit_column_id}
Responses
200

Ok

objectobject
messagestring
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete the Custom Audit Column

Delete the Custom Audit Column

Auth
DELETE /admin/custom-audit-columns/{custom_audit_column_id}
Responses
200

Ok

objectobject
messagestring
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Custom Audit Columns

Get Custom Audit Columns

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/custom-audit-columns
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Create Custom Audit Column

Create Custom Audit Column

Auth
Request Body
objectobject
column_namestring
descriptionstring
entity_typestring
functionstring
POST /admin/custom-audit-columns
Responses
200

Ok.

objectobject
messagestring
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Custom Audit Column Audits

Get Custom Audit Columns Audits

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /admin/custom-audit-column/audits
Responses
200

Ok.

objectobject
messagestring
limitinteger
offsetinteger
linksobject
total_countinteger
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Clear Cache

To clear Admin cache

To clear Admin cache

Auth
Request Body
objectobject
emailstring
POST /admin/clear-cache
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Stops the streaming jobs for tables listed in request.

Stops the streaming jobs for tables listed in request.

Auth
Request Body
StopStreamingJobRequestSchemaobject
table_idsarray[string]

Table ids for which streaming needs to be stopped

POST /sources/{source_id}/stop-streaming
Responses
200

Success

objectobject
messagestring
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Check if schema is unique

Check if schema is unique

Auth
Request Body

Source configurations

objectobject
schemastring
POST /schema/exists
Responses
200

successful operation

objectobject
resultobject
existsboolean
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Check if path is unique

Check if path is unique

Auth
Request Body

Source configurations

objectobject
pathstring
storage_typestring
POST /path/exists
Responses
200

successful operation

objectobject
resultobject
existsboolean
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get the audit logs of the source

Get the audit logs of the source

Auth
GET /sources/{source_id}/audit-logs
Responses
200

OK

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get the audit logs of the table

Get the audit logs of the table

Auth
GET /sources/{source_id}/tables/{table_id}/audit-logs
Responses
200

OK

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Check entity favorite tag

Check entity favorite tag

Auth
Query String
entity_idstring

Entity ID

entity_typestring

Entity Type

GET /sources/favorites/check-favorite
Responses
200

Ok

objectobject
messagestring
is_favoriteboolean
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Toggle entity favorite tag

Toggle entity favorite tag

Auth
Query String
entity_idstring

Entity ID

entity_typestring

Entity Type

PATCH /sources/favorites/toggle-favorite
Responses
200

Ok

objectobject
messagestring
400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Get a list of subscribers.

Get a list of subscribers.

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /subscribers
Responses
200

Ok

objectobject
messagestring
limitinteger
offsetinteger
linksobject
total_countinteger
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get a subscriber.

Get a subscriber.

Auth
GET /subscribers/{subscriber_id}
Responses
200

Ok

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Service Authentication Cache

Clear cache for service authentication or secret

Clear cache in infoworks services for authentication or secrets value.

Auth
Query String
secret_idstring

Optional secret id to clear cache, clear all if not passed

Default: null

DELETE /admin/manage-secrets/cache
Responses
200

Success.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

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

Auth
Path Params
pipeline_idstring
pipeline_version_idstring

pipeline_version_id as HEX string

GET /pipeline-version-locks/pipelines/{pipeline_id}/pipeline-version/{pipeline_version_id}
Responses
200

Success

objectobject
limitinteger
offsetinteger
linksobject
total_countinteger
messagestring
resultarray[object]
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

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

Auth
Path Params
pipeline_idstring
pipeline_version_idstring

pipeline_version_id as HEX string

Request Body

Pipeline version lock configuration

objectobject
version_namestring
PUT /pipeline-version-locks/pipelines/{pipeline_id}/pipeline-version/{pipeline_version_id}
Responses
200

Ok.

objectobject
messagestring
resultobject
idstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Delete pipeline version lock for pipeline_id, pipeline_version_id

Delete pipeline version lock pipeline_id, pipeline_version_id

Auth
Path Params
pipeline_idstring
pipeline_version_idstring

pipeline_version_id as HEX string

DELETE /pipeline-version-locks/pipelines/{pipeline_id}/pipeline-version/{pipeline_version_id}
Responses
200

Ok.

objectobject
messagestring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

get pipeline version lock status for pipeline_id, pipeline_version_id

get pipeline version lock status for pipeline_id, pipeline_version_id

Auth
Path Params
pipeline_idstring
pipeline_version_idstring

pipeline_version_id as HEX string

GET /pipeline-version-locks/pipelines/{pipeline_id}/pipeline-version/{pipeline_version_id}/is-locked
Responses
200

Success

objectobject
resultobject
version_lockedboolean
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get workflow run metering variables

Get workflow run metering variables

Auth
GET /billing/workflow-run-metering-variables/{workflow_run_id}
Responses
200

Success

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Server Time

Get Server Timezone Offset

Auth
GET /server-time
Responses
200

Ok.

objectobject
current_datestring
timezone_offsetnumber
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

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)

Auth
GET /general-configs
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get connection parameters for generic jdbc sources

Get connection parameters for generic jdbc sources

Auth
Query String
source_typestring

Source Type name

source_sub_typestring

Source Sub Type name

driver_namestring

Driver name

GET /get-cdata-connectors
Responses
200

Ok.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Get Entity Subscriber

Get Entity Subscriber

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

GET /notification/{entity_type}/{entity_id}/subscribers
Responses
200

List of User Notification Subscribe.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Update Entity Subscriber

Update Entity Subscriber

Auth
Request Body
objectobject
entity_idstring
entity_typestring
usersarray[object]
POST /notification/{entity_type}/{entity_id}/subscribers
Responses
200

List of User Notification Subscribe.

objectobject
messagestring
resultobject
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Subscribe Notification

Subscribe Notification

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

Request Body
objectobject
entity_idstring
entity_typestring
usersarray[object]
POST /notification/subscribe
Responses
200

List of User Aggregate.

objectobject
messagestring
resultobject
statusnumber
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response

Unsubscribe Notification

Unsubscribe Notification

Auth
Query String
offsetinteger

The number of items to skip before starting to collect the result set

Default: 0

limitinteger

The numbers of items to return

Default: 10

sort_bystring

Sort result on field

order_bystring

order ascending | descending

Enum: asc,desc

Default: asc

filterstring

Filter results query

Request Body
objectobject
entity_idstring
entity_typestring
userobject
idstring
typestring
PUT /notification/unsubscribe
Responses
200

List of Job Status Response.

objectobject
messagestring
resultobject
statusnumber
resultstring
400

Request has invalid body or parameters.

401

Authentication Failed. Please check your Credentials

403

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response