OAuth 2.0 API V2

Authorization and Verification

Token Authentication and Management API

Refresh & Access Token Overview
APIAccessToken
RefreshToken

Alation Agent API

Agent
Authentication Service
- List available Authentication Service addon versionsget
- Download a specific Authentication Service addon versionget

Articles API

Article Overview
Article

BI Source API

BI Source (GBMv2) Overview
server
folder
connection
report
datasource
permission
images
user

Connectors API (OCF)

connectors
- Get a list of connectorsget

Conversations API

Conversations
Posts

Conversations API version 2

Conversations v2 Overview
Conversations
Assignees
Posts

Custom Fields API

Custom Field Overview
Custom Field

Custom Field Values API

Custom Field Values Overview
Custom Field Value

Data Dictionary API

Data Dictionary

Data Health API

Data Health Ingestion
- Upsert rules and data health valuespost
Data Health Deletion
- Delete rules and data health valuesdelete
Data Health Retrieval
- Retrieve information about data quality fieldsget
- Retrieve information about data quality valuesget

Datasources API

Native Data Sources API Overview
datasource
datasource config checks
datasource metadata extraction
migrate native connector data sources to OCF
- Bulk migrate data sources to OCFpost
- Get a list of available ocf connectors and their native datasourcesget
migrate data source to Agent connector
- Migrate a data source to Agentput

Data Sources API (OCF)

datasource
datasource metadata extraction
datasource configuration
- Get General Configuration for Datasourceget
- Update general settings configuration except Authpatch
datasource config checks

Documents API

Documents

Domain API

Domain

Folder API

Folders

Groups API

Group Overview
Group
- GET multiple Groupsget
- GET a Groupget

Homepage Preferences API

Homepage Preferences
- Update group homepage preferencesput

Lineage API v2

Lineage & Dataflows Overview
Dataflow
Lineage
Cross-System Lineage

Lineage API v3

Lineage
- Delete lineage (beta)delete

My Domains API

My Domains
- Associate users and groups to domainsput

Members Permission API

Members Permission

NoSQL API v2

NoSQL

Otypes API

Otypes Overview
otype
- GET a response from the otypes API endpointget

Policy API

Policies
Policy Groups
- List Policy Groupsget

Privacy Settings API

Resource Privacy Settings
- Manage resource privacy settingspatch

Relational Integration API

Relational Integration API Overview
Schema
- Get schemas along with its custom fieldsget
- Create new schemas under a particular data sourcepost
Table
- Get tables along with its custom fieldsget
- Create new tables under a particular data sourcepost
Column
- Get columns along with its custom fieldsget
- Create new columns under a particular data sourcepost
Child columns
Joins

SCIM 2.0 API

Authorization and Integration
- Create SCIM Tokenpost

Search API

Search Overview
Search
- GET a response from the search API endpointget
Synonyms

Terms API

Terms

Template Visual Config API

Visual Config

User API

User Overview
User
Suspend Duplicate User Accounts
- Get duplicate user accounts.get
- Suspend duplicate user accountspost

User API v2

User
- GET multiple Usersget
- GET a Userget

Workflows API

Workflows
- List workflowsget
Requests
Review requests

Admin ✦

Table Metadata Sync Trigger

API Resources ✦

API Resources

Custom Fields (Legacy) ✦

Find Objects by Custom Field

Custom Template ✦

Custom Template

Flags and Tags ✦

Trust Check Flags API
Tags API

Jobs ✦

Jobs API

Metadata ✦

Relational Get APIs
Get Data Sources
Get Schemas
Relational Integration v1

NoSQL API ✦

NoSQL API v1 (Legacy)

Open With ✦

Open With (DataOS)
- Alation Data Explorer
- Open-With Registration

Query ✦

Queries API
Queriers APIs
Query Log Upload API

Upload Logical Metadata API ✦

ULM Overview
ULM with Article ID

Virtual Systems ✦

Virtual File System APIs
Virtual Data Source
Virtual BI Server

OAuth 2.0 API V2

Authorization and Verification

Token Authentication and Management API

Refresh & Access Token Overview
APIAccessToken
RefreshToken

Alation Agent API

Agent
Authentication Service
- List available Authentication Service addon versionsget
- Download a specific Authentication Service addon versionget

Articles API

Article Overview
Article

BI Source API

