Skip to main content
API docs by Redocly

Dataedo Public API v1 (3.0.0)

Dataedo Support: [email protected] License: Dataedo License

This public API allows external developers to interact with Dataedo services securely using JWT Bearer token authentication. Version 1 of the API exposing core functionalities.

AreasV1

Finds area simple data by Id.

Returns a single area base data by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
No sample

Finds area detailed data by Id.

Returns a single area detailed data by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the area stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds a list of links for the area by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the area stored in the Dataedo Repository.

query Parameters
filters
string

Available filters: type, subType, name, title, status, source.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sort parameters. To sort by title ascending, write 'title'. To sort descending, write '-title'. Available sorts: type, subType, name, title, status, source.

Responses

Response samples

Content type
No sample

Updates the title of the area by Id.

Updates title of a single area by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the area stored in the Dataedo repository.

Request Body schema:

The title of a single area.

title
string or null

Responses

Request samples

Content type
{
  • "title": "string"
}

Gets area custom fields by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the area stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Update area custom fields.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the area stored in the Dataedo repository.

Request Body schema:
required
Array of objects or null (Dataedo.Public.Models.Public.v1.Features.CustomFields.CustomFieldInfo)
Array
name
string or null

Custom field name.

value
string or null

Custom field value in specific to custom field definition format.

Responses

Request samples

Content type
{
  • "fields": [
    ]
}

ColumnsV1

Finds column simple data by Id.

Returns a single column entity base data by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the column stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds column detailed data by Id.

Returns a single column detailed data by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the column stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds column entity linked glossary entries by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the column stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

This method is used to update the description of the column by Id.

Updates description of a single column by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the column stored in the Dataedo repository.

Request Body schema:
required
description
string or null

Responses

Request samples

Content type
{
  • "description": "string"
}

Updates the title of the column by Id.

Updates title of a single column by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the column stored in the Dataedo repository.

Request Body schema:
required
title
string or null

Responses

Request samples

Content type
{
  • "title": "string"
}

Gets column custom fields by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the column stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Update column custom fields.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the column stored in the Dataedo repository.

Request Body schema:
required
Array of objects or null (Dataedo.Public.Models.Public.v1.Features.CustomFields.CustomFieldInfo)
Array
name
string or null

Custom field name.

value
string or null

Custom field value in specific to custom field definition format.

Responses

Request samples

Content type
{
  • "fields": [
    ]
}

CustomFieldsV1

Gets definition of custom fields.

Returns custom field definitions.

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

DataSetsV1

Finds data set entity simple data by Id.

Returns a single data set entity base data by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the data set entity stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds data set entity detailed data by Id.

Returns a single data set entity base data by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the data set entity stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds data set entity domains by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the data set entity stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds data set entity areas by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the data set entity stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds data set entity linked glossary entries by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the data set entity stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds data set entity columns by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the data set entity stored in the Dataedo repository.

query Parameters
filters
string

Title filter example: "title==Dataedo Repository". Available filtering logic: title, name, description, ordinalPosition, dataType, status.

sorts
string

Sort parameters. To sort by title ascending, write 'ordinalPosition'. To sort descending, write '-ordinalPosition'. Available sorting logic: ordinalPosition, dataType, status.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

Responses

Response samples

Content type
No sample

Updates the title of the data set entity by Id.

Updates title of a single data set by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the data set entity stored in the Dataedo repository.

Request Body schema:
required
title
string or null

Responses

Request samples

Content type
{
  • "title": "string"
}

Gets data set custom fields by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the data set stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Update data set custom fields.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of data set stored in the Dataedo repository.

Request Body schema:
required
Array of objects or null (Dataedo.Public.Models.Public.v1.Features.CustomFields.CustomFieldInfo)
Array
name
string or null

Custom field name.

value
string or null

Custom field value in specific to custom field definition format.

Responses

Request samples

Content type
{
  • "fields": [
    ]
}

DataSourcesV1

Finds data source entity simple data by Id.

Returns a single data source entity base data by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the data source entity stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds data source entity detailed data by Id.

Returns a single data source entity detailed data by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the data source entity stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds a data source entities list.

Authorizations:
Bearer
query Parameters
filters
string

Query string to filter data sources by a class or title. Accepted class filter values: "class==DATABASE", "class==GLOSSARY", "class==REPORTING". Title filter example: "title==Dataedo Repository". Available filtering logic: title, host, port, descriptionPlain.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sort parameters. To sort by title ascending, write 'title'. To sort descending, write '-title'. Available sorting logic: title, host, port, descriptionPlain.

