Token Authentication and Management API

Refresh & Access Token Overview
APIAccessToken
RefreshToken

Alation Agent API

Agent

Articles API

Article Overview
Article

BI Source API

BI Source (GBMv2) Overview
server
connection
datasource
folder
permission
report
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

Cross-System Lineage Information API

Cross-System Lineage

Custom Fields API

Custom Field Overview
Custom Field

Custom Field Values API

Custom Field Values Overview
Custom Field Value

Data Dictionary API

Data Dictionary
- Get data dictionary task detailsget
- Upload a data dictionaryput

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

Data sources API (Native)

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

Data Sources API (OCF)

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

Domains API

Domain

Groups API

Group Overview
Group
- GET multiple Groupsget
- GET a Groupget

Lineage v2 API

Lineage & Dataflows Overview
Dataflow
Lineage

Members Permission API

Members Permission

OAuth 2.0 API V2

Authorization and Verification

Otypes API

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

Policy API

Policies
Policy Groups
- List Policy Groupsget

Privacy Settings API

Privacy Settings
- Manage privacy settingspatch

Relational Integration API

Relational Integration API Overview
Column
- Get columns along with its custom fieldsget
- Create new columns under a particular data sourcepost
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

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

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

Requests
Review requests
Workflows
- List workflowsget

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 APIs

Metadata ✦

Relational Get APIs
Get Data Sources
Get Schemas
Relational Integration v1

NoSQL API ✦

NoSQL Apis

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

Token Authentication and Management API

Refresh & Access Token Overview
APIAccessToken
RefreshToken

Alation Agent API

Agent

Articles API

Article Overview
Article

BI Source API

BI Source (GBMv2) Overview
server
connection
datasource
folder
permission
report
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

Cross-System Lineage Information API

Cross-System Lineage

Custom Fields API

Custom Field Overview
Custom Field

Custom Field Values API

Custom Field Values Overview
Custom Field Value

Data Dictionary API

Data Dictionary
- Get data dictionary task detailsget
- Upload a data dictionaryput

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

Data sources API (Native)

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

Data Sources API (OCF)

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

Domains API

Domain

Groups API

Group Overview
Group
- GET multiple Groupsget
- GET a Groupget

Lineage v2 API

Lineage & Dataflows Overview
Dataflow
Lineage

Members Permission API

Members Permission

OAuth 2.0 API V2

Authorization and Verification

Otypes API

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

Policy API

Policies
Policy Groups
- List Policy Groupsget

Privacy Settings API

Privacy Settings
- Manage privacy settingspatch

Relational Integration API

Relational Integration API Overview
Column
- Get columns along with its custom fieldsget
- Create new columns under a particular data sourcepost
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

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

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

Requests
Review requests
Workflows
- List workflowsget

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 APIs

Metadata ✦

Relational Get APIs
Get Data Sources
Get Schemas
Relational Integration v1

NoSQL API ✦

NoSQL Apis

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 a list of reports from a specified BI Server

get {protocol}://{base-url}/integration/v2/bi/server/{server_id}/report/

GET a range of report objects by ID.

Path Params

server_id

integer

required

ID of the containing server

Query Params

oids

array

List of object ids to be used

oids

keyField

string

Defaults to id

Field to use as an identifier of the resource (id, or external_id)

limit

integer

Defaults to 100

Specifies the number of objects to be fetched in one paginated request.

offset

integer

Defaults to 0

Specifies the number of objects to be skipped in one request. Used together with Limit parameter to fetch paginated requests.

Responses

Response body

array of objects

object

integer

required

The auto-generated id of the object

name

string

required

The user-friendly name of the object

external_id

string

required

The identifier of the object as generated by the BI Server. This is used as an identifier for bulk create/update operations.

created_at

date-time

Date and time of object creation on the BI Server

last_updated

date-time

Most recent update time of the object on the BI Server

source_url

string

required

Path to the object on the BI Server

bi_object_type

string

required

The type of the object, as defined by the BI Server

description_at_source

string

required

Object description on the BI Server

report_type

string | null

required

The type of report, whether it is a simple chart or a dashboard of reports.

SIMPLE DASHBOARD

owner

string

required

Username of the report's owner

num_accesses

integer | null

Number of times the report has been accessed on the BI Server

popularity

number | null

Index of popularity based partially on num_accesses

parent_folder

string | null

external_id of the parent folder. Note that the folder must exist on Alation to properly update this

parent_reports

array of strings | null

external_id of the parent reports. Note that the reports must exist on Alation, or occur earlier in the POST payload, to properly update this

parent_reports

sub_reports

array of strings | null

external_id of all subreports

sub_reports

parent_datasources

array of strings | null

external_id of the parent datasources. Note that the reports must exist on Alation, or occur earlier in the POST payload, to properly update this

parent_datasources

report_columns

array of strings

external_id of all contained report columns

report_columns

Response body

object

code

string

required

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

title

string

required

The title of the error message

detail

string

required

More information about the error

Response body

object

code

string

required

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

title

string

required

The title of the error message

detail

string

required

More information about the error

Response body

object

code

string

required

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

title

string

required

The title of the error message

detail

