Documentation for Versions 2.x, 3.1.
Infoworks Rest API V3
Authentication
Security
GETGet `authentication_token` with `username` and `password`.
GETGet `authentication_token` with `refresh_token`.
DELETEPurge authentication token
GETValidate `authentication_token` if its active or not.
DELETERegenerate Refresh Token and blacklist old token.
POSTAuthorise User.
GETGet SAML Redirect URL.
POSTLDAP Authorise User.
POSTbulk sync (add/update) ldap user by providing login attribute
Users
GETGet the User details
POSTCreate a new User
GETGet the details of the user linked with the user_id
DELETEDelete a user.
PATCHUpdate the User
PATCHReset password for user
DELETEDelete all schedules for a specific user
PATCHToggle user login ability
POSTAdd the domain to the user linked with the user_id
GETGet the User details
POSTCreate a new User
GETGet the details of the user linked with the user_id
DELETEDelete a user.
PATCHUpdate the User
PATCHReset password for user
DELETEDelete all schedules for a specific user
PATCHToggle user login ability
POSTAdd the domain to the user linked with the user_id
POSTUnlock the user
Environment
GETGet the list of environments
POSTCreate a new environment
GETGet the environment id details
DELETEDelete an Environment
PATCHUpdate an environment
GETGet the environment id storage details
POSTCreate storage for environment id
GETGet the environment storage id storage details
GETGet list of pipelines using the storage
GETGet List of ephemeral computes for environment
POSTCreate ephemeral cluster
GETGet ephemeral computes for environment by id
GETGet the list of environments interactive (persistent) templates
POSTCreate an interactive compute
GETGet persistent computes for environment by id
GETGet the accessible domains present within an environment accessible by a user
GETGets all environment clusters.
Sources
GETGet list of sources
POSTCreate source
GETGet Source Info
DELETEDelete source
PATCHUpdate source
GETBrowse source
POSTAdd query tables
GETCrawl Entity Schema
GETBulk Crawl Entity Schema
GETCheck status for crawling
GETCheck status for bulk crawling
Connections
GETGet source connection details
PUTUpdate an existing source connection
Source Configurations
POSTAdd advanced configuration to the source
GETGet all advanced configuration of the source
GETGet a source advanced configuration
PUTUpdate a source advanced configuration
DELETEDelete a source advanced configuration
GETGet source Configuration
Generic Source Types
GETGet Generic Source Types List
POSTRegister or Create Generic Source Type
GETGet Generic Source Type By Id
PATCHUpdate Generic Source Type By Id
DELETEDelete Generic Source Type By Id
GETGet Generic Source Type Dependencies
GETGet all files in Generic Source Type by id
POSTadd file in Generic Source Type by id
Topics
GETGet a list of all topics mapping.
POSTCreate Topic Mapping For Source
GETGet topic mapping id.
PATCHUpdate Topic Mapping For Source
DELETEDelete Topic Mapping For Source
GETGet topics From Source
GETGet topic Preview
GETCrawl Schema For Topic Mapping
GETGet Table Schema From Mapping
POSTCreate Streaming Table
GETGet Streaming Table
DELETEDelete Streaming Table
DELETEDelete JSON Source Table
File Mappings
GETGet File Mappings for JSON source
POSTCreate File Mapping For JSON Source
GETGet File Mappings for JSON source by id
DELETEDelete File Mapping For JSON Source
PATCHUpdate File Mapping For JSON Source
GETGet File Mapping Data Preview
GETCrawl Schema For File Mapping
GETGet Table Schema From Mapping
POSTCreate JSON Source Table
GETGet JSON Source Table
Streaming
PUTAdd/Edit Configuration for streaming options of a table group.
GETGet streaming configuration of given table.
GETGet tables for whom streaming configurations are set in a particular source.
GETGet streaming table info.
Tables
POSTCreates the file mapping (table) of the csv source.
PUTModifies the file mapping (table) of the csv source.
PATCHUpdates the file mapping (table) of the csv source.
PUTupdate source metadata
GETget source metadata
GETget whether staging fields can be edited
GETGet the list of Source Files paths of the table
GETGet meta crawled table count
GETGet List of excluded tables
GETGet Source schema
GETlist all the tables in the source
POSTAdd tables to a File Source
POSTlist all the tables in the source
GETGet Table Info
PATCHUpdate the Table
DELETEDelete Table for a source
GETCrawl Table Schema
POSTadd the tables to a source and crawl metadata of those added tables
PUTUpdates and configures the table for Ingestion
GETGet ingestion configuration of table
GETGet list of Entity advance configuration
POSTAdd advance configuration for a table
GETGet table advance configuration
PUTupdate advance configuration for a table
DELETEDelete advance configuration for a table
PUTupdate table export configuration
GETget table export configuration
PATCHupdate table column order
PUTupdate table metadata
GETget table metadata
GETGet table export configuration connection properties
PUTupdate table export configuration Connection properties
POSTStart Segmentation on a Table
POSTCrawl Segments Metadata on a Table
GETGet Table Segments of a Table
POSTEnd Segmentation on a Table
POSTCancel Segmentation on a Table
GETGet the schema of the table
PUTUpdate the schema of the table
GETconfigurations
GETGet a list of all table segments.
GETGets Validation Specs for a Table.
POSTAdd Validation Specs to a Table.
PATCHUpdates the Validation Specs for a table.
DELETEDelete Validation Specs for a Table
GETGet table preview.
GETGenerate table preview.
GETGenerate query table preview.
GETGet query table preview.
GETGet Preview Queries.
GETGet multiple table Ids
PATCHupdate table metadata
GETget table metadata
GETget table lineage
Table Groups
POSTAdd a `Table Group`.
GETGets `Table Group` list.
GETGets `Table Group` object for given id.
PUTUpdate `Table Group` object for given id.
DELETE{table_group_id}
POSTThis will Configure particular `Table Group` with `tableGroupId`.
GETThis will fetch array of audit logs for table group with `tableGroupId`.
GETGets `Table to Table Group` Mapping.
Table Group Schedule
GETGet Table Group Schedule
PUTEnable Table Group Schedule
PUTDisable Table Group Schedule
PUTConfigure Table Group Schedule User
Domains
GETGet the Target Data Connection
PUTEdit the Target Data Connections Associated with a Domain
PATCHPatch the Target Data Connection
DELETEDelete the Target Data Connections Associated with a Domain
GETGet List of Domains
GETGet List of Domains
GETGet List of Domains Users
GETGet List of Accessible Domains
GETGet List of Domains Pipeline Extensions
GETGet List of Domains
POSTAdd a domain. (Requires Admin Access)
GETGet description of a domain_id. (Requires Admin Access)
PATCHEdit name and description of a domain. (Requires Admin Access)
DELETEDelete a Domain (Requires Admin Access).
GETGet all the Sources associated with this Domain
POSTAdd Sources to this Domain (Requires Admin Access)
PUTUpdate Sources to this Domain (Requires Admin Access)
DELETERemove Source from this Domain (Requires Admin Access)
GETGet all the Domains associated with this Domain
POSTAdd Domains to this Domain (Requires Admin Access)
PUTUpdate accessible-domain in this Domain (Requires Admin Access)
DELETERemove Domain from this Domain (Requires Admin Access)
GETGet all the workflows associated with this Domain
GETGet all the tablegroups associated with this Domain
GETGet all the interactive computes associated with this Domain
GETGet all the pipelines associated with this Domain
GETGet all the Pipeline Extensions associated with this Domain
PUTUpdate accessible-pipeline-extensions in this Domain (Requires Admin Access)
POSTAdd Pipeline Extensions to this Domain (Requires Admin Access)
DELETERemove Pipeline Extension from this Domain (Requires Admin Access)
PUT{key}
PATCH{key}
DELETE{key}
GETGet recently used entities associated with this Domain
POSTAdd Recently Used Entity to this Domain
GETGet comments associated with this Domain
POSTAdd comment to this Domain
GETGet notifications associated with this Domain
GETGet Table Orders With Hierachy
GETGet Domains Pipeline and Accessibele Sources
Pipelines
GETGet all pipelines of all domains
POSTChange the active version of the Pipeline
GETGet all pipelines for domain with `domain_id`
POSTcreate new pipeline for domain with `domain_id`
GETGets a `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
DELETEDeletes a `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
PUTUpdates a `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
GETGets list of workflows using pipeline with `{pipeline_id}` in `domain` with `{domain_id}`.
GETGets all `pipeline analytics models` for ML Engine with `{pipeline_id}` in `domain` with `{domain_id}`.
GETGet list of all versions of Pipeline
POSTCreate a pipeline version
GETGets a `pipelineVersion` with `pipeline_version_id` of `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
DELETEDeletes a `pipelineVersion` with `pipeline_version_id` of `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
PATCHUpdate a `pipelineVersion` with `pipeline_version_id` of `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
POSTimportSql
GETExports the pipeline configuration
POSTImports the pipeline configuration
GETGets lineage for Pipeline Column.
GETValidate a pipeline
GETRefresh sample data
GETGet node schema
GETGet node data
GETGet node query
GETGet target SQL preview
GETGet Pipeline Version Audit Logs.
PATCHUpdate Pipeline Version Audit Logs
GETGet Pipeline Version Audit Logs.
GETgetTablesfromPipelineSources
PUTFile upload sql pipeline migration
PUTImport sql pipeline migration
Pipeline Extensions
GETGet Pipeline Extensions List
POSTGet Pipeline Extensions List
GETGet Pipeline Extension by id
PUTUpdate Pipeline Extension by id
DELETEDelete Pipeline Extension by id
GETGet all files in Pipeline Extension by id
POSTadd file in Pipeline Extension by id
POSTGet Pipeline Extensions List
Source Extensions
GETGet Source Extensions List
GETGet Source Extension by id
PUTUpdate Source Extension by id
DELETEDelete Source Extension by id
GETGet all files in Source Extension by id
POSTadd file in Source Extension by id
DELETEDelete File from Source Extension by file name
Workflows
GETGet list of all Workflows for a `domain` with `{domain_id}`.
POSTCreate Workflow for a `domain` with `{domain_id}`.
GETGets a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`.
DELETEDeletes a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`.
PATCHUpdate a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`.
GETExports workflow configuration
PUTImports workflow configuration
POSTRuns the latest workflow
POSTThis will pause all running builds of `workflow` with `{workflow_id}`.
POSTThis will resume all paused builds of `workflow` with `{workflow_id}`.
GETGet workflow lineage
GETGet workflow ancestors
GETThis will get all builds of `workflow` with `{workflow_id}`.
GETThis will get a specific build of `workflow` with `{workflow_id}`.
POSTThis will restart running `workflow` with `{workflow_id}`.
POSTThis will cancel running `workflow` with `{workflow_id}` for build with `workflow_run_id`.
GETGet task logs for a workflow run
GETDownload task logs for a workflow run
GETGets parents workflow details of the workflow
POSTSet workflow variables for a task in a workflow run
POSTGet Workflows
GETRetrieves the job details
POSTRestart Multiple Workflows
POSTCancel Multiple Workflows
Workflow Versions
GETGet all versions of a workflow
POSTCreate a new version of a workflow
GETGet a specific version of a workflow
PUTUpdate a specific version of a workflow
DELETEDelete a specific version of a workflow
GETGet audit logs for a specific version of a workflow
POSTSet a specific version of a workflow as active
POSTSet workflow variables for a task in a specific version of a workflow
Workflows Schedules
GETSchedules of Workflows belonging to this Domain.
GETSchedules of particular Workflow belonging to this Domain.
PUTEnable Workflow Schedule
PUTDisable Workflow Schedule
PUTChange Workflow Schedule User
Jobs
GETGet the jobs details
GETGet the job details with `job_id`
POSTResubmit Failed tables for ingestion
GETGet the job log as text stream with `job_id`
GETDownload iw job logs zip for iw_job with job_id
GETGet cluster jobs for iw_job with job_id
GETGet cluster job for iw_job with job_id and run_id
GETDownload cluster job logs zip for iw_job with job_id and run_id
GETGet the admin-jobs details
GETGet List of All jobs of this Source and it's artifacts.
POSTInitiates jobs for source and its artifacts
GETGet job with job id.
POSTResubmit Failed tables for ingestion
GETGet crawl job info.
GETGet Summary Logs for the Source Crawl Job.
GETGet Summary Logs for the Source Crawl Job.
GETGet List of All jobs of this Source and it's artifacts.
GETGet Interactive Jobs List
GETGet Interactive Job by id
PATCHUpdate the job status for Interactive Job
GETDownload Logs for Interactive Job
GETGets Jobs Model for a Source.
GETGets List of Pipeline Jobs.
POSTSubmit Pipeline Job.
GETGets Pipeline Job.
POSTSubmit Pipeline Job.
POSTGet the jobs details
GETGet the job details with `job_id`
GETCancel the job with `job_id`
GETResubmit Failed tables for ingestion
GETGets List of Pipeline Jobs.
POSTSubmit Pipeline Job.
GETGets Pipeline Groups Job.
GETGets Pipeline Groups Job.
GETGets Pipeline Groups Job.
GETGet the job log as text stream with `job_id`
GETDownload iw job logs zip for iw_job with job_id
Job Hooks
GETGet Job Hooks List
POSTCreate a Job Hook
GETGet Job Hook By Id
PATCHUpdate Job Hook Type By Id
DELETEDelete Job Hook By Id
GETGet all files in Job Hook by id
POSTadd file in Job Hook by id
GETGet Global Audit Job Hooks List
GETGet Audit Job Hooks List
GETGet Global Audit Pipeline Extension List
GETGet Audit Pipeline Extension List
GETGet Global Audit Source Extension List
GETGet Audit Source Extension List
License
GETGet Active License Violations
GETGet Active License
GETGet All Licenses
Pipeline Groups
GETGet all pipeline groups
POSTCreate Pipeline Groups
GETGet all pipeline groups for domain with `domain_id`
GETGet pipeline group
DELETEDelete Pipeline Group
PATCHUpdate Pipeline Group
GETGet Accessible pipeline group
GETGets List of Advance Config pipeline group.
POSTAdvance Configuration Pipeline Group.
GETGet Pipelinegroup advance configuration
PUTupdate advance configuration for a pipeline group
DELETEDelete advance configuration for a pipeline group
Service Authentication
GETList service authentication mechanisms
POSTCreate a service authentication mechanism
GETGet service authentication mechanism
PATCHUpdate service authentication mechanism
DELETEDelete service authentication mechanism
Secret Store
GETList secret stores
POSTCreate secret store
GETGet secret store
PATCHUpdate secret store
DELETEDelete secret store
Secrets
GETList secrets
POSTCreate secret
GETGet secret
PATCHUpdate secret
DELETEDelete secret
Event Notifications
GETList event notifications
Engagement Metrics
GETAggregate details
GETList Job status
Data Catalog
GETData Model Details
GETFavorite Entity Details
Pipeline Version Locks
GETGet all pipeline version locks for pipeline with pipeline_id
Jobflows
GETList Jobflows
GETGet Jobflow
Environment Cluster
GETGet Persistent Cluster Status
GETGet Environment Status
POSTStop the persistent cluster
PUTTerminate the persistent cluster
PUTRestart the cluster
PUTStop the cluster
POSTCreate the cluster
Billing Metering Data
GETGet daily billing metering data
GETGet billing information
GETGet snowflake daily billing metering data
GETGet snowflake billing information
GETGet metrics configuration
POSTSubmit a request for refreshing billing details
Scheduling Information
GETGet a particular entity schedule details
GETUsed to check whether scheduler service is working or not
PUTUsed to save a particular entity schedule details
PUTUsed to save a particular entity schedule user details
PUTUsed to save a particular entity schedule and its user details
Validation
GETUse to validate entity names
PUTUsed to verify users refresh token
Configurations
GETExports the source configuration
POSTImports the source configuration
PUTUpload config migration json file
Getting Server Timezone
GETUse to get server timezone
Target Data Connections
GETGet the Target Data Connections
POSTCreate Target Data Connections
GETGet the Data Connections for each subtype
Custom Tags
POSTAdd Custom tags
GETGet List of Custom Tags
GETGet custom tags
PATCHUpdate Custom tags
DELETEUpdate Custom tags
Presets
GETList presets
POSTCreate a preset
GETGet preset
PATCHUpdate preset
DELETEDelete preset
Admin Configurations
GETGet all General Configurations for Infoworks.
PUTReplace General Configurations for Infoworks.
GETGets `Mongo Backups` list.
GETGets Mongo Backup With Specified Id.
POSTStart Mongo Backup
GETGet the Schedule of the Mongo Backup.
PUTSchedule Mongo Backup.
PUTSchedule Mongo Backup.
GETGet the type of the Authentication and associated properties.
PUTChange the Authentication Mechanism
PATCHChange the Authentication Mechanism
POSTTest the Authentication Mechanism's Connection.
POSTTest the Authentication Connection for LDAP user.
General Configs
POSTGet general configuration with key
Admin Metadata Cleanup
GETGet metadata cleanup policies.
GETGet Jobs cleanup policy.
PUTEdit the Jobs Cleanup Policy
GETGet Audits cleanup policy.
PUTEdit the Audits Cleanup Policy
GETGet Metrics cleanup policy.
PUTEdit the Metrics Cleanup Policy
GETGet Schedule of cleanup policy.
PUTEdit Schedule of cleanup policy.
PUTEdit Schedule of cleanup policy.
PUTEdit Scheduling User of cleanup policy. Hit this API with the delegation token of the required User.
Admin Workflows
POSTPause Multiple Workflows
POSTResume Multiple Workflows
POSTRestart Multiple Workflows
POSTCancel Multiple Workflows
GETRetrieves the status of workflow
GETGets workflow versions
GETGet Workflows
GETGet Workflows tasks
GETGet Workflow run Id details
Metrics
GETGet the Ingestion-metrics of the table with job_id
GETGet the Export-metrics of the table with job_id
GETGet the Pipeline-metrics of the table with job_id
GETGet Job Status Metrics
GETGet Ingestion Metrics with job id.
GETGet job metrics with job id.
GETGet Export Metrics with job id.
GETGet Metrics for all tables in the source.
GETGet the Export-metrics of the table with job id
GETGet the ingestion-metrics of the table with job id
GETGet the ingestion-metrics for the table
GETDownload ingestion metrics for the table
GETDownload List of All jobs of this Source and it's artifacts.
GETGet the export-metrics for the table
POSTFetch the metrics for a given time period
Locked Entities
GETGet All Currently Locked Entities.
POSTUnlock Currently Locked Entities.
GETGet a specific currently Locked Entity.
POSTUnlock a Currently Locked Entity.
GETGet a specific currently Locked Entity.
GETGet All Currently Locked Entities.
POSTUnlock Currently Locked Entities.
Admin Subscribers
GETGet a list of subscribers.
POSTCreate a new subscriber.
GETGet a subscriber.
PUTUpdate a subscriber.
DELETEDelete a subscriber.
GETGet a Subscription List for a subscriber.
DELETEDelete all the subscription for a subscriber.
GETGet a list of all external and internal users.
Admin Metadata Backup
GETGet Backup configs for metadata backup job
POSTAdd Backup configs for metadata backup job
Self
GETGet the self details
GETGet the self details
Admin Schedules
GETGet details of all running schedules.
Custom Audit Columns
GETGet the Custom Audit Column
PATCHPatch the Custom Audit Column
DELETEDelete the Custom Audit Column
GETGet Custom Audit Columns
POSTCreate Custom Audit Column
GETGet Custom Audit Column Audits
Clear Cache
POSTTo clear Admin cache
Stop Streaming
POSTStops the streaming jobs for tables listed in request.
Misc
POSTCheck if schema is unique
POSTCheck if path is unique
Audits
GETGet the audit logs of the source
GETGet the audit logs of the table
Favorites
GETCheck entity favorite tag
PATCHToggle entity favorite tag
Subscribers
GETGet a list of subscribers.
GETGet a subscriber.
Service Authentication Cache
DELETEClear cache for service authentication or secret
Pipeline Version Lock
GETPut pipeline version lock for pipeline with pipeline_id and pipeline version with pipeline_version_id
PUTPut pipeline version lock for pipeline with pipeline_id and pipeline version with pipeline_version_id
DELETEDelete pipeline version lock for pipeline_id, pipeline_version_id
GETget pipeline version lock status for pipeline_id, pipeline_version_id
Workflow Run Metering Variables
GETGet workflow run metering variables
GETGet Server Time
GETGet values for 4 general configs(login_contact_info, login_welcome_text, login_message, is_quiescent_enabled)
GETGet connection parameters for generic jdbc sources
User Notification Subscribe
GETGet Entity Subscriber
POSTUpdate Entity Subscriber
POSTSubscribe Notification
PUTUnsubscribe Notification

Infoworks Rest API V3 1.0

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
GET /security/authenticate
Copy
Responses
200

Authentication success response

400

Request has invalid body or parameters.

401

Forbidden. User lacks access to specified resource.

406

Authentication Failed response

500

Internal Server Error.

Response
Copy

Get `authentication_token` with `refresh_token`.

Get authentication_token with refresh_token.

Auth
Headers
GET /security/token/access
Copy
Responses
200

Authentication success response

400

Request has invalid body or parameters.

401

Forbidden. User lacks access to specified resource.

406

Authentication Failed response

500

Internal Server Error.

Response
Copy

Purge authentication token

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

Auth
DELETE /security/token/access
Copy
Responses
200

ok

400

Request has invalid body or parameters.

401

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response
Copy

Validate `authentication_token` if its active or not.

Validate authentication_token if its active or not.

Auth
GET /security/token/validate
Copy
Responses
200

Valid Token Response

400

Request has invalid body or parameters.

401

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response
Copy

Regenerate Refresh Token and blacklist old token.

Regenerate Refresh Token and blacklist old token.

Auth
DELETE /security/token/refresh
Copy
Responses
200
400

Request has invalid body or parameters.

401

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response
Copy

Authorise User.

Authorise User.

Auth
Request Body
POST /security/authorise/user
Copy
Responses
200
400

Request has invalid body or parameters.

401

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response
Copy

Get SAML Redirect URL.

Get SAML Redirect URL.

Auth
GET /security/sso/initialise
Copy
Responses
200

Valid Token Response

400

Request has invalid body or parameters.

401

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response
Copy

LDAP Authorise User.

LDAP Authorise User.

Auth
Request Body
POST /security/get/user/data
Copy
Responses
200
400

Request has invalid body or parameters.

401

Forbidden. User lacks access to specified resource.

500

Internal Server Error.

Response
Copy

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

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

Auth
Request Body
POST /security/bulk-ldap-sync
Responses
200

bulk ldap users sync response

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.

400

Request has 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
POST /admin/users
Responses
200

Ok.

400

Request has 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.

400

Request has 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

400

Request has 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
PATCH /admin/users/{user_id}
Responses
200

Ok.

400

Request has 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
PATCH /admin/users/{user_id}/reset-password
Responses
200

Ok.

400

Request has 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.

400

Request has 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.

400

Request has 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
POST /admin/users/{user_id}/accessible-domains
Responses
200

Ok.

400

Request has 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.

400

Request has 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
POST /users
Responses
200

Ok.

400

Request has 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.

400

Request has 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

400

Request has 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
PATCH /users/{user_id}
Responses
200

Ok.

400

Request has 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
PATCH /users/{user_id}/reset-password
Responses
200

Ok.

400

Request has 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.

400

Request has 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.

400

Request has 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
POST /users/{user_id}/accessible-domains
Responses
200

Ok.

400

Request has 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
POST /users/unlock
Responses
200

Ok.

400

Request has 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
GET /admin/environment
Responses
200

Ok.

400

Request has 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
Request Body
POST /admin/environment
Responses
200

Ok.

400

Request has 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.

400

Request has 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.

400

Request has 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
PATCH /admin/environment/{environment_id}
Responses
200

Ok.

400

Request has 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.

400

Request has 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
POST /admin/environment/{environment_id}/environment-storage
Responses
200

Ok.

400

Request has 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.

400

Request has 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.

400

Request has 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.

400

Request has 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
POST /admin/environment/{environment_id}/environment-compute-template
Responses
200

Ok.

400

Request has 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.

400

Request has 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.

400

Request has 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
POST /admin/environment/{environment_id}/environment-interactive-clusters
Responses
200

Ok.

400

Request has 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.

400

Request has 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.

400

Request has 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

400

Request has 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
GET /sources
Responses
200

successful operation

400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Create source

Create source

Auth
Request Body

Source configurations

POST /sources
Responses
200

successful operation

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

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

400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Update source

Update source

Auth
Request Body

Source configurations

PATCH /sources/{source_id}
Responses
200

successful operation

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

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

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

successful operation

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

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
PUT /sources/{source_id}/configurations/connection
Responses
200

OK

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
POST /sources/{source_id}/configurations/advance
Responses
200

OK

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

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

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
PUT /sources/{source_id}/configurations/advance/{key}
Responses
200

OK

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

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

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
GET /admin/generic-source-type
Responses
200

Ok.

400

Request has 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
POST /admin/generic-source-type
Responses
200

Ok.

400

Request has 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.

400

Request has 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
PATCH /admin/generic-source-type/{generic_source_type_id}
Responses
200

Ok.

400

Request has 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.

400

Request has 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.

400

Request has 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.

400

Request has 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
POST /admin/generic-source-type/{generic_source_type_id}/files
Responses
200

Ok.

400

Request has 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

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
POST /sources/{source_id}/topic-mappings
Responses
200

Success

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

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
PATCH /sources/{source_id}/topic-mappings/{topic_mapping_id}
Responses
200

Success

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

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

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

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

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
GET /sources/{source_id}/topic-mappings/{topic_mapping_id}/table-schema
Responses
200

Success

400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Create Streaming Table

Create Streaming Table

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

Success

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

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

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

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
GET /sources/{source_id}/file-mappings
Responses
200

Success

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
POST /sources/{source_id}/file-mappings
Responses
200

Success

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

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

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
PATCH /sources/{source_id}/file-mappings/{file_mapping_id}
Responses
200

Success

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

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

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
GET /sources/{source_id}/file-mappings/{file_mapping_id}/table-schema
Responses
200

Success

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
POST /sources/{source_id}/file-mappings/{file_mapping_id}/tables
Responses
200

Success

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

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
PUT /sources/{source_id}/table/{table_id}/configurations/streaming
Responses
200

Ok

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.

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
GET /sources/{source_id}/streaming-tables
Responses
200

Ok

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

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.

POST /sources/{source_id}/tables/{table_id}/configurations/file-mapping
Responses
200

Success

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
PUT /sources/{source_id}/tables/{table_id}/configurations/file-mapping
Responses
200

Ok

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
PATCH /sources/{source_id}/tables/{table_id}/configurations/file-mapping
Responses
200

Ok

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

PUT /sources/{source_id}/metadata
Responses
200

OK

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

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

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

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

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

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

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
GET /sources/{source_id}/tables
Responses
200

successful operation

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
POST /sources/{source_id}/tables
Responses
200

successful operation

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
POST /sources/{source_id}/fetch-tables
Responses
200

successful operation

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

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

OK

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

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
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
POST /sources/{source_id}/tables/source_tables
Responses
200

successful operation

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

PUT /sources/{source_id}/tables/{table_id}/configurations/ingestion
Responses
200

OK

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

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

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
POST /sources/{source_id}/tables/{table_id}/configurations/advance
Responses
200

OK

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

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

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

OK

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

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

PUT /sources/{source_id}/tables/{table_id}/configurations/export
Responses
200

OK

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

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

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

OK

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

PUT /sources/{source_id}/tables/{table_id}/metadata
Responses
200

OK

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

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

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

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

OK

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
Request Body
POST /sources/{source_id}/tables/{table_id}/segmentation/start
Responses
200

Success

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
POST /sources/{source_id}/tables/{table_id}/segmentation/crawl
Responses
200

Success

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
Query String
GET /sources/{source_id}/tables/{table_id}/segmentation
Responses
200

Success

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
POST /sources/{source_id}/tables/{table_id}/segmentation/end
Responses
200

Success

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
POST /sources/{source_id}/tables/{table_id}/segmentation/cancel
Responses
200

Success

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

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
PUT /sources/{source_id}/tables/{table_id}/configurations/schema
Responses
200

OK

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

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

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
GET /sources/{source_id}/tables/{table_id}/validation-specs
Responses
200

Success

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
POST /sources/{source_id}/tables/{table_id}/validation-specs
Responses
200

Success

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
PATCH /sources/{source_id}/tables/{table_id}/validation-specs/{validation_spec_id}
Responses
200

Ok

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

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

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

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

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

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

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

400

Bad Request

401

Unauthorized Request

403

Forbidden Access

500

Internal Server Error

Response

Responses
Response

Responses
Response

Responses
Response