Responses

Response samples

Content type
No sample

Finds datasets by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the data source entity stored in the Dataedo repository.

query Parameters
filters
string

Title filter example: "title==Dataedo Repository". Available filtering logic: objectType, title, name, schema.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sort parameters. To sort by title ascending, write 'title'. To sort descending, write '-title'. Available sorting logic: objectType, title, name, schema.

Responses

Response samples

Content type
No sample

Finds programs by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the data source entity stored in the Dataedo repository.

query Parameters
filters
string

Title filter example: "title==Dataedo Repository". Available filtering logic: objectType, title, name, schema, descriptionPlain.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sort parameters. Write specific convention: To sort by title ascending, write 'title'. To sort descending, write '-title'. Available sorting logic: objectType, title, name, schema, descriptionPlain.

Responses

Response samples

Content type
No sample

Finds reports by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the data source entity stored in the Dataedo repository.

query Parameters
filters
string

Query string to filter data sources by a class or title. Title filter example: "title==Dataedo Repository". Available filtering logic: objectType, title, name, schema, descriptionPlain.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sort parameters. To sort by title ascending, write 'title'. To sort descending, write '-title'. Available sorting logic: objectType, title, name, schema, descriptionPlain.

Responses

Response samples

Content type
No sample

Finds data source domains by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the data source stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds data source areas by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the data source stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Updates the title of the program by Id.

Updates title of a single data source by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the area stored in the Dataedo repository.

Request Body schema:
required
title
string or null

Responses

Request samples

Content type
{
  • "title": "string"
}

Gets data source custom fields by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the data source stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Update data source custom fields.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the data source stored in the Dataedo repository.

Request Body schema:
required
Array of objects or null (Dataedo.Public.Models.Public.v1.Features.CustomFields.CustomFieldInfo)
Array
name
string or null

Custom field name.

value
string or null

Custom field value in specific to custom field definition format.

Responses

Request samples

Content type
{
  • "fields": [
    ]
}

Performs refresh of data profiling for a data source by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the data source stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Performs import connector for a data source by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the data source stored in the Dataedo repository.

Request Body schema:

Import connector parameters.

fullReimport
boolean
appendOnly
boolean
importAutomaticLineage
boolean
parseSql
boolean
importCopyHistory
boolean
importDependencies
boolean
importBasicStatistics
boolean
importReportsUsage
boolean

Responses

Request samples

Content type
{
  • "fullReimport": true,
  • "appendOnly": true,
  • "importAutomaticLineage": true,
  • "parseSql": true,
  • "importCopyHistory": true,
  • "importDependencies": true,
  • "importBasicStatistics": true,
  • "importReportsUsage": true
}

Response samples

Content type
No sample

Performs data quality checks for a data source by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the data source stored in the Dataedo repository.

Request Body schema:

Data quality severities. Allowed values: 1 - Low, 2 - Mid, 3 - High, 4 - Critical

severity
Array of integers or null <int32>

Responses

Request samples

Content type
{
  • "severity": [
    ]
}

Response samples

Content type
No sample

DomainsV1

Finds domain simple data by Id.

Returns a single domain data by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the domain stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds program detailed data by Id.

Returns a single domain detailed data by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the domain stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds domains list.

Authorizations:
Bearer
query Parameters
filters
string

Query string to filter domains by a type.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sort parameters. To sort by title ascending, write 'title'. To sort descending, write '-title'. Available sorting logic: title, descriptionPlain, type.

Responses

Response samples

Content type
No sample

Finds areas list by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the domain stored in the Dataedo Repository

Responses

Response samples

Content type
No sample

Finds a list of links for the domain by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the domain stored in the Dataedo Repository

query Parameters
filters
string

Available filters: type, subType, name, title, status, source.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sort parameters. To sort by title ascending, write 'title'. To sort descending, write '-title'. Available sorts: type, subType, name, title, status, source.

Responses

Response samples

Content type
No sample

This method is used to update the title of the domain by Id.

Updates title of a single domain by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the domains stored in the Dataedo repository.

Request Body schema:
required
title
string or null

Responses

Request samples

Content type
{
  • "title": "string"
}

Gets domain custom fields by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the domain stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Update domain custom fields.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the domain stored in the Dataedo repository.

Request Body schema:
required
Array of objects or null (Dataedo.Public.Models.Public.v1.Features.CustomFields.CustomFieldInfo)
Array
name
string or null

Custom field name.

value
string or null

Custom field value in specific to custom field definition format.

Responses

Request samples