BI Source (GBMv2) Overview
server
folder
connection
report
datasource
permission
images
user

Connectors API (OCF)

connectors
- Get a list of connectorsget

Conversations API

Conversations
Posts

Conversations API version 2

Conversations v2 Overview
Conversations
Assignees
Posts

Custom Fields API

Custom Field Overview
Custom Field

Custom Field Values API

Custom Field Values Overview
Custom Field Value

Data Dictionary API

Data Dictionary

Data Health API

Data Health Ingestion
- Upsert rules and data health valuespost
Data Health Deletion
- Delete rules and data health valuesdelete
Data Health Retrieval
- Retrieve information about data quality fieldsget
- Retrieve information about data quality valuesget

Datasources API

Native Data Sources API Overview
datasource
datasource config checks
datasource metadata extraction
migrate native connector data sources to OCF
- Bulk migrate data sources to OCFpost
- Get a list of available ocf connectors and their native datasourcesget
migrate data source to Agent connector
- Migrate a data source to Agentput

Data Sources API (OCF)

datasource
datasource metadata extraction
datasource configuration
- Get General Configuration for Datasourceget
- Update general settings configuration except Authpatch
datasource config checks

Documents API

Documents

Domain API

Domain

Folder API

Folders

Groups API

Group Overview
Group
- GET multiple Groupsget
- GET a Groupget

Homepage Preferences API

Homepage Preferences
- Update group homepage preferencesput

Lineage API v2

Lineage & Dataflows Overview
Dataflow
Lineage
Cross-System Lineage

Lineage API v3

Lineage
- Delete lineage (beta)delete

My Domains API

My Domains
- Associate users and groups to domainsput

Members Permission API

Members Permission

NoSQL API v2

NoSQL

Otypes API

Otypes Overview
otype
- GET a response from the otypes API endpointget

Policy API

Policies
Policy Groups
- List Policy Groupsget

Privacy Settings API

Resource Privacy Settings
- Manage resource privacy settingspatch

Relational Integration API

Relational Integration API Overview
Schema
- Get schemas along with its custom fieldsget
- Create new schemas under a particular data sourcepost
Table
- Get tables along with its custom fieldsget
- Create new tables under a particular data sourcepost
Column
- Get columns along with its custom fieldsget
- Create new columns under a particular data sourcepost
Child columns
Joins

SCIM 2.0 API

Authorization and Integration
- Create SCIM Tokenpost

Search API

Search Overview
Search
- GET a response from the search API endpointget
Synonyms

Terms API

Terms

Template Visual Config API

Visual Config

User API

User Overview
User
Suspend Duplicate User Accounts
- Get duplicate user accounts.get
- Suspend duplicate user accountspost

User API v2

User
- GET multiple Usersget
- GET a Userget

Workflows API

Workflows
- List workflowsget
Requests
Review requests

Admin ✦

Table Metadata Sync Trigger

API Resources ✦

API Resources

Custom Fields (Legacy) ✦

Find Objects by Custom Field

Custom Template ✦

Custom Template

Flags and Tags ✦

Trust Check Flags API
Tags API

Jobs ✦

Jobs API

Metadata ✦

Relational Get APIs
Get Data Sources
Get Schemas
Relational Integration v1

NoSQL API ✦

NoSQL API v1 (Legacy)

Open With ✦

Open With (DataOS)
- Alation Data Explorer
- Open-With Registration

Query ✦

Queries API
Queriers APIs
Query Log Upload API

Upload Logical Metadata API ✦

ULM Overview
ULM with Article ID

Virtual Systems ✦

Virtual File System APIs
Virtual Data Source
Virtual BI Server

Get joins by table ID

get {protocol}://{base-url}/integration/v2/join_predicates/table/{table_id}/

Get joins by table ID.

Path Params

table_id

string

required

The ID of a table object.

Query Params

skip

integer

Defaults to 0

Specifies the number of objects to be skipped in one request. Used together with Limit parameter to fetch paginated requests. This is automatically set in X-Next-Page response header if present

limit

integer

Defaults to 100

Specifies the number of objects to be fetched in one paginated request. Response may have a X-Next-Page URL parameter in the header to fetch next set of objects or page

string

A case insensitive keyword filter.

show_deleted

boolean

Whether the response should include joins from objects that have been deleted.

use_flag_score

boolean

