Each table has a number of columns where the users can add multiple columns, get column by Id and get columns by table using the following APIs:
1. Save Column
The Save Column API requires a column object as a request body that returns the column object.
Mandatory Fields: columnType, connectionName, schemaId, schemaName, businessDescription, technicalDescription, tableId, tableName, columnId, columnName, title, connectionId.
| Method | Url |
| SaveColumn | /api/column |
Request Body
[
{
"active": 0,
"businessDescription": "string",
"columnComment": "string",
"columnId": 0,
"columnLength": 0,
"columnName": "string",
"columnPosition": 0,
"columnType": "string",
"connectionId": 0,
"customFields": {},
"distinctCount": 0,
"domain": "string",
"glossaryName": "string",
"lastMetaSyncDate": "string",
"mask": 0,
"maxvalue": "string",
"minValue": "string",
"nullCount": 0,
"restricted": 0,
"schemaName": "string",
"tableId": 0,
"tableName": "string",
"tagName": "string",
"technicalDescription": "string",
"title": "string",
"topValues": "string"
}
]
Response
{
"status": true,
"statusCode": "Tag assigned to object :43451",
"statusMsg": "",
"response": {
"logsList": [
"Added new column : New Column From API for Table : 4648",
"string already exist and Tag assigned to object :43451"
],
"TagsLogs": [
"string already exist and Tag assigned to object :43451"
],
"columns": [
{
"columnId": 43451,
"columnName": "New Column From API",
"title": "string",
"columnType": "string",
"minValue": "string",
"maxvalue": "string",
"columnLength": 0,
"mask": 0,
"restricted": 0,
"tableId": 4648,
"tableName": "NewTableFromAPI",
"schemaName": "manual",
"connectionId": 1032,
"active": 1,
"columnComment": null,
"nullCount": 0,
"distinctCount": 0,
"topValues": "string",
"columnPosition": 1,
"lastMetaSyncDate": null,
"businessDescription": "string",
"technicalDescription": null,
"customFields": null,
"tagName": null,
"domain": null,
"glossaryName": null
}
]
}
}
2. Get Column
The Get Column API requires column id as mandatory that returns respective column details as mentioned below:
Mandatory Fields: columnId.
| Method | Url | Parameter |
| getColumn | /api/column/{columnId} | {columnId} |
Response
{
"status": true,
"statusCode": "",
"statusMsg": "",
"response": {
"column": {
"columnId": 5646,
"columnName": "A-Rated",
"title": "A-Rated",
"columnType": "TEXT",
"minValue": "No",
"maxvalue": "Yes",
"columnLength": 16777216,
"mask": 0,
"restricted": 0,
"tableId": 1309,
"tableName": null,
"schemaName": null,
"connectionId": 0,
"active": 1,
"columnComment": "A-Rated",
"nullCount": 0,
"distinctCount": 2,
"topValues": "{\"No\":65,\"Yes\":9935}",
"columnPosition": 11,
"lastMetaSyncDate": "2021-03-10 16:27:07.0",
"businessDescription": null,
"technicalDescription": null,
"customFields": {},
"tagName": null,
"domain": null,
"glossaryName": ""
}
}
}
3. Deactivate Column
The Deactivate Column API requires the column as the parameter that returns the response message as successfully deactivated.
Mandatory Fields: columnId.
| Method | Url | Parameter |
| deActivateColumn | /api/column/{columnId} | {columnId} |
Response
{
"status": true,
"statusCode": "",
"statusMsg": "",
"response": {
"msg": "Successfully deactivated column with id = 43451, Column Name = New Column From API"
}
}
4. Add Business And Technical Description using column Id
This API updates business and technical descriptions for the given column Id.
Mandatory Fields: columnId.
| Method | Url |
| addBusinessAndTechnicalDescription | /api/column/{columnId}/description |
Request Body
{
"businessDescription": "string",
"isEncodedText": true,
"technicalDescription": "string"
}
Example
{
"businessDescription": "Updated business description",
“isEncodedText”:”false”,
"technicalDescription": "Updated Technical Description"
}
Response Body
{
"status": true,
"statusCode": "Successfully updated given descriptions",
"statusMsg": "",
"response": {}
}
5. Add Custom Field for Table Column Using ColumnID
This API is used to update the value of custom fields of a Table Column by providing the columnId and customFieldsForColumn as parameters for the existing custom field definitions which are present for that particular column. We can add the custom field values only for the editable custom field definitions.
Mandatory Fields: columnId, customFields.
|
Method |
Url |
parameters |
|
addCustomFieldsForTableColumn |
/api/column/{columnId}/fields/add |
customFieldsForColumn, columnId |
Sample Request Body
columnId *: 1111
customFieldsForColumn * :
{
"customFields": {"tcf1":"tcf1_check"}
}
Response body sample output
{
"status": true,
"statusCode": "Custom objects are saved successfully",
"statusMsg": "",
"response": {}
}
6. Add Custom Fields for Table Column using Names
This API is used to update the value of custom fields of a Table Column by providing the columnName, connectionName, customFields, schemaName and tableName as parameters for the existing custom field definitions which are present for that particular column. We can add the custom field values only for the editable custom field definitions.
Mandatory Field: columnName, customFields, connectionName, schemaName, tableName
|
Method |
Url |
parameters |
|
addCustomFieldsForTableColumn |
customFieldsForTableColumns |
Sample Request Body
{
"columnName": "Address",
"connectionName": "SQL_LINEAGE",
"customFields": {"tcf1":"Pranitha"},
"schemaName": "dbo",
"tableName": "1_t_2_csv"
}
Response body sample output:
{
"status": true,
"statusCode": "Custom objects are saved successfully",
"statusMsg": "",
"response": {}
}
Response:
{
"response": {},
"status": true,
"statusCode": "string",
"statusMsg": "string"
}
7. Add Business and Technical Description using the column name
This API updates business and technical descriptions for the given column.
Mandatory Fields: connectionName, schemaName, tableName, columnName
| Method | Url |
| addBusinessAndTechnicalDescription | //api/column/description/add |
Request Body
[
{
"businessDescription": "string",
"columnName": "string",
"connectionName": "string",
"isEncodedText": true,
"schemaName": "string",
"tableName": "string",
"technicalDescription": "string"
}
]
Example
[
{
"businessDescription": "BD",
"columnName": "tablename",
"connectionName": "mysql",
"schemaName": "ovaledgedb",
"tableName": "oetable",
"technicalDescription": "TD"
}
]
Response Body
{
"status": true,
"statusCode": "Successfully updated given descriptions",
"statusMsg": "",
"response": {}
}
8. Get Table Columns
The Get Table Columns method requires tableId as a parameter and that return response as a list of column objects.
Mandatory Fields: tableId
| Method | Url | Parameter |
| getTableColumns | /api/table/{tableId}/columns | tableId |
Response
{
"status": true,
"statusCode": "",
"statusMsg": "",
"response": {
"columns": [
{
"columnId": 5646,
"columnName": "A-Rated",
"title": "A-Rated",
"columnType": "TEXT",
"minValue": "No",
"maxvalue": "Yes",
"columnLength": 16777216,
"mask": 0,
"restricted": 0,
"tableId": 1309,
"tableName": "ACA_FEDERAL_UPPER_LIMITS",
"schemaName": "HEALTHCARE.REPORTS",
"connectionId": 1001,
"active": 1,
"columnComment": "A-Rated",
"nullCount": 0,
"distinctCount": 2,
"topValues": "{\"No\":65,\"Yes\":9935}",
"columnPosition": 11,
"lastMetaSyncDate": "2021-03-10 16:27:07.0",
"businessDescription": null,
"technicalDescription": null,
"customFields": {},
"tagName": null,
"domain": null,
"glossaryName": ""
}
]
}
}
9. Get Table Columns By Name
Mandatory Field: connectionName, schemaName, tableName.
| Method | Url | Parameter |
| getTableColumnsbyName | /api/column/getTableColumnsByName | connectionName, schemaName, tableName |
Response
{
"status": true,
"statusCode": "",
"statusMsg": "",
"response": {
"table": [
{
"table": {
"tableId": 1775,
"tableName": "test",
"description": "test",
"lastPopulatedDate": "",
"schemaId": 1047,
"schemaName": "sample",
"connectionId": 1007,
"connectionName": "postgresql-M",
"rowCount": 0,
"totalColumns": 0,
"active": 1,
"type": "TABLE",
"tablestats": [],
"analyzedstatus": "Not Profiled",
"businessDescription": null,
"techinalDescription": null,
"customFields": {},
"termList": [],
"tagNameList": null,
"owner": "admin",
"steward": "admin",
"notify": 0,
"lastModDate": "2022-02-18 22:42:26.0",
"governanceRoles": {}
},
"columns": []
}
]
}
}