Content type
{
  • "fields": [
    ]
}

GlossaryEntriesV1

Finds glossary entry simple data by Id.

Returns a single glossary entry base data by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the glossary entry stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds glossary entry detailed data by Id.

Returns a single glossary entry detailed data by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the glossary entry stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds domains which the provided glossary entry belongs to.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the glossary entry stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds areas which the provided glossary entry belongs to.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the glossary entry stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds a list of links for the glossary entry by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the glossary entry stored in the Dataedo Repository.

query Parameters
filters
string

Available filters: type, subType, name, title, status, source.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sort parameters. To sort by title ascending, write 'title'. To sort descending, write '-title'. Available sorts: type, subType, name, title, status, source.

Responses

Response samples

Content type
No sample

Updates the title of the glossary entry by Id.

Updates title of a single glossary entry by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the glossary entry stored in the Dataedo repository.

Request Body schema:
required
title
string or null

Responses

Request samples

Content type
{
  • "title": "string"
}

Creates a new glossary entry.

Authorizations:
Bearer
Request Body schema:
required
title
string or null
parentId
integer or null <int32>
glossaryId
integer <int32>
typeId
integer <int32>
workflowStatusId
integer <int32>
description
string or null
object or null

Responses

Request samples

Content type
{
  • "title": "string",
  • "parentId": 0,
  • "glossaryId": 0,
  • "typeId": 0,
  • "workflowStatusId": 0,
  • "description": "string",
  • "customFields": {
    }
}

Gets glossary entry custom fields by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the glossary entry stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Update glossary entry custom fields.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the glossary entry stored in the Dataedo repository.

Request Body schema:
required
Array of objects or null (Dataedo.Public.Models.Public.v1.Features.CustomFields.CustomFieldInfo)
Array
name
string or null

Custom field name.

value
string or null

Custom field value in specific to custom field definition format.

Responses

Request samples

Content type
{
  • "fields": [
    ]
}

GlossaryEntryTypesV1

Gets glossary entry types.

Returns glossary entry types.

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

InterfaceTablesV1

List database names that have data in the interface tables.

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

Get imported table definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

filters
string

Filtering is not implemented yet.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sorting is not implemented yet.

Responses

Response samples

Content type
No sample

Bulk import table definitions.

Inserts table/view definitions into the import_tables staging table.

Authorizations:
Bearer
Request Body schema:

Collection of table definitions to import.

Array of objects or null (Dataedo.Public.Models.Public.v1.Features.InterfaceTables.Requests.ImportTableRequest)

The list of items to import. Maximum 10,000 items per request.

Array
databaseName
string or null

The name of the target database in Dataedo.

tableSchema
string or null

Schema of the table.

tableName
string or null

Name of the table. Required.

externalId
string or null

External identifier for the table.

objectType
string or null

Object type (e.g., TABLE, VIEW). Required.

objectSubtype
string or null

Object subtype.

description
string or null

Description of the table.

definition
string or null

SQL definition of the table.

location
string or null

Location of the table.

language
string or null

Programming language of the definition.

parentObjectExternalId
string or null

External ID of the parent object.

parentObjectSchema
string or null

Schema of the parent object.

parentObjectName
string or null

Name of the parent object.

parentObjectType
string or null

Type of the parent object.

linkedSourceExternalId
string or null

External ID of the linked source.

linkedSourceName
string or null

Name of the linked source.

dbmsCreated
string or null <date-time>

Date when the object was created in the DBMS.

dbmsLastModified
string or null <date-time>

Date when the object was last modified in the DBMS.

object or null

Custom field values. Keys are field names (e.g., "Field1"), values are the field values.

Responses

Request samples

Content type
{
  • "items": [
    ]
}

Response samples

Content type
No sample

Get imported column definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

filters
string

Filtering is not implemented yet.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sorting is not implemented yet.

Responses

Response samples

Content type
No sample

Bulk import column definitions.

Authorizations:
Bearer
Request Body schema:

Collection of column definitions to import.

Array of objects or null (Dataedo.Public.Models.Public.v1.Features.InterfaceTables.Requests.ImportColumnRequest)

The list of items to import. Maximum 10,000 items per request.

Array
databaseName
string or null

The name of the target database in Dataedo.

objectExternalId
string or null

External ID of the parent object (table/view).

objectSchema
string or null

Schema of the parent object.

objectName
string or null

Name of the parent object. Required.

objectObjectType
string or null

Object type of the parent (e.g., TABLE, VIEW).

columnName
string or null

Name of the column. Required.

columnPath
string or null