Whether to calculate the flag score for each join. Requires additional processing which can impact API performance.

Responses

Response body

array of objects

object

string

The join's identifier.

content

string

The join predicate composed of fully qualified column names.

flag_score

integer | null

The cumulative score based on the number of endorsements minus deprecation counts of the join.

freq

integer

The number of executions referencing that join.

title

string

The title of the join.

url

string

The URL to the join's profile page.

other_tables

array of objects

References to other tables used in the join.

other_tables

object

qualified_name

string

The fully qualified name of the table.

url

string

The URL to the table's profile page.

is_mandated

boolean

Whether an admin requires the join be used when querying the table.

is_suggested

boolean

Whether the join is suggested for use with the table.

is_top_correlated

boolean

Whether the join is in the top 3 of all joins with that table and executed more than 10 times.

Response body

object

errors

object

Explicit information about the error message

Has additional fields

code

string

A six digit code that identifies the problem. Refer the error documentation for more information.

detail

string

Details about the error message

title

string

The title of the error message

Response body

object

errors

object

Explicit information about the error message

Has additional fields

code

string

A six digit code that identifies the problem. Refer the error documentation for more information.

detail

string

Details about the error message

title

string

The title of the error message

Response body

object

errors

object

Explicit information about the error message

Has additional fields

code

string

A six digit code that identifies the problem. Refer the error documentation for more information.

detail

string

Details about the error message

title

string

The title of the error message

Response body

object

errors

object

Explicit information about the error message

Has additional fields

code

string

A six digit code that identifies the problem. Refer the error documentation for more information.

detail

string

Details about the error message

title

string

The title of the error message

Response body

object

errors

object

Explicit information about the error message

Has additional fields

code

string

A six digit code that identifies the problem. Refer the error documentation for more information.

detail

string

Details about the error message

title

string

The title of the error message

Response body

object

errors

object

Explicit information about the error message

Has additional fields

code

string

A six digit code that identifies the problem. Refer the error documentation for more information.

detail

string

Details about the error message

title

string

The title of the error message

Response body

object

errors

object

Explicit information about the error message

Has additional fields

code

string

A six digit code that identifies the problem. Refer the error documentation for more information.

detail

string

Details about the error message

title

string

The title of the error message

Response body

object

errors

object

Explicit information about the error message

Has additional fields

code

string

A six digit code that identifies the problem. Refer the error documentation for more information.

detail

string

Details about the error message

title

string

The title of the error message

Updated 2 months ago

Get joins by column (attribute) ID

Get joins by column (attribute) name

Did this page help you?

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://alation_domain/integration/v2/join_predicates/table/table_id/?skip=0&limit=100' \
3
     --header 'accept: application/json'

Choose an example:

application/json

Updated 2 months ago

Get joins by column (attribute) ID

Get joins by column (attribute) name

Did this page help you?

OAuth 2.0 API V2
Authorization and Verification
Get JSON Web Key Setget
Introspect JSON Web Token (JWT)post
Create JSON web token (JWT)post

Token Authentication and Management API
Refresh & Access Token Overview
APIAccessToken
Validates the given API Access Token.post
Revokes all the active API Access Tokens for the user.post
Creates a new API Access Token.post
RefreshToken
Validate the given RefreshToken.post
Regenerates a RefreshToken, invalidating the current token in request body.post
Creates a new RefreshToken for the user.post

Alation Agent API
Agent
Sign a certificate for the Alation Agentpost
Revoke the certificate of the Alation Agentpost
Resync an Alation Agentpost
Update an Alation Agentpatch
Get an Alation Agentget
Delete an Alation Agentdelete
Download a specific RHEL Alation Agent installer versionget
List available RHEL Alation Agent installer versionsget
Download a specific Debian Alation Agent installer versionget
List available Debian Alation Agent installer versionsget
Retrieve the Agent connectivity endpointget
Create an Alation Agentpost
Get a list of Agentsget
Authentication Service
Download a specific Authentication Service addon versionget
List available Authentication Service addon versionsget

Articles API
Article Overview
Article
Resurrect an articlepost
UPDATE an articleput
GET an articleget
DELETE an articledelete
POST an articlepost
GET all articlesget

