Discovery - Query

Reference

Service:: Purview

API Version:: 2023-09-01

Get data using search.

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Type	Description
continuationToken	string	The token used to get next batch of data. Default 'Null' to get the first batch, and will return new token in each response unless there's no more data.
facets	SearchFacetItem[]	The facets for search. See examples for the usage of supported facets.
filter		The filter for the search. See examples for the usage of supported filters.
keywords	string	The keywords applied to all searchable fields.
limit	integer	The limit of the number of the search result. default value is 50; maximum value is 1000.
orderby	Orderby[]	The sort order of search results, can specify multiple fields.
taxonomySetting	SearchTaxonomySetting	The taxonomy setting for search.

Responses

Name	Type	Description
200 OK	QueryResult	The request has succeeded.
Other Status Codes	AtlasErrorResponse	An unexpected error response.

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://purview.azure.net/.default

Examples

Discovery_Query

Discovery_Query_And

Discovery_Query_AndOrNested

Discovery_Query_AssetType

Discovery_Query_Attribute

Discovery_Query_BusinessMetadataAttribute

Discovery_Query_Classification

Discovery_Query_Collection

Discovery_Query_Facet

Discovery_Query_FileExtension

Discovery_Query_GlossaryTerm

Discovery_Query_Id

Discovery_Query_Not

Discovery_Query_ObjectType

Discovery_Query_PaginationContinuationPage

Discovery_Query_PaginationFirstPage

Discovery_Query_PaginationLastPage

Discovery_Query_SystemTime

Discovery_Query_Taxonomy

Discovery_Query_TermAssignment

Discovery_Query_Type

Discovery_Query

Sample request

HTTP

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": "exampledata",
  "filter": {
    "and": [
      {
        "objectType": "Files"
      },
      {
        "entityType": "azure_blob_path"
      }
    ]
  },
  "limit": 10,
  "orderby": [
    {
      "name": "ASC"
    },
    {
      "updateTime": "DESC"
    }
  ],
  "facets": [
    {
      "facet": "assetType",
      "count": 0,
      "sort": {
        "count": "desc"
      }
    },
    {
      "facet": "classification",
      "count": 10,
      "sort": {
        "count": "desc"
      }
    },
    {
      "facet": "contactId",
      "count": 10,
      "sort": {
        "count": "desc"
      }
    },
    {
      "facet": "label",
      "count": 10,
      "sort": {
        "count": "desc"
      }
    },
    {
      "facet": "term",
      "count": 10,
      "sort": {
        "count": "desc"
      }
    }
  ]
}

Sample response

Status code:: 200

{
  "@search.count": 2,
  "@search.count.approximate": false,
  "value": [
    {
      "@search.score": 1,
      "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata1.txt",
      "name": "exampledata1.txt",
      "description": null,
      "owner": null,
      "entityType": "azure_blob_path",
      "classification": [],
      "label": [],
      "assetType": [
        "Azure Blob Storage"
      ],
      "term": [],
      "contact": []
    },
    {
      "@search.score": 1,
      "id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.txt",
      "name": "exampledata2.txt",
      "description": null,
      "owner": null,
      "entityType": "azure_blob_path",
      "classification": [],
      "label": [],
      "assetType": [
        "Azure Blob Storage"
      ],
      "term": [],
      "contact": []
    }
  ]
}

Discovery_Query_And

Sample request

HTTP

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": null,
  "limit": 10,
  "filter": {
    "and": [
      {
        "entityType": "azure_blob_path"
      },
      {
        "attributeName": "qualifiedName",
        "operator": "contains",
        "attributeValue": ".csv"
      }
    ]
  }
}

Sample response

Status code:: 200

{
  "@search.count": 5,
  "@search.count.approximate": false,
  "value": [
    {
      "@search.score": 1,
      "@search.highlights": {
        "qualifiedName": [
          "https://exampleaccount.blob.core.windows.net/examplepath/<em>csv</em>/exampledata.csv"
        ]
      },
      "id": "63b92968-c9ac-4af8-8cff-f61d147bbf88",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv",
      "name": "exampledata.csv",
      "description": null,
      "owner": null,
      "entityType": "azure_blob_path",
      "classification": [],
      "label": [
        "Example.Label"
      ],
      "assetType": [
        "Azure Blob Storage"
      ],
      "term": [],
      "contact": []
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "qualifiedName": [
          "https://exampleaccount.blob.core.windows.net/examplepath/<em>csv</em>/AllTypes.csv"
        ]
      },
      "id": "2605db54-086d-4d6c-adb6-f0bbed6c6eab",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/AllTypes.csv",
      "name": "AllTypes.csv",
      "description": null,
      "owner": null,
      "entityType": "azure_blob_path",
      "classification": [],
      "label": [
        "Example.Label"
      ],
      "assetType": [
        "Azure Blob Storage"
      ],
      "term": [],
      "contact": []
    }
  ]
}

Discovery_Query_AndOrNested

Sample request

HTTP

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": null,
  "limit": 10,
  "filter": {
    "and": [
      {
        "entityType": "azure_blob_path"
      },
      {
        "attributeName": "qualifiedName",
        "operator": "contains",
        "attributeValue": ".csv"
      },
      {
        "or": [
          {
            "attributeName": "name",
            "operator": "eq",
            "attributeValue": "exampledata.csv"
          },
          {
            "attributeName": "qualifiedName",
            "operator": "prefix",
            "attributeValue": "https://"
          }
        ]
      }
    ]
  }
}