Path of the column (for nested structures).

columnLevel
integer <int32>

Nesting level of the column.

columnExternalId
string or null

External ID of the column.

columnParentExternalId
string or null

External ID of the parent column (for nested structures).

ordinalPosition
integer or null <int32>

Ordinal position of the column.

itemType
string or null

Item type of the column.

datatype
string or null

Data type of the column.

dataLength
string or null

Data length or precision.

nullable
boolean

Whether the column allows null values.

defaultValue
string or null

Default value of the column.

isIdentity
boolean

Whether the column is an identity column.

isComputed
boolean

Whether the column is computed.

computedFormula
string or null

Computed formula for the column.

description
string or null

Description of the column.

object or null

Custom field values. Keys are field names (e.g., "Field1"), values are the field values.

Responses

Request samples

Content type
{
  • "items": [
    ]
}

Response samples

Content type
No sample

Get imported key definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

filters
string

Filtering is not implemented yet.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sorting is not implemented yet.

Responses

Response samples

Content type
No sample

Bulk import key (unique/primary) definitions.

Authorizations:
Bearer
Request Body schema:

Collection of key definitions to import.

Array of objects or null (Dataedo.Public.Models.Public.v1.Features.InterfaceTables.Requests.ImportKeyRequest)

The list of items to import. Maximum 10,000 items per request.

Array
databaseName
string or null

The name of the target database in Dataedo.

tableSchema
string or null

Schema of the table containing the key.

tableName
string or null

Name of the table containing the key. Required.

tableObjectType
string or null

Object type of the table.

keyName
string or null

Name of the key. Required.

keyType
string or null

Type of the key (e.g., PK, UK).

description
string or null

Description of the key.

disabled
boolean

Whether the key is disabled.

columnName
string or null

Name of the column in the key.

columnPath
string or null

Path of the column in the key.

columnOrder
integer or null <int32>

Order of the column in the key.

object or null

Custom field values.

Responses

Request samples

Content type
{
  • "items": [
    ]
}

Response samples

Content type
No sample

Get imported foreign key definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

filters
string

Filtering is not implemented yet.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sorting is not implemented yet.

Responses

Response samples

Content type
No sample

Bulk import foreign key definitions.

Authorizations:
Bearer
Request Body schema:

Collection of foreign key definitions to import.

Array of objects or null (Dataedo.Public.Models.Public.v1.Features.InterfaceTables.Requests.ImportForeignKeyRequest)

The list of items to import. Maximum 10,000 items per request.

Array
databaseName
string or null

The name of the target database in Dataedo.

foreignTableSchema
string or null

Schema of the foreign (child) table.

foreignTableName
string or null

Name of the foreign (child) table. Required.

foreignTableObjectType
string or null

Object type of the foreign table.

primaryTableSchema
string or null

Schema of the primary (parent) table.

primaryTableName
string or null

Name of the primary (parent) table. Required.

primaryTableObjectType
string or null

Object type of the primary table.

foreignColumnName
string or null

Name of the foreign key column.

foreignColumnPath
string or null

Path of the foreign key column.

primaryColumnName
string or null

Name of the primary key column.

primaryColumnPath
string or null

Path of the primary key column.

columnPairOrder
integer or null <int32>

Order of the column pair in the foreign key.

keyName
string or null

Name of the foreign key constraint.

description
string or null

Description of the foreign key.

object or null

Custom field values.

Responses

Request samples

Content type
{
  • "items": [
    ]
}

Response samples

Content type
No sample

Get imported procedure definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

filters
string

Filtering is not implemented yet.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sorting is not implemented yet.

Responses

Response samples

Content type
No sample

Bulk import procedure/function definitions.

Authorizations:
Bearer
Request Body schema:

Collection of procedure definitions to import.

Array of objects or null (Dataedo.Public.Models.Public.v1.Features.InterfaceTables.Requests.ImportProcedureRequest)

The list of items to import. Maximum 10,000 items per request.

Array
databaseName
string or null

The name of the target database in Dataedo.

procedureSchema
string or null

Schema of the procedure.

procedureName
string or null

Name of the procedure. Required.

objectType
string or null

Object type (e.g., PROCEDURE, FUNCTION). Required.

objectSubtype
string or null

Object subtype.

functionType
string or null

Function type (for functions).

language
string or null

Programming language.

definition
string or null

SQL definition.

description
string or null

Description of the procedure.

parentObjectExternalId
string or null

External ID of the parent object.

parentObjectSchema
string or null

Schema of the parent object.

parentObjectName
string or null