BI Source API
BI Source (GBMv2) Overview
server
Migrate curation data for a BI Serverpost
Update a BI Serverpatch
GET a BI Serverget
Create a list of BI Serverspost
GET a list of BI Serversget
folder
Partially update a BI folderpatch
GET a BI folderget
DELETE a BI folderdelete
Create/Update a list of folder objectspost
GET a list of folders from a specified BI Serverget
DELETE a set of folders from a specified BI Serverdelete
connection
Partially update a connectionpatch
GET a connectionget
DELETE a connectiondelete
Partially update a connection columnpatch
GET a connection columnget
DELETE a connection columndelete
Create/Update a list of connection column objectspost
GET a set of connection columns from a specified BI Serverget
DELETE a set of connection columns from a specified BI Serverdelete
Create/Update a list of connection objectspost
GET a list of connections from a specified BI Serverget
DELETE a set of connections from a specified BI Serverdelete
report
Partially update a Reportpatch
GET a Reportget
DELETE a Reportdelete
Partially update a Report columnpatch
GET a Report columnget
DELETE a Report columndelete
Create/Update a list of report column objectspost
GET a set of report columns from a specified BI Serverget
DELETE a set of report columns from a specified BI Serverdelete
Create/Update a list of report objectspost
GET a list of reports from a specified BI Serverget
DELETE a set of reports from a specified BI Serverdelete
datasource
Partially update a Datasourcepatch
GET a Datasourceget
DELETE a Datasourcedelete
Partially update a Datasource columnpatch
GET a Datasource columnget
DELETE a Datasource columndelete
Create/Update a list of Datasource Columnspost
GET a set of datasource columns from a specified BI Serverget
DELETE a set of datasource columns from a specified BI Serverdelete
Create/Update a list of Datasourcespost
GET a set of datasources from a specified BI Serverget
DELETE a set of datasources from a specified BI Serverdelete
permission
GET a BI permissionget
DELETE a BI permissiondelete
Create/Update a list of BI Permissionspost
GET a list of BI permissions from a specified BI Serverget
DELETE a set of BI permissions from a specified BI serverdelete
images
POST an image associated with a BI object from a BI Serverpost
GET an image associated with a BI object from a BI Serverget
DELETE the current image associated to this object using imagetype querydelete
user
GET a BI userget
DELETE a BI userdelete
Create/Update a list of BI userspost
GET a list of BI users from a specified BI Serverget
DELETE a set of BI users from a specified BI Serverdelete

Connectors API (OCF)
connectors
Get a list of connectorsget

Conversations API
Conversations
Update a conversationpatch
Get a conversation by IDget
Delete a conversationdelete
Create a conversationpost
Get a list of conversationsget
Posts
Update a conversation postpatch
Get a conversation post by IDget
Delete a conversation postdelete
Create a conversation postpost
Get a list of conversation postsget

Conversations API version 2
Conversations v2 Overview
Conversations
Update a conversationpatch
Get a conversation by IDget
Delete a conversationdelete
Create a conversationpost
Get a list of conversationsget
Assignees
Add one assignee to the conversationpost
Get a conversation assignee by IDget
Remove a conversation assignee by IDdelete
Get a list of assignees for a conversation with given IDget
Remove all assignees from a conversation with given IDdelete
Posts
Update a conversation postpatch
Get a conversation post by IDget
Delete a conversation postdelete
Create a conversation postpost
Get a list of conversation postsget

Custom Fields API
Custom Field Overview
Custom Field
Read a Custom Fieldget
Read a Builtin Custom Fieldget
Bulk Create Custom Fieldspost
Bulk Read Custom Fieldsget

Custom Field Values API
Custom Field Values Overview
Custom Field Value
PUT multiple Custom Field Values Asyncput
PUT multiple Custom Field Valuesput
GET multiple Custom Field Valuesget

Data Dictionary API
Data Dictionary
Upload a data dictionaryput
Get data dictionary task errorsget
Get data dictionary task detailsget

Data Health API
Data Health Ingestion
Upsert rules and data health valuespost
Data Health Deletion
Delete rules and data health valuesdelete
Data Health Retrieval
Retrieve information about data quality valuesget
Retrieve information about data quality fieldsget

