Public API v1 (3.0.0)

Support: [email protected] License: Dataedo License

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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:
application/json

The title of a single area.

title

string or null

Responses

Request samples

Payload

Content type

application/json

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

200

Content type

text/plain

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:
application/json
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

Payload

Content type

application/json

{"fields": [{"name": "field1",
"value": "2023-10-15T14:30:00Z"
}
]
}

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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:
application/json
required

description

string or null

Responses

Request samples

Payload

Content type

application/json

{"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:
application/json
required

title

string or null

Responses

Request samples

Payload

Content type

application/json

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

200

Content type

text/plain

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:
application/json
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

Payload

Content type

application/json

{"fields": [{"name": "field1",
"value": "2023-10-15T14:30:00Z"
}
]
}

CustomFieldsV1

Gets definition of custom fields.

Returns custom field definitions.

Authorizations:

Bearer

Responses

Response samples

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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:
application/json
required

title

string or null

Responses

Request samples

Payload

Content type

application/json

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

200

Content type

text/plain

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:
application/json
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

Payload

Content type

application/json

{"fields": [{"name": "field1",
"value": "2023-10-15T14:30:00Z"
}
]
}

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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:
application/json
required

title

string or null

Responses

Request samples

Payload

Content type

application/json

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

200

Content type

text/plain

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:
application/json
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

Payload

Content type

application/json

{"fields": [{"name": "field1",
"value": "2023-10-15T14:30:00Z"
}
]
}

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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:
application/json
required

title

string or null

Responses

Request samples

Payload

Content type

application/json

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

200

Content type

text/plain

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:
application/json
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

Payload

Content type

application/json

{"fields": [{"name": "field1",
"value": "2023-10-15T14:30:00Z"
}
]
}

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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:
application/json
required

title

string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string"
}

Creates a new glossary entry.

Authorizations:

Bearer

Request Body schema:
application/json
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

Payload

Content type

application/json

{"title": "string",
"parentId": 0,
"glossaryId": 0,
"typeId": 0,
"workflowStatusId": 0,
"description": "string",
"customFields": {"property1": "string",
"property2": "string"
}
}

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

200

Content type

text/plain

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:
application/json
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

Payload

Content type

application/json

{"fields": [{"name": "field1",
"value": "2023-10-15T14:30:00Z"
}
]
}

GlossaryEntryTypesV1

Gets glossary entry types.

Returns glossary entry types.

Authorizations:

Bearer

Responses

Response samples

200

Content type

text/plain

No sample

OpenLineageV1

Creates an OpenLineage run event.

This endpoint allows sending OpenLineage events to track data lineage.

Authorizations:

Bearer

Request Body schema:
application/json

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

Payload

Content type

application/json

{"job": {"namespace": "string",
"name": "string",
"facets": {"jobType": {"_producer": "http://example.com",
"_schemaURL": "http://example.com",
"integration": "string",
"jobType": "string",
"processingType": "string"
},
"sql": {"_producer": "http://example.com",
"_schemaURL": "http://example.com",
"query": "string"
}
}
},
"run": {"runId": "string"
},
"eventTime": "2019-08-24T14:15:22Z",
"eventType": "string",
"producer": "string",
"schemaURL": "string",
"inputs": [{"facets": {"schema": {"_producer": "string",
"_schemaURL": "string",
"fields": [{"name": "string",
"type": "string",
"fields": [{ }
]
}
]
}
},
"namespace": "string",
"name": "string"
}
],
"outputs": [{"facets": {"columnLineage": {"_producer": "string",
"_schemaURL": "string",
"fields": {"property1": {"inputFields": [{"field": "string",
"name": "string",
"namespace": "string"
}
],
"transformationDescription": "string",
"transformationType": "string"
},
"property2": {"inputFields": [{"field": "string",
"name": "string",
"namespace": "string"
}
],
"transformationDescription": "string",
"transformationType": "string"
}
}
},
"schema": {"_producer": "string",
"_schemaURL": "string",
"fields": [{"name": "string",
"type": "string",
"fields": [{ }
]
}
]
}
},
"name": "string",
"namespace": "string"
}
]
}

Response samples

201
400

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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:
application/json
required

title

string or null

Responses

Request samples

Payload

Content type

application/json

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

200

Content type

text/plain

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:
application/json
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

Payload

Content type

application/json

{"fields": [{"name": "field1",
"value": "2023-10-15T14:30:00Z"
}
]
}

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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

200

Content type

text/plain

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:
application/json
required

title

string or null

Responses

Request samples

Payload

Content type

application/json

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

200

Content type

text/plain

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:
application/json
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

Payload

Content type

application/json

{"fields": [{"name": "field1",
"value": "2023-10-15T14:30:00Z"
}
]
}

SchedulerV1

Gets all scheduler tasks.

Returns a list of all scheduler tasks.

Authorizations:

Bearer

Responses

Response samples

200

Content type

text/plain

No sample

Triggers a scheduler task.

Triggers a scheduler task by Id.

Authorizations:

Bearer

path Parameters

taskId

required

integer <int32>

Responses

WorkflowStatusesV1

Returns workflow status list.

Authorizations:

Bearer

Responses

Response samples

200

Content type

text/plain

No sample

Public API v1 (3.0.0)

AreasV1

Finds area simple data by Id.

Authorizations:

path Parameters

Responses

Response samples

Finds area detailed data by Id.

Authorizations:

path Parameters

Responses

Response samples

Finds a list of links for the area by Id.

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Updates the title of the area by Id.

Authorizations:

path Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/json

Responses

Request samples

Gets area custom fields by Id.

Authorizations:

path Parameters

Responses

Response samples

Update area custom fields.

Authorizations:

path Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/jsonrequired

Responses

Request samples

ColumnsV1

Finds column simple data by Id.

Authorizations:

path Parameters

Responses

Response samples

Finds column detailed data by Id.

Authorizations:

path Parameters

Responses

Response samples

Finds column entity linked glossary entries by Id.

Authorizations:

path Parameters

Responses

Response samples

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

Authorizations:

path Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/jsonrequired

Responses

Request samples

Updates the title of the column by Id.

Authorizations:

path Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/jsonrequired

Responses

Request samples

Gets column custom fields by Id.

Authorizations:

path Parameters

Responses

Response samples

Update column custom fields.

Authorizations:

path Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/jsonrequired

Responses

Request samples

CustomFieldsV1

Gets definition of custom fields.

Authorizations:

Responses

Response samples

DataSetsV1

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required