Sample response

Status code:: 200

{
  "@search.count": 2,
  "@search.count.approximate": false,
  "value": [
    {
      "@search.score": 1,
      "@search.highlights": {
        "qualifiedName": [
          "https://exampleaccount.blob.core.windows.net/examplepath/<em>csv</em>/exampledata.csv"
        ]
      },
      "id": "63b92968-c9ac-4af8-8cff-f61d147bbf88",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv",
      "name": "exampledata.csv",
      "description": null,
      "owner": null,
      "entityType": "azure_blob_path",
      "classification": [],
      "label": [
        "Example.Label"
      ],
      "assetType": [
        "Azure Blob Storage"
      ],
      "term": [],
      "contact": []
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "qualifiedName": [
          "https://exampleaccount.blob.core.windows.net/examplepath/<em>csv</em>/AllTypes.csv"
        ],
        "name": [
          "<em>AllTypes.csv</em>"
        ]
      },
      "id": "2605db54-086d-4d6c-adb6-f0bbed6c6eab",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/AllTypes.csv",
      "name": "AllTypes.csv",
      "description": null,
      "owner": null,
      "entityType": "azure_blob_path",
      "classification": [],
      "label": [
        "Example.Label"
      ],
      "assetType": [
        "Azure Blob Storage"
      ],
      "term": [],
      "contact": []
    }
  ]
}

Discovery_Query_AssetType

Sample request

HTTP

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": null,
  "limit": 10,
  "filter": {
    "or": [
      {
        "assetType": "SQL Server"
      },
      {
        "assetType": "Azure SQL Server"
      },
      {
        "assetType": "Azure SQL Database"
      },
      {
        "assetType": "Azure SQL Data Warehouse"
      },
      {
        "assetType": "Azure SQL Managed Instance"
      },
      {
        "assetType": "Azure Storage Account"
      },
      {
        "assetType": "Azure Blob Storage"
      },
      {
        "assetType": "Azure Files"
      },
      {
        "assetType": "Azure Table Storage"
      },
      {
        "assetType": "Azure Data Lake Storage Gen1"
      },
      {
        "assetType": "Azure Data Lake Storage Gen2"
      },
      {
        "assetType": "Azure Cosmos DB"
      },
      {
        "assetType": "Azure Data Factory"
      },
      {
        "assetType": "Azure Cognitive Search"
      },
      {
        "assetType": "Power BI"
      },
      {
        "assetType": "Azure Data Explorer"
      },
      {
        "assetType": "Amazon S3"
      },
      {
        "assetType": "Azure Data Share"
      },
      {
        "assetType": "Teradata"
      },
      {
        "assetType": "SAP S4HANA"
      },
      {
        "assetType": "SAP ECC"
      },
      {
        "assetType": "SQL Server Integration Services"
      },
      {
        "assetType": "hive"
      },
      {
        "assetType": "Azure Database for MySQL"
      },
      {
        "assetType": "Azure Database for MariaDB"
      },
      {
        "assetType": "Azure Database for PostgreSQL"
      },
      {
        "assetType": "Azure Synapse Analytics"
      }
    ]
  }
}

Sample response

Status code:: 200

{
  "continuationToken": "<token>",
  "@search.count": 5155,
  "@search.count.approximate": true,
  "value": [
    {
      "@search.score": 1,
      "id": "24c16e53-1bfd-4d6c-b4ce-b1f6f6f60000",
      "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata1",
      "name": "exampledata1",
      "description": null,
      "owner": null,
      "entityType": "azure_sql_mi_table",
      "classification": [],
      "label": [],
      "assetType": [
        "Azure SQL Managed Instance"
      ],
      "term": [],
      "contact": []
    },
    {
      "@search.score": 1,
      "id": "d7b516fc-5d38-40f8-baeb-72f6f6f60000",
      "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata2",
      "name": "exampledata2",
      "description": null,
      "owner": null,
      "entityType": "azure_sql_mi_table",
      "classification": [],
      "label": [],
      "assetType": [
        "Azure SQL Managed Instance"
      ],
      "term": [],
      "contact": []
    }
  ]
}

Discovery_Query_Attribute

Sample request

HTTP

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": null,
  "limit": 10,
  "filter": {
    "or": [
      {
        "attributeName": "name",
        "operator": "eq",
        "attributeValue": "exampledata.csv"
      },
      {
        "attributeName": "createTime",
        "operator": "ge",
        "attributeValue": 1545580800000
      },
      {
        "attributeName": "modifiedTime",
        "operator": "timerange",
        "attributeValue": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D"
      }
    ]
  }
}

Sample response

Status code:: 200