Name of the parent object.

parentObjectType
string or null

Type of the parent object.

linkedSourceExternalId
string or null

External ID of the linked source.

linkedSourceName
string or null

Name of the linked source.

dbmsCreated
string or null <date-time>

Date when the object was created in the DBMS.

dbmsLastModified
string or null <date-time>

Date when the object was last modified in the DBMS.

object or null

Custom field values.

Responses

Request samples

Content type
{
  • "items": [
    ]
}

Response samples

Content type
No sample

Get imported parameter definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

filters
string

Filtering is not implemented yet.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sorting is not implemented yet.

Responses

Response samples

Content type
No sample

Bulk import parameter definitions.

Authorizations:
Bearer
Request Body schema:

Collection of parameter definitions to import.

Array of objects or null (Dataedo.Public.Models.Public.v1.Features.InterfaceTables.Requests.ImportParameterRequest)

The list of items to import. Maximum 10,000 items per request.

Array
databaseName
string or null

The name of the target database in Dataedo.

objectExternalId
string or null

External ID of the parent object (procedure/function).

objectSchema
string or null

Schema of the parent object.

objectName
string or null

Name of the parent object. Required.

objectObjectType
string or null

Object type of the parent.

parameterName
string or null

Name of the parameter. Required.

ordinalPosition
integer or null <int32>

Ordinal position of the parameter.

parameterMode
string or null

Parameter mode (e.g., IN, OUT, INOUT).

datatype
string or null

Data type of the parameter.

dataLength
string or null

Data length or precision.

description
string or null

Description of the parameter.

object or null

Custom field values.

Responses

Request samples

Content type
{
  • "items": [
    ]
}

Response samples

Content type
No sample

Get imported trigger definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

filters
string

Filtering is not implemented yet.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sorting is not implemented yet.

Responses

Response samples

Content type
No sample

Bulk import trigger definitions.

Authorizations:
Bearer
Request Body schema:

Collection of trigger definitions to import.

Array of objects or null (Dataedo.Public.Models.Public.v1.Features.InterfaceTables.Requests.ImportTriggerRequest)

The list of items to import. Maximum 10,000 items per request.

Array
databaseName
string or null

The name of the target database in Dataedo.

tableSchema
string or null

Schema of the table containing the trigger.

tableName
string or null

Name of the table containing the trigger. Required.

tableObjectType
string or null

Object type of the table.

triggerName
string or null

Name of the trigger. Required.

triggerType
string or null

Type of the trigger.

definition
string or null

SQL definition of the trigger.

before
boolean

Whether the trigger fires before the event.

after
boolean

Whether the trigger fires after the event.

insteadOf
boolean

Whether the trigger fires instead of the event.

onInsert
boolean

Whether the trigger fires on INSERT.

onUpdate
boolean

Whether the trigger fires on UPDATE.

onDelete
boolean

Whether the trigger fires on DELETE.

disabled
boolean

Whether the trigger is disabled.

description
string or null

Description of the trigger.

object or null

Custom field values.

Responses

Request samples

Content type
{
  • "items": [
    ]
}

Response samples

Content type
No sample

Get imported report definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

filters
string

Filtering is not implemented yet.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sorting is not implemented yet.

Responses

Response samples

Content type
No sample

Bulk import report definitions.

Authorizations:
Bearer
Request Body schema:

Collection of report definitions to import.

Array of objects or null (Dataedo.Public.Models.Public.v1.Features.InterfaceTables.Requests.ImportReportRequest)

The list of items to import. Maximum 10,000 items per request.

Array
databaseName
string or null

The name of the target database in Dataedo.

externalId
string or null

External identifier of the report.

folderExternalId
string or null

External ID of the folder containing the report.

reportSchema
string or null

Schema of the report.

reportName
string or null

Name of the report. Required.

url
string or null

URL of the report.

embedUrl
string or null

Embed URL of the report.

objectType
string or null

Object type (e.g., REPORT). Required.

objectSubtype
string or null

Object subtype.

description
string or null

Description of the report.

definition
string or null

SQL definition.

location
string or null

Location of the report.

language
string or null

Programming language.

parentObjectExternalId
string or null

External ID of the parent object.

parentObjectSchema
string or null

Schema of the parent object.

parentObjectName
string or null

Name of the parent object.

parentObjectType
string or null

Type of the parent object.

dbmsCreated
string or null <date-time>

Date when the object was created in the DBMS.

dbmsLastModified
string or null <date-time>

Date when the object was last modified in the DBMS.

object or null

Custom field values.

Responses

Request samples

