次の方法で共有

Discovery - Query

  • リファレンス
サービス:
Purview
API バージョン:
2023-09-01

検索を使用してデータを取得します。

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

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string

api-version
 query True

string

この操作に使用する API バージョン。

要求本文

名前 型 説明
continuationToken

string

データの次のバッチを取得するために使用されるトークン。 最初のバッチを取得する既定の 'Null' であり、それ以上データがない限り、各応答で新しいトークンが返されます。
facets

SearchFacetItem[]

検索のファセット。 サポートされているファセットの使用方法については、例を参照してください。
filter

検索のフィルター。 サポートされているフィルターの使用例を参照してください。
keywords

string

検索可能なすべてのフィールドに適用されるキーワード。
limit

integer

検索結果の数の制限。 既定値は 50 です。最大値は 1000 です。
orderby

Orderby[]

検索結果の並べ替え順序は、複数のフィールドを指定できます。
taxonomySetting

SearchTaxonomySetting

検索の分類設定。

応答

名前 型 説明
200 OK

QueryResult

要求は成功しました。
Other Status Codes

AtlasErrorResponse

予期しないエラー応答。

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
https://purview.azure.net/.default

例

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

要求のサンプル

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"
      }
    }
  ]
}

応答のサンプル

状態コード:
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

要求のサンプル

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"
      }
    ]
  }
}

応答のサンプル

状態コード:
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

要求のサンプル

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://"
          }
        ]
      }
    ]
  }
}

応答のサンプル

状態コード:
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

要求のサンプル

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"
      }
    ]
  }
}

応答のサンプル

状態コード:
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

要求のサンプル

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"
      }
    ]
  }
}

応答のサンプル

状態コード:
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

要求のサンプル

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"
      }
    ]
  }
}

応答のサンプル

状態コード:
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

要求のサンプル

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

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

応答のサンプル

状態コード:
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

要求のサンプル

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

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

応答のサンプル

状態コード:
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

要求のサンプル

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
    }
  ]
}

応答のサンプル

状態コード:
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

要求のサンプル

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

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

応答のサンプル

状態コード:
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

要求のサンプル

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"
      }
    }
  ]
}

応答のサンプル

状態コード:
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

要求のサンプル

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

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

応答のサンプル

状態コード:
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

要求のサンプル

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

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

応答のサンプル

状態コード:
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

要求のサンプル

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"
      }
    ]
  }
}

応答のサンプル

状態コード:
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

要求のサンプル

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"
      }
    }
  ]
}

応答のサンプル

状態コード:
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

要求のサンプル

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"
      }
    }
  ]
}

応答のサンプル

状態コード:
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

要求のサンプル

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"
      }
    }
  ]
}

応答のサンプル

状態コード:
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

要求のサンプル

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"
      }
    ]
  }
}

応答のサンプル

状態コード:
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

要求のサンプル

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

応答のサンプル

状態コード:
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

要求のサンプル

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>"
      }
    ]
  }
}

応答のサンプル

状態コード:
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

要求のサンプル

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

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

応答のサンプル

状態コード:
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": []
    }
  ]
}

定義

名前 説明
AtlasErrorResponse

サービスからのエラー応答
ContactSearchResultValue

検索結果と提案結果の連絡先。
QueryOptions

高度な検索要求の検索クエリ。
QueryResult

検索結果の結果。
SearchFacetItem

検索ファセットの結果アイテムの内容。
SearchFacetItemValue

検索ファセットの結果アイテムの内容。
SearchFacetResultValue

インデックス フィールド assetType、classification、contactId、および label で構成されるファセット リスト。 要求でファセットが指定されると、ファセットの値が の @search.facets要素として返されます。
SearchFacetSort

並べ替え条件
SearchHighlights

インデックス フィールド ID 、修飾名、名前、説明、entityType で構成される強調表示リスト。 これらのフィールドにキーワード (keyword)が表示されると、強調マークが付いたフィールドの値が の@search.highlights要素として返されます。
SearchResultValue

検索結果の値項目。
SearchSortOrder

検索の並べ替え順序
SearchTaxonomySetting

検索要求の分類設定
TermSearchResultValue

コンテキスト。

AtlasErrorResponse

サービスからのエラー応答

名前 型 説明
errorCode

string

エラー コード。
errorMessage

string

エラー メッセージ。
requestId

string

要求 ID です。

ContactSearchResultValue

検索結果と提案結果の連絡先。

名前 型 説明
contactType

string

連絡先の種類。 エンティティのエキスパートまたは所有者にすることができます。 用語集の用語には、Expert または Steward を指定できます。
id

string

連絡先の GUID。
info

string

連絡先の説明。

QueryOptions

高度な検索要求の検索クエリ。

名前 型 説明
continuationToken

string

データの次のバッチを取得するために使用されるトークン。 最初のバッチを取得する既定の 'Null' であり、それ以上データがない限り、各応答で新しいトークンが返されます。
facets

SearchFacetItem[]