{
  "@search.count": 4,
  "@search.count.approximate": false,
  "value": [
    {
      "@search.score": 1,
      "id": "63b92968-c9ac-4af8-8cff-f61d147bbf88",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv",
      "name": "exampledata.csv",
      "description": null,
      "owner": null,
      "entityType": "azure_blob_path",
      "classification": [],
      "label": [
        "Example.Label"
      ],
      "assetType": [
        "Azure Blob Storage"
      ],
      "term": [],
      "contact": []
    },
    {
      "@search.score": 1,
      "id": "55b2290d-e11d-4ed2-8c7a-0d8d35eb6254",
      "qualifiedName": "https://examplegen2account.dfs.core.windows.net/examplepath/csv/exampledata.csv",
      "name": "exampledata.csv",
      "description": null,
      "owner": "$superuser",
      "entityType": "azure_datalake_gen2_path",
      "classification": [],
      "label": [
        "Example.Label"
      ],
      "assetType": [
        "Azure Data Lake Storage Gen2"
      ],
      "term": [],
      "contact": []
    },
    {
      "@search.score": 1,
      "id": "55ceaddf-30ac-40f3-b656-71f6f6f60000",
      "entityType": "azure_sql_mi_table",
      "name": "exampleData_v1",
      "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampleData_v1",
      "assetType": [
        "Azure SQL Managed Instance"
      ]
    },
    {
      "@search.score": 1,
      "id": "89416661-5269-4f3d-ba35-e0f6f6f60000",
      "entityType": "azure_sql_mi_table",
      "name": "exampleData_v2",
      "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampleData_v2",
      "assetType": [
        "Azure SQL Managed Instance"
      ]
    }
  ]
}

Discovery_Query_BusinessMetadataAttribute

Sample request

HTTP

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": null,
  "limit": 10,
  "filter": {
    "or": [
      {
        "attributeName": "<BusinessMetadataName>.<StringAttributeName>",
        "operator": "eq|ne|contains|prefix",
        "attributeValue": "string value"
      },
      {
        "attributeName": "<BusinessMetadataName>.<NumberAttributeName>",
        "operator": "eq|ne|gt|ge|lt|le",
        "attributeValue": 123
      },
      {
        "attributeName": "<BusinessMetadataName>.<BooleanAttributeName>",
        "operator": "eq|ne",
        "attributeValue": true
      },
      {
        "attributeName": "<BusinessMetadataName>.<DateAttributeName>",
        "operator": "timerange",
        "attributeValue": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D"
      }
    ]
  }
}

Sample response

Status code:: 200

{
  "@search.count": 1,
  "@search.count.approximate": false,
  "value": [
    {
      "@search.score": 1,
      "id": "63b92968-c9ac-4af8-8cff-f61d147bbf88",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv",
      "name": "exampledata.csv",
      "entityType": "azure_blob_path",
      "objectType": "Files"
    }
  ]
}

Discovery_Query_Classification

Sample request

HTTP

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": null,
  "limit": 10,
  "filter": {
    "classification": "MICROSOFT.PERSONAL.EMAIL",
    "includeSubClassifications": true
  }
}

Sample response

Status code:: 200

{
  "@search.count": 5,
  "@search.count.approximate": false,
  "value": [
    {
      "@search.score": 1,
      "id": "b9638b91-884f-4e5e-98b5-29f6f6f60000",
      "qualifiedName": "mssql://exampleserver.database.windows.net/examplesqldb/examplepath/exampledata1",
      "name": "exampledata1",
      "description": null,
      "owner": null,
      "entityType": "azure_sql_table",
      "classification": [
        "MICROSOFT.PERSONAL.NAME",
        "MICROSOFT.PERSONAL.EU.PHONE_NUMBER",
        "MICROSOFT.PERSONAL.US.PHONE_NUMBER",
        "MICROSOFT.PERSONAL.EMAIL"
      ],
      "label": [],
      "assetType": [
        "Azure SQL Database"
      ],
      "term": [],
      "contact": []
    },
    {
      "@search.score": 1,
      "id": "01aefb9a-61cd-4a02-a572-70f6f6f60000",
      "qualifiedName": "mssql://exampleserver.database.windows.net/exampledw/examplepath/exampledata2",
      "name": "exampledata2",
      "description": null,
      "owner": null,
      "entityType": "azure_sql_dw_table",
      "classification": [
        "MICROSOFT.GOVERNMENT.CITY_NAME",
        "MICROSOFT.GOVERNMENT.US.STATE",
        "MICROSOFT.PERSONAL.NAME",
        "MICROSOFT.PERSONAL.EU.PHONE_NUMBER",
        "MICROSOFT.PERSONAL.EMAIL"
      ],
      "label": [],
      "assetType": [
        "Azure SQL Data Warehouse"
      ],
      "term": [],
      "contact": []
    }
  ]
}

Discovery_Query_Collection

Sample request

HTTP

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": null,
  "limit": 10,
  "filter": {
    "collectionId": "collectionName"
  }
}

Sample response

Status code:: 200

{
  "@search.count": 5,
  "@search.count.approximate": false,
  "value": [
    {
      "@search.score": 1,
      "id": "b9638b91-884f-4e5e-98b5-29f6f6f60000",
      "qualifiedName": "mssql://exampleserver.database.windows.net/examplesqldb/examplepath/exampledata1",
      "name": "exampledata1",
      "description": null,
      "owner": null,
      "entityType": "azure_sql_table",
      "classification": [
        "MICROSOFT.PERSONAL.NAME",
        "MICROSOFT.PERSONAL.EU.PHONE_NUMBER",
        "MICROSOFT.PERSONAL.US.PHONE_NUMBER",
        "MICROSOFT.PERSONAL.EMAIL"
      ],
      "label": [],
      "assetType": [
        "Azure SQL Database"
      ],
      "term": [],
      "contact": []
    },
    {
      "@search.score": 1,
      "id": "01aefb9a-61cd-4a02-a572-70f6f6f60000",
      "qualifiedName": "mssql://exampleserver.database.windows.net/exampledw/examplepath/exampledata2",
      "name": "exampledata2",
      "description": null,
      "owner": null,
      "entityType": "azure_sql_dw_table",
      "classification": [
        "MICROSOFT.GOVERNMENT.CITY_NAME",
        "MICROSOFT.GOVERNMENT.US.STATE",
        "MICROSOFT.PERSONAL.NAME",
        "MICROSOFT.PERSONAL.EU.PHONE_NUMBER",
        "MICROSOFT.PERSONAL.EMAIL"
      ],
      "label": [],
      "assetType": [
        "Azure SQL Data Warehouse"
      ],
      "term": [],
      "contact": []
    }
  ]
}