Content type
{
  • "items": [
    ]
}

Response samples

Content type
No sample

Get imported data lineage mappings for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

filters
string

Filtering is not implemented yet.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sorting is not implemented yet.

Responses

Response samples

Content type
No sample

Bulk import data lineage mappings.

Authorizations:
Bearer
Request Body schema:

Collection of data lineage mappings to import.

Array of objects or null (Dataedo.Public.Models.Public.v1.Features.InterfaceTables.Requests.ImportDataLineageRequest)

The list of items to import. Maximum 10,000 items per request.

Array
sourceDatabaseName
string or null

Database name of the source.

sourceDatabaseLinkedSourceExternalId
string or null

External ID of the source linked source.

sourceDatabaseLinkedSourceName
string or null

Name of the source linked source.

sourceObjectSchema
string or null

Schema of the source object.

sourceObjectName
string or null

Name of the source object.

sourceObjectExternalId
string or null

External ID of the source object.

sourceObjectType
string or null

Type of the source object.

sourceColumnName
string or null

Name of the source column.

sourceColumnExternalId
string or null

External ID of the source column.

processorDatabaseName
string or null

Database name of the processor.

processorObjectSchema
string or null

Schema of the processor object.

processorObjectName
string or null

Name of the processor object.

processorObjectExternalId
string or null

External ID of the processor object.

processorObjectType
string or null

Type of the processor object.

processorProcessName
string or null

Name of the processor process.

processorProcessExternalId
string or null

External ID of the processor process.

targetDatabaseName
string or null

Database name of the target.

targetDatabaseLinkedSourceExternalId
string or null

External ID of the target linked source.

targetDatabaseLinkedSourceName
string or null

Name of the target linked source.

targetObjectSchema
string or null

Schema of the target object.

targetObjectName
string or null

Name of the target object.

targetObjectExternalId
string or null

External ID of the target object.

targetObjectType
string or null

Type of the target object.

targetColumnName
string or null

Name of the target column.

targetColumnExternalId
string or null

External ID of the target column.

script
string or null

SQL script associated with the lineage.

dbmsCreated
string or null <date-time>

Date when the lineage was created in the DBMS.

dbmsLastModified
string or null <date-time>

Date when the lineage was last modified in the DBMS.

transformation
string or null

Transformation description.

lineFrom
integer or null <int32>

Starting line number in the script.

lineTo
integer or null <int32>

Ending line number in the script.

charFrom
integer or null <int32>

Starting character position.

charTo
integer or null <int32>

Ending character position.

indexFrom
integer or null <int32>

Starting index.

indexTo
integer or null <int32>

Ending index.

isDirect
boolean or null

Whether this is a direct lineage mapping.

description
string or null

Description of the lineage.

object or null

Custom field values.

Responses

Request samples

Content type
{
  • "items": [
    ]
}

Response samples

Content type
No sample

Get imported data lineage process definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

filters
string

Filtering is not implemented yet.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sorting is not implemented yet.

Responses

Response samples

Content type
No sample

Bulk import data lineage process definitions.

Authorizations:
Bearer
Request Body schema:

Collection of data lineage process definitions to import.

Array of objects or null (Dataedo.Public.Models.Public.v1.Features.InterfaceTables.Requests.ImportDataLineageProcessRequest)

The list of items to import. Maximum 10,000 items per request.

Array
processorDatabaseName
string or null

Database name of the processor.

processorObjectSchema
string or null

Schema of the processor object.

processorObjectName
string or null

Name of the processor object.

processorObjectExternalId
string or null

External ID of the processor object.

processorObjectType
string or null

Type of the processor object.

processorProcessName
string or null

Name of the process.

processorProcessExternalId
string or null

External ID of the process.

description
string or null

Description of the process.

language
string or null

Programming language.

script
string or null

SQL script of the process.

linkedSourceId
integer or null <int32>

Linked source ID.

dbmsCreated
string or null <date-time>

Date when the process was created in the DBMS.

dbmsLastModified
string or null <date-time>

Date when the process was last modified in the DBMS.

processOrder
integer or null <int32>

Execution order of the process.

Responses

Request samples

Content type
{
  • "items": [
    ]
}

Response samples

Content type
No sample

Get imported linked source definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

filters
string

Filtering is not implemented yet.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sorting is not implemented yet.

Responses

Response samples

Content type
No sample

Bulk import linked source definitions.

Authorizations:
Bearer
Request Body schema:

Collection of linked source definitions to import.

Array of objects or null (Dataedo.Public.Models.Public.v1.Features.InterfaceTables.Requests.ImportLinkedSourceRequest)

