Fabric provides out-of-the-box Web Service APIs for querying a project's Catalog.
Any web service call passes authentication and authorization processes before being executed. For more information - see here.
All APIs are accessed over HTTPS, from the Fabric URL endpoint https://<Domain Name>:<PORT>
GET /api/catalog/start-crawler-job
The API invokes the DISCOVERY_CRAWLER job for a given interface.
Example of an API call:
https://localhost:3213/api/catalog/start-crawler-job?dataPlatform=CRM_DB
GET /api/catalog
The API retrieves a list of the Catalog's versions and their creations' timestamp.
Example of an API call:
https://localhost:3213/api/catalog
GET /api/catalog/{version}
The API retrieves a list of data platforms that belong to a given Catalog version. Each data platform is retrieved with the contains relations to its respective schema nodes.
The API has 2 modes - view and compare - that are interchangeably invoked based on the version input parameter, as explained below:
Examples of an API call in view mode:
https://localhost:3213/api/catalog/latest
https://localhost:3213/api/catalog/latest
Examples of an API call in compare mode:
https://localhost:3213/api/catalog/2...5
https://localhost:3213/api/catalog/1...latest
GET /api/catalog/{version}/{dataPlatform}
The API retrieves a list of schemas that belong to the specified Catalog version and data platform. Each schema is retrieved with the contains relations to its respective dataset nodes.
The API has 2 modes - view and compare - that are interchangeably invoked based on the version input parameter, as explained below:
Examples of an API call in the view mode:
https://localhost:3213/api/catalog/latest/CRM_DB
https://localhost:3213/api/catalog/1/CRM_DB
Examples of an API call in the compare mode:
https://localhost:3213/api/catalog/1...5/CRM_DB
https://localhost:3213/api/catalog/1...latest/CRM_DB
GET /api/catalog/{version}/{dataPlatform}/{schema}
The API retrieves all elements that belong to the specified Catalog version, data platform and schema. The elements include the datasets, fields and their properties, and the refersTo relations between the dataset nodes.
The API has 2 modes - view and compare - that are interchangeably invoked based on the version input parameter, as explained below:
Examples of an API call in the view mode:
https://localhost:3213/api/catalog/latest/CRM_DB/main
https://localhost:3213/api/catalog/1/CRM_DB/main
Examples of an API call in the compare mode:
https://localhost:3213/api/catalog/1...5/CRM_DB/main
https://localhost:3213/api/catalog/1...latest/CRM_DB/main
POST /api/catalog/{version}/build-catalog-artifacts
The API builds the Catalog artifacts, based on a given version. An artifact includes the details of all Catalog fields with their properties, such as Classification and PII. The artifact is created in a CSV format, saved into the Implementation/SharedObjects/Interfaces/Discovery/MTable
folder of the Project tree and is uploaded to the Fabric memory as an MTable.
Example of an API call:
https://localhost:3213/api/catalog/4/build-catalog-artifacts
POST /api/catalog/{version}/search-graph
The API retrieves all elements that belong to the specified Catalog version, based on the search criteria defined in the request body.
The syntax of the request body definition is as follows:
input is an array of keywords
type defines which object types will be searched
advanced includes a list of additional search parameters, such as:
At least one of the search parameters must be provided in the request body.
Example of an API call:
https://localhost:3213/api/catalog/4/search-graph
Examples of the request body:
Example 1: When searching for Data Platform and Schema nodes, whose name includes a customer keyword, the request body is:
{
"input": [
"customer"
],
"type": [
"dataPlatform",
"schema"
],
"advanced": {
}
}
Example 2: When searching for any node types with PII = true and Classification = EMAIL properties, the request body is:
{
"input": [],
"type": [],
"advanced": {
"pii": "true",
"classification": "EMAIL"
}
}
Fabric provides out-of-the-box Web Service APIs for querying a project's Catalog.
Any web service call passes authentication and authorization processes before being executed. For more information - see here.
All APIs are accessed over HTTPS, from the Fabric URL endpoint https://<Domain Name>:<PORT>
GET /api/catalog/start-crawler-job
The API invokes the DISCOVERY_CRAWLER job for a given interface.
Example of an API call:
https://localhost:3213/api/catalog/start-crawler-job?dataPlatform=CRM_DB
GET /api/catalog
The API retrieves a list of the Catalog's versions and their creations' timestamp.
Example of an API call:
https://localhost:3213/api/catalog
GET /api/catalog/{version}
The API retrieves a list of data platforms that belong to a given Catalog version. Each data platform is retrieved with the contains relations to its respective schema nodes.
The API has 2 modes - view and compare - that are interchangeably invoked based on the version input parameter, as explained below:
Examples of an API call in view mode:
https://localhost:3213/api/catalog/latest
https://localhost:3213/api/catalog/latest
Examples of an API call in compare mode:
https://localhost:3213/api/catalog/2...5
https://localhost:3213/api/catalog/1...latest
GET /api/catalog/{version}/{dataPlatform}
The API retrieves a list of schemas that belong to the specified Catalog version and data platform. Each schema is retrieved with the contains relations to its respective dataset nodes.
The API has 2 modes - view and compare - that are interchangeably invoked based on the version input parameter, as explained below:
Examples of an API call in the view mode:
https://localhost:3213/api/catalog/latest/CRM_DB
https://localhost:3213/api/catalog/1/CRM_DB
Examples of an API call in the compare mode:
https://localhost:3213/api/catalog/1...5/CRM_DB
https://localhost:3213/api/catalog/1...latest/CRM_DB
GET /api/catalog/{version}/{dataPlatform}/{schema}
The API retrieves all elements that belong to the specified Catalog version, data platform and schema. The elements include the datasets, fields and their properties, and the refersTo relations between the dataset nodes.
The API has 2 modes - view and compare - that are interchangeably invoked based on the version input parameter, as explained below:
Examples of an API call in the view mode:
https://localhost:3213/api/catalog/latest/CRM_DB/main
https://localhost:3213/api/catalog/1/CRM_DB/main
Examples of an API call in the compare mode:
https://localhost:3213/api/catalog/1...5/CRM_DB/main
https://localhost:3213/api/catalog/1...latest/CRM_DB/main
POST /api/catalog/{version}/build-catalog-artifacts
The API builds the Catalog artifacts, based on a given version. An artifact includes the details of all Catalog fields with their properties, such as Classification and PII. The artifact is created in a CSV format, saved into the Implementation/SharedObjects/Interfaces/Discovery/MTable
folder of the Project tree and is uploaded to the Fabric memory as an MTable.
Example of an API call:
https://localhost:3213/api/catalog/4/build-catalog-artifacts
POST /api/catalog/{version}/search-graph
The API retrieves all elements that belong to the specified Catalog version, based on the search criteria defined in the request body.
The syntax of the request body definition is as follows:
input is an array of keywords
type defines which object types will be searched
advanced includes a list of additional search parameters, such as:
At least one of the search parameters must be provided in the request body.
Example of an API call:
https://localhost:3213/api/catalog/4/search-graph
Examples of the request body:
Example 1: When searching for Data Platform and Schema nodes, whose name includes a customer keyword, the request body is:
{
"input": [
"customer"
],
"type": [
"dataPlatform",
"schema"
],
"advanced": {
}
}
Example 2: When searching for any node types with PII = true and Classification = EMAIL properties, the request body is:
{
"input": [],
"type": [],
"advanced": {
"pii": "true",
"classification": "EMAIL"
}
}