Discovery_Query_Facet

Sample request

HTTP

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": null,
  "filter": {
    "objectType": "Tables"
  },
  "limit": 10,
  "facets": [
    {
      "facet": "assetType",
      "count": 10
    },
    {
      "facet": "classification",
      "count": 10
    },
    {
      "facet": "term",
      "count": 10
    },
    {
      "facet": "label",
      "count": 10
    }
  ]
}

Sample response

Status code:: 200

{
  "continuationToken": "<token>",
  "@search.count": 5156,
  "@search.count.approximate": false,
  "@search.facets": {
    "classification": [
      {
        "count": 8,
        "value": "MICROSOFT.PERSONAL.NAME"
      },
      {
        "count": 6,
        "value": "MICROSOFT.PERSONAL.EU.PHONE_NUMBER"
      },
      {
        "count": 5,
        "value": "MICROSOFT.PERSONAL.EMAIL"
      },
      {
        "count": 5,
        "value": "MICROSOFT.PERSONAL.US.PHONE_NUMBER"
      },
      {
        "count": 4,
        "value": "MICROSOFT.GOVERNMENT.CITY_NAME"
      },
      {
        "count": 2,
        "value": "MICROSOFT.GOVERNMENT.US.STATE"
      }
    ],
    "assetType": [
      {
        "count": 1476,
        "value": "Azure SQL Database"
      },
      {
        "count": 1358,
        "value": "Azure SQL Data Warehouse"
      },
      {
        "count": 1331,
        "value": "Azure SQL Managed Instance"
      },
      {
        "count": 293,
        "value": "Azure Data Lake Storage Gen1"
      },
      {
        "count": 261,
        "value": "Azure Blob Storage"
      },
      {
        "count": 231,
        "value": "Azure Data Lake Storage Gen2"
      },
      {
        "count": 194,
        "value": "Azure Files"
      },
      {
        "count": 18,
        "value": "Azure Cosmos DB"
      }
    ],
    "label": [
      {
        "count": 835,
        "value": "Example.Label"
      }
    ],
    "term": [
      {
        "count": 1,
        "value": "terma"
      }
    ]
  },
  "value": [
    {
      "@search.score": 1,
      "id": "24c16e53-1bfd-4d6c-b4ce-b1f6f6f60000",
      "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata",
      "name": "exampledata",
      "description": null,
      "owner": null,
      "entityType": "azure_sql_mi_table",
      "classification": [],
      "label": [],
      "assetType": [
        "Azure SQL Managed Instance"
      ],
      "term": [],
      "contact": []
    },
    {
      "@search.score": 1,
      "id": "d7b516fc-5d38-40f8-baeb-72f6f6f60000",
      "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata2",
      "name": "exampledata2",
      "description": null,
      "owner": null,
      "entityType": "azure_sql_mi_table",
      "classification": [],
      "label": [],
      "assetType": [
        "Azure SQL Managed Instance"
      ],
      "term": [],
      "contact": []
    }
  ]
}

Discovery_Query_FileExtension

Sample request

HTTP

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": null,
  "limit": 10,
  "filter": {
    "and": [
      {
        "fileExtension": "txt"
      }
    ]
  }
}

Sample response

Status code:: 200

{
  "continuationToken": "<token>",
  "@search.count": 49,
  "@search.count.approximate": false,
  "value": [
    {
      "@search.score": 1,
      "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.txt",
      "name": "exampledata.txt",
      "description": null,
      "owner": null,
      "entityType": "azure_blob_path",
      "classification": [],
      "label": [],
      "assetType": [
        "Azure Blob Storage"
      ],
      "term": [],
      "contact": []
    },
    {
      "@search.score": 1,
      "id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.txt",
      "name": "exampledata.txt",
      "description": null,
      "owner": null,
      "entityType": "azure_blob_path",
      "classification": [],
      "label": [],
      "assetType": [
        "Azure Blob Storage"
      ],
      "term": [],
      "contact": []
    }
  ]
}

Discovery_Query_GlossaryTerm

Sample request

HTTP

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": "<term name>",
  "limit": 10,
  "filter": {
    "and": [
      {
        "objectType": "Glossary terms"
      },
      {
        "or": [
          {
            "glossaryType": "AtlasGlossary"
          },
          {
            "glossaryType": "AtlasGlossaryTerm"
          }
        ]
      }
    ]
  },
  "facets": [
    {
      "facet": "termStatus",
      "count": 10,
      "sort": {
        "count": "desc"
      }
    },
    {
      "facet": "termTemplate",
      "count": 10,
      "sort": {
        "count": "desc"
      }
    }
  ]
}

Sample response

Status code:: 200