The list of items to import. Maximum 10,000 items per request.

Array
databaseName
string or null

The name of the target database in Dataedo.

sourceDatabaseId
integer or null <int32>

Source database ID.

externalId
string or null

External identifier of the linked source.

linkedSourceName
string or null

Name of the linked source. Required.

connectionDetails
string or null

Connection details for the linked source.

sqlDialect
string or null

SQL dialect used by the linked source.

defaultSchema
string or null

Default schema for the linked source.

description
string or null

Description of the linked source.

dbmsCreated
string or null <date-time>

Date when the linked source was created in the DBMS.

dbmsLastModified
string or null <date-time>

Date when the linked source was last modified in the DBMS.

object or null

Custom field values.

Responses

Request samples

Content type
{
  • "items": [
    ]
}

Response samples

Content type
No sample

Get imported linked source configuration definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

filters
string

Filtering is not implemented yet.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sorting is not implemented yet.

Responses

Response samples

Content type
No sample

Bulk import linked source configuration definitions.

Authorizations:
Bearer
Request Body schema:

Collection of linked source configuration definitions to import.

Array of objects or null (Dataedo.Public.Models.Public.v1.Features.InterfaceTables.Requests.ImportLinkedSourceConfigurationRequest)

The list of items to import. Maximum 10,000 items per request.

Array
databaseName
string or null

The name of the target database in Dataedo.

linkedSourceName
string or null

Name of the linked source.

linkedSourceExternalId
string or null

External identifier of the linked source.

sourceDatabaseId
integer <int32>

Identifier of the source database.

Responses

Request samples

Content type
{
  • "items": [
    ]
}

Response samples

Content type
No sample

Get import errors.

Returns a list of all import errors across all databases.

Authorizations:
Bearer
query Parameters
filters
string

Filtering is not implemented yet.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sorting is not implemented yet.

Responses

Response samples

Content type
No sample

Delete all import data for a database.

Deletes all rows from all import tables for the specified database name.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database whose import data should be deleted.

Responses

Delete imported table definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

Responses

Delete imported column definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

Responses

Delete imported key definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

Responses

Delete imported foreign key definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

Responses

Delete imported procedure definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

Responses

Delete imported parameter definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

Responses

Delete imported trigger definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

Responses

Delete imported report definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

Responses

Delete imported data lineage mappings for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

Responses

Delete imported data lineage process definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

Responses

Delete imported linked source definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

Responses

Delete imported linked source configuration definitions for a database.

Authorizations:
Bearer
query Parameters
databaseName
required
string

Name of the database.

Responses

Delete all import error records.

Deletes all rows from the import errors table.

Authorizations:
Bearer

Responses

OpenLineageV1

Creates an OpenLineage run event.

This endpoint allows sending OpenLineage events to track data lineage.

Authorizations:
Bearer
Request Body schema:

The OpenLineage event data

object (Dataedo.Public.Models.Public.v1.Features.OpenLineage.Job)
object (Dataedo.Public.Models.Public.v1.Features.OpenLineage.Run)
eventTime
string or null <date-time>
eventType
string or null
producer
string or null
schemaURL
string or null
Array of objects or null (Dataedo.Public.Models.Public.v1.Features.OpenLineage.Input)
Array of objects or null (Dataedo.Public.Models.Public.v1.Features.OpenLineage.Output)

Responses

Request samples

Content type
{
  • "job": {},
  • "run": {
    },
  • "eventTime": "2019-08-24T14:15:22Z",
  • "eventType": "string",
  • "producer": "string",
  • "schemaURL": "string",
  • "inputs": [
    ],
  • "outputs": [
    ]
}

Response samples

Content type
No sample

ProgramsV1

Finds program simple data by Id.

Returns a single program base data by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the program stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds program detailed data by Id.

Returns a single program detailed data by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The ID of the program stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds program domains by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the program stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds program areas by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the program stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds program linked glossary entries by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the program stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds parameters by program Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the program stored in the Dataedo repository.

query Parameters
filters
string

Filtering parameters list is not implemented yet.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sorting parameters list is not implemented yet.

Responses

Response samples

Content type
No sample

This method is used to update the title of the program by Id.

Updates title of a single program by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the program stored in the Dataedo repository.

Request Body schema:
required
title
string or null

Responses

Request samples

Content type
{
  • "title": "string"
}

Gets program custom fields by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the program stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Update program custom fields.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the program stored in the Dataedo repository.