Datasources API
Native Data Sources API Overview
datasource
Update a datasourceput
Get a datasourceget
Delete a datasourcedelete
Create a datasourcepost
Get a list of datasourcesget
datasource config checks
Verify service account privilegesget
Verify service account authentication statusget
Verify network connection statusget
Verify configuration checksget
datasource metadata extraction
Update metadata extraction configurationsput
Update metadata extraction configurationspatch
Get metadata extraction configurationsget
Trigger metadata extraction jobpost
Get a list of available schemasget
migrate native connector data sources to OCF
Get a list of available ocf connectors and their native datasourcesget
Bulk migrate data sources to OCFpost
migrate data source to Agent connector
Migrate a data source to Agentput

Data Sources API (OCF)
datasource
Update an OCF datasourceput
Get a datasourceget
Delete a datasourcedelete
Create a datasourcepost
Get a list of datasourcesget
datasource metadata extraction
Update metadata extraction configurationspatch
Get metadata extraction configurationsget
Trigger job to sync schemas from data sourcepost
Trigger metadata extraction jobpost
Get a list of available schemasget
datasource configuration
Update general settings configuration except Authpatch
Get General Configuration for Datasourceget
datasource config checks
Verify service account privilegesget
Verify service account authentication statusget
Verify network connection statusget
Verify configuration checksget

Documents API
Documents
Update documentsput
Create documentspost
Retrieve documentsget
Delete documentsdelete

Domain API
Domain
It allows user to browse the domain rules, with some filters.post
Adds the requested objects to a domain.post
Move a domainpatch
Retrieve a domain's detailsget
Create domains in bulk.post
Retrieve a list of domains.get
Deletes the requested domain(s) and their subdomains. Additionally, it un-assigns all the objects from these domains and subdomains.delete

Folder API
Folders
Update foldersput
Create folderspost
Retrieve foldersget
Delete foldersdelete

Groups API
Group Overview
Group
GET a Groupget
GET multiple Groupsget

Homepage Preferences API
Homepage Preferences
Update group homepage preferencesput

Lineage API v2
Lineage & Dataflows Overview
Dataflow
Create/Replace a list of Dataflow objects with lineage infomationpost
Update a list of Dataflow objectspatch
Get Dataflow object details and related pathsget
Delete a list of Dataflow objectsdelete
Lineage
Post lineage informationpost
Get lineage informationget
Delete lineage informationdelete
Cross-System Lineage
Update cross-system lineage recordput
Get cross-system lineage recordget
Delete cross-system lineage recorddelete
Update cross-system lineage recordsput
Create cross-system lineage recordspost
Get cross-system lineage recordsget
Delete cross-system lineage recordsdelete

Lineage API v3
Lineage
Delete lineage (beta)delete

My Domains API
My Domains
Associate users and groups to domainsput

Members Permission API
Members Permission
Remove members from a resource.delete
Replace members of a resource.put
Add members to a resource.post

NoSQL API v2
NoSQL
Create NoSQL metadatapost
Update NoSQL data objectspatch
Retrieve NoSQL dataget
Delete NoSQL data objectsdelete

Otypes API
Otypes Overview
otype
GET a response from the otypes API endpointget

Policy API
Policies
Update Policies in bulkput
Create Policies in bulkpost
List Policiesget
Delete Policies in bulkdelete
Policy Groups
List Policy Groupsget

Privacy Settings API
Resource Privacy Settings
Manage resource privacy settingspatch

Relational Integration API
Relational Integration API Overview
Schema
Create new schemas under a particular data sourcepost
Get schemas along with its custom fieldsget
Table
Create new tables under a particular data sourcepost
Get tables along with its custom fieldsget
Column
Create new columns under a particular data sourcepost
Get columns along with its custom fieldsget
Child columns
Update children of a sub-columnpatch
Fetch children for columnget
Update children of root columnspatch
Joins
Get joins by data sourceget
Get joins by table nameget
Get joins by column (attribute) nameget
Get joins by table IDget
Get joins by column (attribute) IDget

SCIM 2.0 API
Authorization and Integration
Create SCIM Tokenpost

Search API
Search Overview
Search
GET a response from the search API endpointget
Synonyms
Replaces current synonym manifestpost
Clears current synonym manifestdelete
Retrieves synonym manifestget

Terms API
Terms
Update Termsput
Create Termspost
Retrieve Termsget
Delete Termsdelete

Template Visual Config API
Visual Config
Get a list of visual configs per object typeget
Delete a visual configdelete
Update an existing visual configput
Get a specific visual configget
List all visual configsget
Create a new visual configpost