検索のファセット。 サポートされているファセットの使用方法については、例を参照してください。
filter

検索のフィルター。 サポートされているフィルターの使用例を参照してください。
keywords

string

検索可能なすべてのフィールドに適用されるキーワード。
limit

integer

検索結果の数の制限。 既定値は 50 です。最大値は 1000 です。
orderby

Orderby[]

検索結果の並べ替え順序は、複数のフィールドを指定できます。
taxonomySetting

SearchTaxonomySetting

検索の分類設定。

QueryResult

検索結果の結果。

名前 型 説明
@search.count

integer

検索結果の合計数 (1 ページ内のドキュメントの数ではありません)。
@search.count.approximate

boolean

'@search.count' が近似値で、その逆の場合は 'True' です。
@search.facets

SearchFacetResultValue

インデックス フィールド assetType、classification、contactId、および label で構成されるファセット リスト。 要求でファセットが指定されると、ファセットの値が の @search.facets要素として返されます。
continuationToken

string

データの次のバッチを取得するために使用されるトークン。 これ以上データがない場合は存在しません。
value

SearchResultValue[]

検索結果の値

SearchFacetItem

検索ファセットの結果アイテムの内容。

名前 型 説明
count

integer

ファセット項目の数。
facet

string

ファセット項目の名前。
sort

SearchFacetSort

アイテムの並べ替え条件を定義する

SearchFacetItemValue

検索ファセットの結果アイテムの内容。

名前 型 説明
count

integer

ファセット項目の数。
value

string

ファセット項目の名前。

SearchFacetResultValue

インデックス フィールド assetType、classification、contactId、および label で構成されるファセット リスト。 要求でファセットが指定されると、ファセットの値が の @search.facets要素として返されます。

名前 型 説明
assetType

SearchFacetItemValue[]

資産の種類
classification

SearchFacetItemValue[]

分類
contactId

SearchFacetItemValue[]

連絡先 ID
contactType

SearchFacetItemValue[]

連絡先の種類
entityType

SearchFacetItemValue[]

エンティティ型
glossaryType

SearchFacetItemValue[]

用語集の種類
label

SearchFacetItemValue[]

Label
term

SearchFacetItemValue[]

期間
termStatus

SearchFacetItemValue[]

用語の状態
termTemplate

SearchFacetItemValue[]

用語テンプレート

SearchFacetSort

並べ替え条件

名前 型 説明
count

SearchSortOrder

カウント別の注文
value

SearchSortOrder

値で並べ替え

SearchHighlights

インデックス フィールド ID 、修飾名、名前、説明、entityType で構成される強調表示リスト。 これらのフィールドにキーワード (keyword)が表示されると、強調マークが付いたフィールドの値が の@search.highlights要素として返されます。

名前 型 説明
description

string[]

説明
entityType

string[]

エンティティ型
id

string[]

Id
name

string[]

名前
qualifiedName

string[]

修飾名

SearchResultValue

検索結果の値項目。

名前 型 説明
@search.highlights

SearchHighlights

インデックス フィールド ID 、修飾名、名前、説明、entityType で構成される強調表示リスト。 これらのフィールドにキーワード (keyword)が表示されると、強調マークが付いたフィールドの値が の@search.highlights要素として返されます。
@search.score

number

検索エンジンによって計算される検索スコア。 既定では、結果は検索スコア順に並べられます。
assetType

string[]

資産の資産の種類。
classification

string[]

レコードの分類。
contact

ContactSearchResultValue[]

資産の連絡先。
createTime

integer

レコードの作成時刻。 Unix エポック形式。
description

string

資産の説明。
endorsement

string

資産の保証。
entityType

string

資産の型名。
glossary

string

用語の用語集の名前。
glossaryType

string

用語の型名。 AtlasGlossary、AtlasGlossaryTerm、AtlasGlossaryCategory のいずれかです。
id

string

レコードの GUID。
label

string[]

資産のラベル。
longDescription

string

用語の定義。
name

string

レコードの名前。
objectType

string

レコードのオブジェクト型。 オブジェクト型は、レコードが資産か用語かを区別する最上位のプロパティです。
owner

string

レコードの所有者。
qualifiedName

string

レコードの修飾名。
term

TermSearchResultValue[]

資産に割り当てられた用語。
termStatus

string

用語の状態。
termTemplate

string[]

用語で使用される用語テンプレート名。
updateTime

integer

レコードの最後の更新時刻。 Unix エポック形式。

SearchSortOrder

検索の並べ替え順序

名前 型 説明
asc

string

並べ替えに昇順を使用する
desc

string

並べ替えに降順を使用する

SearchTaxonomySetting

検索要求の分類設定

名前 型 説明
assetTypes

string[]

アセットの種類
facet

SearchFacetItem

検索ファセットの結果アイテムの内容。

TermSearchResultValue

コンテキスト。

名前 型 説明
glossaryName

string

用語を含む用語集の名前。
guid

string

用語の GUID。
name

string

用語の名前。