string

required

More information about the error

Response body

object

code

string

required

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

title

string

required

The title of the error message

detail

string

required

More information about the error

Response body

object

code

string

required

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

title

string

required

The title of the error message

detail

string

required

More information about the error

Updated over 1 year ago

DELETE a set of reports from a specified BI Server

Create/Update a list of report objects

Did this page help you?

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://alation_domain/integration/v2/bi/server/server_id/report/?keyField=id&limit=100&offset=0' \
3
     --header 'accept: application/json'

Choose an example:

application/json

Updated over 1 year ago

DELETE a set of reports from a specified BI Server

Create/Update a list of report objects

Did this page help you?

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

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
Update a BI Serverpatch
GET a BI Serverget
Create a list of BI Serverspost
GET a list of BI Serversget
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
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
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
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
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
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

Cross-System Lineage Information API
Cross-System Lineage
Update cross-system lineage recordpatch
Get cross-system lineage recordsget
Delete cross-system lineage recorddelete
Create cross-system lineage recordspost

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

Data sources API (Native)
Native Data Sources API Overview
datasource
Update a datasourceput
Get a datasourceget
Delete a datasourcedelete
Create a datasourcepost
Get a list of datasourcesget
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
datasource config checks
Verify service account privilegesget
Verify service account authentication statusget
Verify network connection statusget
Verify configuration checksget
migrate data source to Agent connector
Migrate a data source to Agentput
migrate native connector data sources to OCF
Get a list of available ocf connectors and their native datasourcesget
Bulk migrate data sources to OCFpost

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
Get metadata extraction configurationsget
Update metadata extraction configurationspatch
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

Domains API
Domain
Browse the domain rules with filterspost
Adds the requested objects to a domain.post
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

Groups API
Group Overview
Group
GET a Groupget
GET multiple Groupsget

Lineage v2 API
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

Members Permission API
Members Permission
Delete member permissionsdelete
Replace member permissionsput
Add member permissionspost

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

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
Privacy Settings
Manage privacy settingspatch

Relational Integration API
Relational Integration API Overview
Column
Create new columns under a particular data sourcepost
Get columns along with its custom fieldsget
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

SCIM 2.0 API
Authorization and Integration
Create SCIM Tokenpost

Search API
Search Overview
Search
GET a response from the search API endpointget
Synonyms
Suite of operations for management of synonyms for searchpost
Suite of operations for management of synonyms for searchdelete
Suite of operations for management of synonyms for searchget

Terms API
Terms
Update Termsput
Create Termspost
Retrieve Termsget
Delete Termsdelete

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
Requests
Show request detailsget
Create a requestpost
List requestsget
Review requests
Reject a review requestput
Approve a review requestput
List my review todosget
Workflows
List workflowsget

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 APIs

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

NoSQL API ✦
NoSQL Apis

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

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

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
Update a BI Serverpatch
GET a BI Serverget
Create a list of BI Serverspost
GET a list of BI Serversget
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
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
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
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
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
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

Cross-System Lineage Information API
Cross-System Lineage
Update cross-system lineage recordpatch
Get cross-system lineage recordsget
Delete cross-system lineage recorddelete
Create cross-system lineage recordspost

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

Data sources API (Native)
Native Data Sources API Overview
datasource
Update a datasourceput
Get a datasourceget
Delete a datasourcedelete
Create a datasourcepost
Get a list of datasourcesget
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
datasource config checks
Verify service account privilegesget
Verify service account authentication statusget
Verify network connection statusget
Verify configuration checksget
migrate data source to Agent connector
Migrate a data source to Agentput
migrate native connector data sources to OCF
Get a list of available ocf connectors and their native datasourcesget
Bulk migrate data sources to OCFpost

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
Get metadata extraction configurationsget
Update metadata extraction configurationspatch
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

Domains API
Domain
Browse the domain rules with filterspost
Adds the requested objects to a domain.post
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

Groups API
Group Overview
Group
GET a Groupget
GET multiple Groupsget

Lineage v2 API
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

Members Permission API
Members Permission
Delete member permissionsdelete
Replace member permissionsput
Add member permissionspost

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

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
Privacy Settings
Manage privacy settingspatch

Relational Integration API
Relational Integration API Overview
Column
Create new columns under a particular data sourcepost
Get columns along with its custom fieldsget
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

SCIM 2.0 API
Authorization and Integration
Create SCIM Tokenpost

Search API
Search Overview
Search
GET a response from the search API endpointget
Synonyms
Suite of operations for management of synonyms for searchpost
Suite of operations for management of synonyms for searchdelete
Suite of operations for management of synonyms for searchget

Terms API
Terms
Update Termsput
Create Termspost
Retrieve Termsget
Delete Termsdelete

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
Requests
Show request detailsget
Create a requestpost
List requestsget
Review requests
Reject a review requestput
Approve a review requestput
List my review todosget
Workflows
List workflowsget

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 APIs

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

NoSQL API ✦
NoSQL Apis

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

200A list of Connection reports

400Malformed Request

401Unauthorized bad/missing token

403Forbidden User cannot edit this resource

404The specified resource was not found

500Internal Server Error