User API
User Overview
User
GET authenticated User detailsget
GET a Userget
GET multiple Usersget
Suspend Duplicate User Accounts
Suspend duplicate user accountspost
Get duplicate user accounts.get

User API v2
User
GET a Userget
GET multiple Usersget

Workflows API
Workflows
List workflowsget
Requests
Show request detailsget
Create a requestpost
List requestsget
Review requests
Reject a review requestput
Approve a review requestput
List my review todosget

Admin ✦
Table Metadata Sync Trigger

API Resources ✦
API Resources

Custom Fields (Legacy) ✦
Find Objects by Custom Field

Custom Template ✦
Custom Template

Flags and Tags ✦
Trust Check Flags API
Tags API

Jobs ✦
Jobs API

Metadata ✦
Relational Get APIs
Get Data Sources
Get Schemas
Relational Integration v1

NoSQL API ✦
NoSQL API v1 (Legacy)

Open With ✦
Open With (DataOS)
Open-With Registration
Alation Data Explorer

Query ✦
Queries API
Queriers APIs
Query Log Upload API

Upload Logical Metadata API ✦
ULM Overview
ULM with Article ID

Virtual Systems ✦
Virtual File System APIs
Virtual Data Source
Virtual BI Server

OAuth 2.0 API V2
Authorization and Verification
Get JSON Web Key Setget
Introspect JSON Web Token (JWT)post
Create JSON web token (JWT)post

Token Authentication and Management API
Refresh & Access Token Overview
APIAccessToken
Validates the given API Access Token.post
Revokes all the active API Access Tokens for the user.post
Creates a new API Access Token.post
RefreshToken
Validate the given RefreshToken.post
Regenerates a RefreshToken, invalidating the current token in request body.post
Creates a new RefreshToken for the user.post

Alation Agent API
Agent
Sign a certificate for the Alation Agentpost
Revoke the certificate of the Alation Agentpost
Resync an Alation Agentpost
Update an Alation Agentpatch
Get an Alation Agentget
Delete an Alation Agentdelete
Download a specific RHEL Alation Agent installer versionget
List available RHEL Alation Agent installer versionsget
Download a specific Debian Alation Agent installer versionget
List available Debian Alation Agent installer versionsget
Retrieve the Agent connectivity endpointget
Create an Alation Agentpost
Get a list of Agentsget
Authentication Service
Download a specific Authentication Service addon versionget
List available Authentication Service addon versionsget

Articles API
Article Overview
Article
Resurrect an articlepost
UPDATE an articleput
GET an articleget
DELETE an articledelete
POST an articlepost
GET all articlesget

BI Source API
BI Source (GBMv2) Overview
server
Migrate curation data for a BI Serverpost
Update a BI Serverpatch
GET a BI Serverget
Create a list of BI Serverspost
GET a list of BI Serversget
folder
Partially update a BI folderpatch
GET a BI folderget
DELETE a BI folderdelete
Create/Update a list of folder objectspost
GET a list of folders from a specified BI Serverget
DELETE a set of folders from a specified BI Serverdelete
connection
Partially update a connectionpatch
GET a connectionget
DELETE a connectiondelete
Partially update a connection columnpatch
GET a connection columnget
DELETE a connection columndelete
Create/Update a list of connection column objectspost
GET a set of connection columns from a specified BI Serverget
DELETE a set of connection columns from a specified BI Serverdelete
Create/Update a list of connection objectspost
GET a list of connections from a specified BI Serverget
DELETE a set of connections from a specified BI Serverdelete
report
Partially update a Reportpatch
GET a Reportget
DELETE a Reportdelete
Partially update a Report columnpatch
GET a Report columnget
DELETE a Report columndelete
Create/Update a list of report column objectspost
GET a set of report columns from a specified BI Serverget
DELETE a set of report columns from a specified BI Serverdelete
Create/Update a list of report objectspost
GET a list of reports from a specified BI Serverget
DELETE a set of reports from a specified BI Serverdelete
datasource
Partially update a Datasourcepatch
GET a Datasourceget
DELETE a Datasourcedelete
Partially update a Datasource columnpatch
GET a Datasource columnget
DELETE a Datasource columndelete
Create/Update a list of Datasource Columnspost
GET a set of datasource columns from a specified BI Serverget
DELETE a set of datasource columns from a specified BI Serverdelete
Create/Update a list of Datasourcespost
GET a set of datasources from a specified BI Serverget
DELETE a set of datasources from a specified BI Serverdelete
permission
GET a BI permissionget
DELETE a BI permissiondelete
Create/Update a list of BI Permissionspost
GET a list of BI permissions from a specified BI Serverget
DELETE a set of BI permissions from a specified BI serverdelete
images
POST an image associated with a BI object from a BI Serverpost
GET an image associated with a BI object from a BI Serverget
DELETE the current image associated to this object using imagetype querydelete
user
GET a BI userget
DELETE a BI userdelete
Create/Update a list of BI userspost
GET a list of BI users from a specified BI Serverget
DELETE a set of BI users from a specified BI Serverdelete