Request Body schema:
required
Array of objects or null (Dataedo.Public.Models.Public.v1.Features.CustomFields.CustomFieldInfo)
Array
name
string or null

Custom field name.

value
string or null

Custom field value in specific to custom field definition format.

Responses

Request samples

Content type
{
  • "fields": [
    ]
}

ReportsV1

Finds a report simple data by Id.

Returns a single report base data by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the report stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds report detailed data by Id.

Returns a single report detailed data by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the report stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds report domains by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the report stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds report areas by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the report stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds report linked glossary entries by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the report stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Finds parameters by report Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the report stored in the Dataedo repository.

query Parameters
filters
string

Filtering parameters list is not implemented yet.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

sorts
string

Sorting parameters list is not implemented yet.

Responses

Response samples

Content type
No sample

Finds report columns by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the report stored in the Dataedo repository.

query Parameters
filters
string

Title filter example: "title==Dataedo Repository". Available filtering logic: title, name, description, ordinalPosition, dataType, status.

sorts
string

Sort parameters. To sort by title ascending, write 'ordinalPosition'. To sort descending, write '-ordinalPosition'. Available sorting logic: ordinalPosition, dataType, status.

page
integer <int32>

Page number.

pageSize
integer <int32>

Items per page.

Responses

Response samples

Content type
No sample

Updates the title of the report by Id.

Updates title of a single report by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the report stored in the Dataedo repository.

Request Body schema:
required
title
string or null

Responses

Request samples

Content type
{
  • "title": "string"
}

Gets report custom fields by Id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the report stored in the Dataedo repository.

Responses

Response samples

Content type
No sample

Update report custom fields.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the report stored in the Dataedo repository.

Request Body schema:
required
Array of objects or null (Dataedo.Public.Models.Public.v1.Features.CustomFields.CustomFieldInfo)
Array
name
string or null

Custom field name.

value
string or null

Custom field value in specific to custom field definition format.

Responses

Request samples

Content type
{
  • "fields": [
    ]
}

SchedulerV1

Gets all scheduler tasks.

Returns a list of all scheduler tasks.

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

Triggers a scheduler task.

Triggers a scheduler task by Id.

Authorizations:
Bearer
path Parameters
taskId
required
integer <int32>

Responses

Gets a scheduler execution by Id.

Authorizations:
Bearer
path Parameters
executionId
required
integer <int32>

Responses

Response samples

Content type
No sample

UserGroupsV1

Gets user groups list.

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

UsersV1

Gets users list.

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

Gets deleted users list.

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

Gets users list by user group ID.

Authorizations:
Bearer
path Parameters
userGroupId
required
integer <int32>

The user group ID to filter users by.

Responses

Response samples

Content type
No sample

Adds a new user.

Authorizations:
Bearer
Request Body schema:

The user data to create.

login
string or null
source
string or null
displayName
string or null
externalId
string or null

Responses

Request samples

Content type
{
  • "login": "string",
  • "source": "string",
  • "displayName": "string",
  • "externalId": "string"
}

Response samples

Content type
No sample

Updates an existing user.

Authorizations:
Bearer
Request Body schema:

The user data to update.

userId
integer <int32>
login
string or null
source
string or null
displayName
string or null
externalId
string or null
email
string or null

Responses

Request samples

Content type
{
  • "userId": 0,
  • "login": "string",
  • "source": "string",
  • "displayName": "string",
  • "externalId": "string",
  • "email": "string"
}

Response samples

Content type
No sample

Deletes a user by ID.

Authorizations:
Bearer
path Parameters
userId
required
integer <int32>

The ID of the user to delete.

Responses

Response samples

Content type
No sample

Restores a deleted user by ID.

Authorizations:
Bearer
path Parameters
userId
required
integer <int32>

The ID of the user to restore.

Responses

Response samples

Content type
No sample

Assigns a user group to a user.

Authorizations:
Bearer
Request Body schema:
userId
integer <int32>
userGroupId
integer <int32>

Responses

Request samples

Content type
{
  • "userId": 0,
  • "userGroupId": 0
}

Response samples

Content type
No sample

Unassigns a user group from a user.

Authorizations:
Bearer
Request Body schema:

The ID of the user to unassign the group from.

userId
integer <int32>
userGroupId
integer <int32>

Responses

Request samples

Content type
{
  • "userId": 0,
  • "userGroupId": 0
}

Response samples

Content type
No sample

WorkflowStatusesV1

Returns workflow status list.

Returns workflow status list.

Authorizations:
Bearer

Responses

Response samples

Content type
No sample