As part of this release, new APIs are introduced along with modifications to existing APIs, which enhance current functionality and improve usability.
New APIs
- Business Glossary API
GET /api/businessglossary/domain/getBusinessTermsDomainWise
In the Business Glossary APIs, a new GET request (/api/businessglossary/domain/getBusinessTermsDomainWise) is introduced to fetch the details of the terms based on domain types. - Custom Fields API
POST /api/addCustomFields
In the Custom Fields APIs, a new POST (/api/addCustomFields) is introduced to add a custom field for an object by providing the object name and object type. - Security API
GET /api/fetchUserPrivilegesOnObject
In the Security APIs, a new GET request (/api/fetchUserPrivilegesOnObject) is introduced to fetch a user's permissions on a particular object.
Modified APIs
The term ‘Connection’, which refers to the connectivity to a source data system for crawling and profiling metadata has been changed to ‘Connector’. This change has been reflected in all the APIs that use connector as a parameter.
Column API
- GET /api/column/getTableColumnsByName
Change: GET parameter connectionname -> connectorname - POST /api/column
Change: Request body parameter connectionid -> connectorid
Change: Request body parameter connection name -> connectorname - POST /api/column/fields/add
Change: Response body parameter connectionname -> connectorname - POST /api/column/description/add
Change: Response body parameter connectionname -> connectorname
Custom Fields API
- GET /api/getdefinedcustomfields
Change: GET parameter connection/domainId -> connectorOrDomainId
File API
- GET /api/file
Change: Request Body parameter connectionid -> connectorid
Change: Request Body parameter connectionname -> connectorname - GET /api/file/catalogandprofilefile
Change: Request Body parameter connectionid -> connectorid
File Column API
- POST /api/filecolumn
Change: POST parameter connectionid -> connectorid
File Folder API
- POST /api/filefolder
Change: POST parameter connectionid -> connectorid - GET /api/connector/{connectorid}/filefolders
Change: GET parameter connectionId -> connectorId - GET /api/connector/{connectorid}/filefolder
Change: API name from /connection/{connectionid}/filefolder to /connector/{connectorid}/filefolder
Change: GET parameter connectionId -> connectorId
Governance Roles API
- POST /api/updategovernanceroles
Change: Response Body parameter connectionname -> connectorname
Impact Analysis API
- POST /api/job/submitcustombatchforimpactanalysis
Change: Response Body parameter connectionname -> connectorname
Lineage API
- POST /api/insertLineage
Change: Response Body parameter refconnectionid -> refconnectorid - POST /api/insertLineageWithNames
Change: Response Body parameters refconnectionname -> refconnectorname, sourceconnectioname -> sourceconnectorname, targetconnection -> targetconnectorname - GET /api/lineagegraphwithnames
Change: GET Paramater connectionname -> connectorname - GET /api/lineageColumnGraphWithNames
Change: GET Paramater connectionname -> connectorname
Query API
- POST /api/query/update
Change: Response Body parameters connectionname -> connectorname, connectionid -> connectorid - POST /api/query/getqueryresults
Change: Response Body parameters connectionname -> connectorname, connectionid -> connectorid - POST /api/query/add
Change: Response Body parameters connectionname -> connectorname, connectionid -> connectorid
Report API
- POST /api/report
Change: Response Body parameters connectionname -> connectorname, connectionid -> connectorid
Connector API
- GET /api/connectors/all
Change: The API name connections/all is changed to connectors/all. - POST /api/connector/updatepassword
Change: The API name /connection/updatepassword is changed to /connector/updatepassword.
Change: The response body parameter connectionid is changed to connectorid. - POST /api/connector/saveconnector
Change: The API name /connection/saveconnection is changed to /connector/saveconnector.
Change: The response body parameter connectionparamlist is changed to connectorparamlist. - POST /api/connector/crawlerandprofilerules
Change: The API name is changed from /connection/crawlerandprofilerules to /connector/crawlerandprofilerules.
Change: The response body parameters connectionid and connectionname are changed to connectorid and connectorname, respectively. - GET /api/connector/{connectorid}
Change: The API name connection/{connectionid} is changed to connector/{connectorid}. - GET /api/connector/getconnectorparam
Change: The API name connection/getconnectionparam is changed to connector/getconnectorparam.
Report Column API
- POST /api/reportcolumn
Change: Response Body parameters connectionname -> connectorname, connectionid -> connectorid
Report Group API
- GET /api/reportgroup
Change: GET Paramater connectionid -> connectorid - POST /api/reportgroup
Change: Request body parameters connectionname -> connectorname, connectionid -> connectorid
Schema API
- GET /api/schema
Change: Response Body parameters connectionname -> connectorname, connectionid -> connectorid - POST /api/schema/description/add
Change: Response Body parameters connectionname -> connectorname, connectionid -> connectorid - POST /api/jobs/crawl/schema/new
Change: Response Body parameters connectionname -> connectorname, connectionid -> connectorid - POST /api/jobs/crawl/schema/existing
Change: Response Body parameters connectionname -> connectorname, connectionid -> connectorid - GET /api/connector/{connectorid}/schemas
Change: GET Parameter connectionname -> connectorname
Security API
- POST /api/security/roles/users/updateuserrolemappings
Change: Parameter connectionname -> connectorname - PUT /api/security/role/update{roleid}
Change: Parameter connectionname -> connectorname - POST /api/security/role/add
Change: Response Body parameter connectionname -> connectorname
Table API
- POST /api/table
Change: Response Body parameters connectionname -> connectorname, connectionid -> connectorid - POST /api/table/schemacompare
Change: Response Body parameters connectionname -> connectorname, connectionid -> connectorid - POST /api/table/saveprofileinfo
Change: Response Body parameters connectionname ->
connectorname, connectionid -> connectorid - POST /api/table/fields/add
Change: Request body parameter connectionname -> connectorname - POST /api/table/description/add
Change: Request body parameter connectionname -> connectorname - POST /api/table/tablewithname
Change: GET parameter connectionname -> connectorname
Business Glossary API
- POST /api/term/addterm
Change: Request body parameters connectionname -> connectorname, connectionid -> connectorid
Please note that the provided information includes the changes made in the API endpoints, request body parameters, and response body parameters in Release6.0.2.
Copyright © 2023, OvalEdge LLC, Peachtree Corners, GA USA