{
  "@search.count": 2,
  "@search.count.approximate": false,
  "value": [
    {
      "@search.score": 1,
      "objectType": "Glossary terms",
      "glossaryType": "AtlasGlossaryTerm",
      "id": "b1e51cc4-9249-4c81-bbc7-e2f3117706f3",
      "name": "termSample1",
      "glossary": "DefaultGlossary",
      "longDescription": "it is the definition of the term",
      "termStatus": "Approved",
      "termTemplate": [
        "termTemplateSample"
      ],
      "createTime": 1625819659805,
      "updateTime": 1625819659805,
      "qualifiedName": "termSample1@DefaultGlossary"
    },
    {
      "@search.score": 1,
      "objectType": "Glossary terms",
      "glossaryType": "AtlasGlossary",
      "id": "b28f35e4-fcd4-43ca-91a3-daf432c87156",
      "name": "DefaultGlossary",
      "longDescription": "it is the definition of the glossary",
      "createTime": 1625819658745,
      "updateTime": 1640656877302,
      "qualifiedName": "DefaultGlossary"
    }
  ],
  "@search.facets": {
    "termTemplate": [
      {
        "count": 1,
        "value": "termTemplateSample"
      }
    ],
    "termStatus": [
      {
        "count": 1,
        "value": "Approved"
      }
    ]
  }
}

Discovery_Query_Id

Sample request

HTTP

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": null,
  "limit": 10,
  "filter": {
    "and": [
      {
        "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9"
      }
    ]
  }
}

Sample response

Status code:: 200

{
  "@search.count": 1,
  "@search.count.approximate": false,
  "value": [
    {
      "@search.score": 1,
      "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.txt",
      "name": "exampledata.txt",
      "description": null,
      "owner": null,
      "entityType": "azure_blob_path",
      "classification": [],
      "label": [],
      "assetType": [
        "Azure Blob Storage"
      ],
      "term": [],
      "contact": []
    }
  ]
}

Discovery_Query_Not

Sample request

HTTP

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": null,
  "limit": 10,
  "filter": {
    "not": {
      "classification": "MICROSOFT.SYSTEM.TEMP_FILE"
    }
  }
}

Sample response

Status code:: 200

{
  "continuationToken": "<token>",
  "@search.count": 5158,
  "@search.count.approximate": false,
  "value": [
    {
      "@search.score": 1,
      "id": "11fd6e94-2dc6-4ebd-822c-caf6f6f60000",
      "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/exampledb/dbo/exampledata",
      "name": "exampledata",
      "description": null,
      "owner": null,
      "entityType": "azure_sql_mi_table",
      "classification": [],
      "label": [],
      "assetType": [
        "Azure SQL Managed Instance"
      ],
      "term": [],
      "contact": []
    },
    {
      "@search.score": 1,
      "id": "1af82c87-798c-41a2-abab-93f6f6f60000",
      "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/exampledb/dbo/exampledata2",
      "name": "exampledata2",
      "description": null,
      "owner": null,
      "entityType": "azure_sql_mi_table",
      "classification": [],
      "label": [],
      "assetType": [
        "Azure SQL Managed Instance"
      ],
      "term": [],
      "contact": []
    }
  ]
}

Discovery_Query_ObjectType

Sample request

HTTP

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": null,
  "limit": 10,
  "filter": {
    "or": [
      {
        "objectType": "Dashboards"
      },
      {
        "objectType": "Data pipelines"
      },
      {
        "objectType": "Files"
      },
      {
        "objectType": "Folders"
      },
      {
        "objectType": "Glossary terms"
      },
      {
        "objectType": "Reports"
      },
      {
        "objectType": "Stored procedures"
      },
      {
        "objectType": "Tables"
      }
    ]
  }
}

Sample response

Status code:: 200

{
  "@search.count": 2,
  "@search.count.approximate": false,
  "value": [
    {
      "@search.score": 1,
      "objectType": "Tables",
      "id": "24c16e53-1bfd-4d6c-b4ce-b1f6f6f60000",
      "entityType": "azure_sql_mi_table",
      "name": "exampledata1",
      "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata1",
      "assetType": [
        "Azure SQL Managed Instance"
      ]
    },
    {
      "@search.score": 1,
      "objectType": "Glossary terms",
      "id": "b1e51cc4-9249-4c81-bbc7-e2f3117706f3",
      "glossaryType": "AtlasGlossaryTerm",
      "name": "termSample1",
      "glossary": "DefaultGlossary",
      "longDescription": "it is the definition of the term",
      "termStatus": "Approved",
      "termTemplate": [
        "termTemplateSample"
      ],
      "qualifiedName": "termSample1@DefaultGlossary"
    }
  ]
}

Discovery_Query_PaginationContinuationPage

Sample request

HTTP

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": "exampledata",
  "filter": {
    "and": [
      {
        "objectType": "Files"
      },
      {
        "entityType": "azure_blob_path"
      }
    ]
  },
  "limit": 2,
  "continuationToken": "<token>",
  "orderby": [
    {
      "name": "ASC"
    },
    {
      "updateTime": "DESC"
    }
  ],
  "facets": [
    {
      "facet": "assetType",
      "count": 0,
      "sort": {
        "count": "desc"
      }
    },
    {
      "facet": "classification",
      "count": 10,
      "sort": {
        "count": "desc"
      }
    },
    {
      "facet": "contactId",
      "count": 10,
      "sort": {
        "count": "desc"
      }
    },
    {
      "facet": "label",
      "count": 10,
      "sort": {
        "count": "desc"
      }
    },
    {
      "facet": "term",
      "count": 10,
      "sort": {
        "count": "desc"
      }
    }
  ]
}

Sample response

Status code:: 200