Connectors API (OCF)
connectors
Get a list of connectorsget

Conversations API
Conversations
Update a conversationpatch
Get a conversation by IDget
Delete a conversationdelete
Create a conversationpost
Get a list of conversationsget
Posts
Update a conversation postpatch
Get a conversation post by IDget
Delete a conversation postdelete
Create a conversation postpost
Get a list of conversation postsget

Conversations API version 2
Conversations v2 Overview
Conversations
Update a conversationpatch
Get a conversation by IDget
Delete a conversationdelete
Create a conversationpost
Get a list of conversationsget
Assignees
Add one assignee to the conversationpost
Get a conversation assignee by IDget
Remove a conversation assignee by IDdelete
Get a list of assignees for a conversation with given IDget
Remove all assignees from a conversation with given IDdelete
Posts
Update a conversation postpatch
Get a conversation post by IDget
Delete a conversation postdelete
Create a conversation postpost
Get a list of conversation postsget

Custom Fields API
Custom Field Overview
Custom Field
Read a Custom Fieldget
Read a Builtin Custom Fieldget
Bulk Create Custom Fieldspost
Bulk Read Custom Fieldsget

Custom Field Values API
Custom Field Values Overview
Custom Field Value
PUT multiple Custom Field Values Asyncput
PUT multiple Custom Field Valuesput
GET multiple Custom Field Valuesget

Data Dictionary API
Data Dictionary
Upload a data dictionaryput
Get data dictionary task errorsget
Get data dictionary task detailsget

Data Health API
Data Health Ingestion
Upsert rules and data health valuespost
Data Health Deletion
Delete rules and data health valuesdelete
Data Health Retrieval
Retrieve information about data quality valuesget
Retrieve information about data quality fieldsget

Datasources API
Native Data Sources API Overview
datasource
Update a datasourceput
Get a datasourceget
Delete a datasourcedelete
Create a datasourcepost
Get a list of datasourcesget
datasource config checks
Verify service account privilegesget
Verify service account authentication statusget
Verify network connection statusget
Verify configuration checksget
datasource metadata extraction
Update metadata extraction configurationsput
Update metadata extraction configurationspatch
Get metadata extraction configurationsget
Trigger metadata extraction jobpost
Get a list of available schemasget
migrate native connector data sources to OCF
Get a list of available ocf connectors and their native datasourcesget
Bulk migrate data sources to OCFpost
migrate data source to Agent connector
Migrate a data source to Agentput

Data Sources API (OCF)
datasource
Update an OCF datasourceput
Get a datasourceget
Delete a datasourcedelete
Create a datasourcepost
Get a list of datasourcesget
datasource metadata extraction
Update metadata extraction configurationspatch
Get metadata extraction configurationsget
Trigger job to sync schemas from data sourcepost
Trigger metadata extraction jobpost
Get a list of available schemasget
datasource configuration
Update general settings configuration except Authpatch
Get General Configuration for Datasourceget
datasource config checks
Verify service account privilegesget
Verify service account authentication statusget
Verify network connection statusget
Verify configuration checksget

Documents API
Documents
Update documentsput
Create documentspost
Retrieve documentsget
Delete documentsdelete

Domain API
Domain
It allows user to browse the domain rules, with some filters.post
Adds the requested objects to a domain.post
Move a domainpatch
Retrieve a domain's detailsget
Create domains in bulk.post
Retrieve a list of domains.get
Deletes the requested domain(s) and their subdomains. Additionally, it un-assigns all the objects from these domains and subdomains.delete