{
  "@search.count": 6,
  "@search.count.approximate": false,
  "continuationToken": "<token>",
  "value": [
    {
      "@search.score": 1,
      "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata1.txt",
      "name": "exampledata1.txt",
      "description": null,
      "owner": null,
      "entityType": "azure_blob_path",
      "classification": [],
      "label": [],
      "assetType": [
        "Azure Blob Storage"
      ],
      "term": [],
      "contact": []
    },
    {
      "@search.score": 1,
      "id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.txt",
      "name": "exampledata2.txt",
      "description": null,
      "owner": null,
      "entityType": "azure_blob_path",
      "classification": [],
      "label": [],
      "assetType": [
        "Azure Blob Storage"
      ],
      "term": [],
      "contact": []
    }
  ]
}

Discovery_Query_PaginationFirstPage

Sample request

HTTP

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": "exampledata",
  "filter": {
    "and": [
      {
        "objectType": "Files"
      },
      {
        "entityType": "azure_blob_path"
      }
    ]
  },
  "limit": 2,
  "orderby": [
    {
      "name": "ASC"
    },
    {
      "updateTime": "DESC"
    }
  ],
  "facets": [
    {
      "facet": "assetType",
      "count": 0,
      "sort": {
        "count": "desc"
      }
    },
    {
      "facet": "classification",
      "count": 10,
      "sort": {
        "count": "desc"
      }
    },
    {
      "facet": "contactId",
      "count": 10,
      "sort": {
        "count": "desc"
      }
    },
    {
      "facet": "label",
      "count": 10,
      "sort": {
        "count": "desc"
      }
    },
    {
      "facet": "term",
      "count": 10,
      "sort": {
        "count": "desc"
      }
    }
  ]
}

Sample response

Status code:: 200

{
  "@search.count": 6,
  "@search.count.approximate": false,
  "continuationToken": "<token>",
  "value": [
    {
      "@search.score": 1,
      "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata1.txt",
      "name": "exampledata1.txt",
      "description": null,
      "owner": null,
      "entityType": "azure_blob_path",
      "classification": [],
      "label": [],
      "assetType": [
        "Azure Blob Storage"
      ],
      "term": [],
      "contact": []
    },
    {
      "@search.score": 1,
      "id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.txt",
      "name": "exampledata2.txt",
      "description": null,
      "owner": null,
      "entityType": "azure_blob_path",
      "classification": [],
      "label": [],
      "assetType": [
        "Azure Blob Storage"
      ],
      "term": [],
      "contact": []
    }
  ]
}

Discovery_Query_PaginationLastPage

Sample request

HTTP

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": "exampledata",
  "filter": {
    "and": [
      {
        "objectType": "Files"
      },
      {
        "entityType": "azure_blob_path"
      }
    ]
  },
  "limit": 2,
  "continuationToken": "<token>",
  "orderby": [
    {
      "name": "ASC"
    },
    {
      "updateTime": "DESC"
    }
  ],
  "facets": [
    {
      "facet": "assetType",
      "count": 0,
      "sort": {
        "count": "desc"
      }
    },
    {
      "facet": "classification",
      "count": 10,
      "sort": {
        "count": "desc"
      }
    },
    {
      "facet": "contactId",
      "count": 10,
      "sort": {
        "count": "desc"
      }
    },
    {
      "facet": "label",
      "count": 10,
      "sort": {
        "count": "desc"
      }
    },
    {
      "facet": "term",
      "count": 10,
      "sort": {
        "count": "desc"
      }
    }
  ]
}

Sample response

Status code:: 200

{
  "@search.count": 6,
  "@search.count.approximate": false,
  "value": [
    {
      "@search.score": 1,
      "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata1.txt",
      "name": "exampledata1.txt",
      "description": null,
      "owner": null,
      "entityType": "azure_blob_path",
      "classification": [],
      "label": [],
      "assetType": [
        "Azure Blob Storage"
      ],
      "term": [],
      "contact": []
    },
    {
      "@search.score": 1,
      "id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.txt",
      "name": "exampledata2.txt",
      "description": null,
      "owner": null,
      "entityType": "azure_blob_path",
      "classification": [],
      "label": [],
      "assetType": [
        "Azure Blob Storage"
      ],
      "term": [],
      "contact": []
    }
  ]
}

Discovery_Query_SystemTime

Sample request

HTTP

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": null,
  "limit": 10,
  "filter": {
    "or": [
      {
        "createTime": {
          "operator": "lt",
          "timeThreshold": 1545580800000
        }
      },
      {
        "updateTime": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D"
      }
    ]
  }
}

Sample response

Status code:: 200

{
  "@search.count": 2,
  "@search.count.approximate": false,
  "value": [
    {
      "@search.score": 1,
      "id": "55ceaddf-30ac-40f3-b656-71f6f6f60000",
      "entityType": "azure_sql_mi_table",
      "name": "exampleData_v1",
      "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampleData_v1",
      "assetType": [
        "Azure SQL Managed Instance"
      ]
    },
    {
      "@search.score": 1,
      "id": "89416661-5269-4f3d-ba35-e0f6f6f60000",
      "entityType": "azure_sql_mi_table",
      "name": "exampleData_v2",
      "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampleData_v2",
      "assetType": [
        "Azure SQL Managed Instance"
      ]
    }
  ]
}

Discovery_Query_Taxonomy

Sample request

HTTP

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": "exampledata",
  "filter": {
    "and": [
      {
        "objectType": "Files"
      },
      {
        "not": {
          "or": [
            {
              "attributeName": "size",
              "operator": "eq",
              "attributeValue": 0
            },
            {
              "attributeName": "fileSize",
              "operator": "eq",
              "attributeValue": 0
            }
          ]
        }
      },
      {
        "not": {
          "classification": "MICROSOFT.SYSTEM.TEMP_FILE"
        }
      }
    ]
  },
  "limit": 10,
  "taxonomySetting": {
    "assetTypes": [
      "Azure Blob Storage"
    ],
    "facet": {
      "count": 10,
      "sort": {
        "count": "desc"
      }
    }
  }
}

Sample response

Status code:: 200

{
  "continuationToken": "<token>",
  "@search.count": 339,
  "@search.count.approximate": false,
  "value": [
    {
      "@search.score": 1,
      "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata1.txt",
      "name": "exampledata1.txt",
      "description": null,
      "owner": null,
      "entityType": "azure_blob_path",
      "classification": [],
      "label": [],
      "assetType": [
        "Azure Blob Storage"
      ],
      "term": [],
      "contact": []
    },
    {
      "@search.score": 1,
      "id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.txt",
      "name": "exampledata2.txt",
      "description": null,
      "owner": null,
      "entityType": "azure_blob_path",
      "classification": [],
      "label": [],
      "assetType": [
        "Azure Blob Storage"
      ],
      "term": [],
      "contact": []
    }
  ]
}

Discovery_Query_TermAssignment

Sample request

HTTP

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": "<asset name>",
  "limit": 3,
  "filter": {
    "or": [
      {
        "term": "ExampleTerm"
      },
      {
        "term": "ExampleTerm",
        "glossary": "GlossaryName"
      },
      {
        "termGuid": "<term guid>"
      }
    ]
  }
}

Sample response

Status code:: 200

{
  "@search.count": 1,
  "@search.count.approximate": false,
  "value": [
    {
      "@search.score": 1,
      "id": "b20ac13a-7883-4376-b076-bac9f8f214a8",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplecontainer",
      "name": "examplecontainer",
      "description": null,
      "owner": null,
      "entityType": "azure_blob_container",
      "classification": [],
      "assetType": [
        "Azure Blob Storage"
      ],
      "term": [
        {
          "name": "ExampleTerm",
          "glossaryName": "Glossary"
        }
      ],
      "contact": [],
      "label": [
        "Example.Label"
      ]
    }
  ]
}

Discovery_Query_Type

Sample request

HTTP

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": null,
  "limit": 10,
  "filter": {
    "and": [
      {
        "entityType": "azure_blob_path",
        "includeSubTypes": false
      }
    ]
  }
}

Sample response

Status code:: 200

{
  "continuationToken": "<token>",
  "@search.count": 221,
  "value": [
    {
      "@search.score": 1,
      "id": "1d797ddf-47bf-4151-8fe8-918590d62e70",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.csv",
      "name": "exampledata.csv",
      "description": null,
      "owner": null,
      "entityType": "azure_blob_path",
      "classification": [],
      "label": [
        "Example.Label"
      ],
      "assetType": [
        "Azure Blob Storage"
      ],
      "term": [],
      "contact": []
    },
    {
      "@search.score": 1,
      "id": "d3e83b17-c730-4898-94c8-58579cda04f6",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.csv",
      "name": "exampledata2.csv",
      "description": null,
      "owner": null,
      "entityType": "azure_blob_path",
      "classification": [],
      "label": [
        "Example.Label"
      ],
      "assetType": [
        "Azure Blob Storage"
      ],
      "term": [],
      "contact": []
    }
  ]
}

Definitions

Name	Description
AtlasErrorResponse	An error response from the service
ContactSearchResultValue	The contact in the search and suggest result.
QueryOptions	The search query of advanced search request.
QueryResult	The result of the search result.
SearchFacetItem	The content of a search facet result item.
SearchFacetItemValue	The content of a search facet result item.
SearchFacetResultValue	A facet list that consists of index fields assetType ,classification, contactId, and label. When the facet is specified in the request, the value of the facet is returned as an element of @search.facets.
SearchFacetSort	The sorting criteria
SearchHighlights	A highlight list that consists of index fields id ,qualifiedName, name, description, entityType. When the keyword appears in those fields, the value of the field, attached with emphasis mark, is returned as an element of @search.highlights.
SearchResultValue	The value item of the search result.
SearchSortOrder	Search sort order
SearchTaxonomySetting	Taxonomy setting for search request
TermSearchResultValue	The context.

AtlasErrorResponse

An error response from the service

Name	Type	Description
errorCode	string	The error code.
errorMessage	string	The error message.
requestId	string	The request ID.

ContactSearchResultValue

The contact in the search and suggest result.

Name	Type	Description
contactType	string	The type of the contact. It can be Expert or Owner for an entity. It can be Expert or Steward for a glossary term.
id	string	The GUID of the contact.
info	string	The description of the contact.

QueryOptions

The search query of advanced search request.

Name	Type	Description
continuationToken	string	The token used to get next batch of data. Default 'Null' to get the first batch, and will return new token in each response unless there's no more data.
facets	SearchFacetItem[]	The facets for search. See examples for the usage of supported facets.
filter		The filter for the search. See examples for the usage of supported filters.
keywords	string	The keywords applied to all searchable fields.
limit	integer	The limit of the number of the search result. default value is 50; maximum value is 1000.
orderby	Orderby[]	The sort order of search results, can specify multiple fields.
taxonomySetting	SearchTaxonomySetting	The taxonomy setting for search.