Folder API
Folders
Update foldersput
Create folderspost
Retrieve foldersget
Delete foldersdelete

Groups API
Group Overview
Group
GET a Groupget
GET multiple Groupsget

Homepage Preferences API
Homepage Preferences
Update group homepage preferencesput

Lineage API v2
Lineage & Dataflows Overview
Dataflow
Create/Replace a list of Dataflow objects with lineage infomationpost
Update a list of Dataflow objectspatch
Get Dataflow object details and related pathsget
Delete a list of Dataflow objectsdelete
Lineage
Post lineage informationpost
Get lineage informationget
Delete lineage informationdelete
Cross-System Lineage
Update cross-system lineage recordput
Get cross-system lineage recordget
Delete cross-system lineage recorddelete
Update cross-system lineage recordsput
Create cross-system lineage recordspost
Get cross-system lineage recordsget
Delete cross-system lineage recordsdelete

Lineage API v3
Lineage
Delete lineage (beta)delete

My Domains API
My Domains
Associate users and groups to domainsput

Members Permission API
Members Permission
Remove members from a resource.delete
Replace members of a resource.put
Add members to a resource.post

NoSQL API v2
NoSQL
Create NoSQL metadatapost
Update NoSQL data objectspatch
Retrieve NoSQL dataget
Delete NoSQL data objectsdelete

Otypes API
Otypes Overview
otype
GET a response from the otypes API endpointget

Policy API
Policies
Update Policies in bulkput
Create Policies in bulkpost
List Policiesget
Delete Policies in bulkdelete
Policy Groups
List Policy Groupsget

Privacy Settings API
Resource Privacy Settings
Manage resource privacy settingspatch

Relational Integration API
Relational Integration API Overview
Schema
Create new schemas under a particular data sourcepost
Get schemas along with its custom fieldsget
Table
Create new tables under a particular data sourcepost
Get tables along with its custom fieldsget
Column
Create new columns under a particular data sourcepost
Get columns along with its custom fieldsget
Child columns
Update children of a sub-columnpatch
Fetch children for columnget
Update children of root columnspatch
Joins
Get joins by data sourceget
Get joins by table nameget
Get joins by column (attribute) nameget
Get joins by table IDget
Get joins by column (attribute) IDget

SCIM 2.0 API
Authorization and Integration
Create SCIM Tokenpost

Search API
Search Overview
Search
GET a response from the search API endpointget
Synonyms
Replaces current synonym manifestpost
Clears current synonym manifestdelete
Retrieves synonym manifestget

Terms API
Terms
Update Termsput
Create Termspost
Retrieve Termsget
Delete Termsdelete

Template Visual Config API
Visual Config
Get a list of visual configs per object typeget
Delete a visual configdelete
Update an existing visual configput
Get a specific visual configget
List all visual configsget
Create a new visual configpost

User API
User Overview
User
GET authenticated User detailsget
GET a Userget
GET multiple Usersget
Suspend Duplicate User Accounts
Suspend duplicate user accountspost
Get duplicate user accounts.get

User API v2
User
GET a Userget
GET multiple Usersget

Workflows API
Workflows
List workflowsget
Requests
Show request detailsget
Create a requestpost
List requestsget
Review requests
Reject a review requestput
Approve a review requestput
List my review todosget

Admin ✦
Table Metadata Sync Trigger

API Resources ✦
API Resources

Custom Fields (Legacy) ✦
Find Objects by Custom Field

Custom Template ✦
Custom Template

Flags and Tags ✦
Trust Check Flags API
Tags API

Jobs ✦
Jobs API

Metadata ✦
Relational Get APIs
Get Data Sources
Get Schemas
Relational Integration v1

NoSQL API ✦
NoSQL API v1 (Legacy)

Open With ✦
Open With (DataOS)
Open-With Registration
Alation Data Explorer

Query ✦
Queries API
Queriers APIs
Query Log Upload API

Upload Logical Metadata API ✦
ULM Overview
ULM with Article ID

Virtual Systems ✦
Virtual File System APIs
Virtual Data Source
Virtual BI Server

200Resolves the request to a list of matching joins.

400Malformed Request

401Unauthorized bad/missing token

403Forbidden User cannot edit this resource

404The specified resource was not found

413Request Too Large

414Request URL Too Long

429Too many requests

500Internal Server Error