QueryResult

The result of the search result.

Name	Type	Description
@search.count	integer	The total number of search results (not the number of documents in a single page).
@search.count.approximate	boolean	'True' if the '@search.count' is an approximate value and vise versa.
@search.facets	SearchFacetResultValue	A facet list that consists of index fields assetType ,classification, contactId, and label. When the facet is specified in the request, the value of the facet is returned as an element of @search.facets.
continuationToken	string	The token used to get next batch of data. Absent if there's no more data.
value	SearchResultValue[]	Search result value

SearchFacetItem

The content of a search facet result item.

Name	Type	Description
count	integer	The count of the facet item.
facet	string	The name of the facet item.
sort	SearchFacetSort	Define the sorting criteria for items

SearchFacetItemValue

The content of a search facet result item.

Name	Type	Description
count	integer	The count of the facet item.
value	string	The name of the facet item.

SearchFacetResultValue

A facet list that consists of index fields assetType ,classification, contactId, and label. When the facet is specified in the request, the value of the facet is returned as an element of @search.facets.

Name	Type	Description
assetType	SearchFacetItemValue[]	Asset type
classification	SearchFacetItemValue[]	Classification
contactId	SearchFacetItemValue[]	Contact id
contactType	SearchFacetItemValue[]	Contact type
entityType	SearchFacetItemValue[]	Entity type
glossaryType	SearchFacetItemValue[]	Glossary type
label	SearchFacetItemValue[]	Label
term	SearchFacetItemValue[]	Term
termStatus	SearchFacetItemValue[]	Term status
termTemplate	SearchFacetItemValue[]	Term template

SearchFacetSort

The sorting criteria

Name	Type	Description
count	SearchSortOrder	Order by count
value	SearchSortOrder	Order by value

SearchHighlights

A highlight list that consists of index fields id ,qualifiedName, name, description, entityType. When the keyword appears in those fields, the value of the field, attached with emphasis mark, is returned as an element of @search.highlights.

Name	Type	Description
description	string[]	Description
entityType	string[]	Entity type
id	string[]	Id
name	string[]	Name
qualifiedName	string[]	Qualified name

SearchResultValue

The value item of the search result.

Name	Type	Description
@search.highlights	SearchHighlights	A highlight list that consists of index fields id ,qualifiedName, name, description, entityType. When the keyword appears in those fields, the value of the field, attached with emphasis mark, is returned as an element of @search.highlights.
@search.score	number	The search score calculated by the search engine. The results are ordered by search score by default.
assetType	string[]	The asset types of the asset.
classification	string[]	The classifications of the record.
contact	ContactSearchResultValue[]	The contacts of the asset.
createTime	integer	The create time of the record. The Unix epoch format.
description	string	The description of the asset.
endorsement	string	The endorsement of the asset.
entityType	string	The type name of the asset.
glossary	string	The glossary name of the term.
glossaryType	string	The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory.
id	string	The GUID of the record.
label	string[]	The labels of the asset.
longDescription	string	The definition of the term.
name	string	The name of the record.
objectType	string	The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term.
owner	string	The owner of the record.
qualifiedName	string	The qualified name of the record.
term	TermSearchResultValue[]	The terms assigned to the asset.
termStatus	string	The status of the term.
termTemplate	string[]	The term template names used by the term.
updateTime	integer	The last update time of the record. The Unix epoch format.

SearchSortOrder

Search sort order

Name	Type	Description
asc	string	Use ascending order for sorting
desc	string	Use descending order for sorting

SearchTaxonomySetting

Taxonomy setting for search request

Name	Type	Description
assetTypes	string[]	Asset types
facet	SearchFacetItem	The content of a search facet result item.

TermSearchResultValue

The context.

Name	Type	Description
glossaryName	string	The name of the glossary which contains the term.
guid	string	The GUID of the term.
name	string	The name of the term.

Share via

Discovery - Query

URI Parameters

Request Body

Responses

Security

OAuth2Auth

Scopes

Examples

Discovery_Query

Sample request

Sample response

Discovery_Query_And

Sample request

Sample response

Discovery_Query_AndOrNested

Sample request

Sample response

Discovery_Query_AssetType

Sample request

Sample response

Discovery_Query_Attribute

Sample request

Sample response

Discovery_Query_BusinessMetadataAttribute

Sample request

Sample response

Discovery_Query_Classification

Sample request

Sample response

Discovery_Query_Collection

Sample request

Sample response

Discovery_Query_Facet

Sample request

Sample response

Discovery_Query_FileExtension

Sample request

Sample response

Discovery_Query_GlossaryTerm

Sample request

Sample response

Discovery_Query_Id

Sample request

Sample response

Discovery_Query_Not

Sample request

Sample response

Discovery_Query_ObjectType

Sample request

Sample response

Discovery_Query_PaginationContinuationPage

Sample request

Sample response

Discovery_Query_PaginationFirstPage

Sample request

Sample response

Discovery_Query_PaginationLastPage

Sample request

Sample response

Discovery_Query_SystemTime

Sample request

Sample response

Discovery_Query_Taxonomy

Sample request

Sample response

Discovery_Query_TermAssignment

Sample request

Sample response

Discovery_Query_Type

Sample request

Sample response

Definitions

AtlasErrorResponse

ContactSearchResultValue

QueryOptions

QueryResult

SearchFacetItem

SearchFacetItemValue

SearchFacetResultValue