{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Glossary API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Glossary", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Get Atlas Glossary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/atlas/v2/glossary", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The page size - by default there is no paging." }, { "name": "offset", "value": "", "type": "query", "description": "The offset for pagination purpose." }, { "name": "sort", "value": "", "type": "query", "description": "The sort order, ASC (default) or DESC." }, { "name": "ignoreTermsAndCategories", "value": "", "type": "query", "description": "Whether ignore terms and categories" } ] }, "docs": "Get all glossaries registered with Atlas. Recommend using limit/offset to get pagination result. Recommended using 'ignoreTermsAndCategories=true' and fetch terms/categories separately using 'GET /catalog/api/atlas/v2/glossary/{glossaryGuid}/terms' and 'GET '/catalog/api/atlas/v2/glossary/{glossaryGuid}/categories'." }, { "info": { "name": "Microsoft Azure Post Atlas Glossary", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/atlas/v2/glossary" }, "docs": "Create a glossary." }, { "info": { "name": "Microsoft Azure Post Atlas Glossary Categories", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/atlas/v2/glossary/categories" }, "docs": "Create glossary category in bulk." }, { "info": { "name": "Microsoft Azure Post Atlas Glossary Category", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/atlas/v2/glossary/category" }, "docs": "Create a glossary category." }, { "info": { "name": "Microsoft Azure Get Atlas Glossary Category Categoryguid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/atlas/v2/glossary/category/:categoryGuid", "params": [ { "name": "categoryGuid", "value": "", "type": "path", "description": "The globally unique identifier of the category." } ] }, "docs": "Get specific glossary category by its GUID." }, { "info": { "name": "Microsoft Azure Put Atlas Glossary Category Categoryguid", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/atlas/v2/glossary/category/:categoryGuid", "params": [ { "name": "categoryGuid", "value": "", "type": "path", "description": "The globally unique identifier of the category." } ] }, "docs": "Update the given glossary category by its GUID." }, { "info": { "name": "Microsoft Azure Delete Atlas Glossary Category Categoryguid", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/atlas/v2/glossary/category/:categoryGuid", "params": [ { "name": "categoryGuid", "value": "", "type": "path", "description": "The globally unique identifier of the category." } ] }, "docs": "Delete a glossary category." }, { "info": { "name": "Microsoft Azure Put Atlas Glossary Category Categoryguid Partial", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/atlas/v2/glossary/category/:categoryGuid/partial", "params": [ { "name": "categoryGuid", "value": "", "type": "path", "description": "The globally unique identifier of the category." } ] }, "docs": "Update the glossary category partially. So far we only supports partial updating shortDescription and longDescription for category." }, { "info": { "name": "Microsoft Azure Get Atlas Glossary Category Categoryguid Related", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/atlas/v2/glossary/category/:categoryGuid/related", "params": [ { "name": "categoryGuid", "value": "", "type": "path", "description": "The globally unique identifier of the category." }, { "name": "limit", "value": "", "type": "query", "description": "The page size - by default there is no paging." }, { "name": "offset", "value": "", "type": "query", "description": "The offset for pagination purpose." }, { "name": "sort", "value": "", "type": "query", "description": "The sort order, ASC (default) or DESC." } ] }, "docs": "Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed." }, { "info": { "name": "Microsoft Azure Get Atlas Glossary Category Categoryguid Terms", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/atlas/v2/glossary/category/:categoryGuid/terms", "params": [ { "name": "categoryGuid", "value": "", "type": "path", "description": "The globally unique identifier of the category." }, { "name": "limit", "value": "", "type": "query", "description": "The page size - by default there is no paging." }, { "name": "offset", "value": "", "type": "query", "description": "The offset for pagination purpose." }, { "name": "sort", "value": "", "type": "query", "description": "The sort order, ASC (default) or DESC." } ] }, "docs": "Get all terms associated with the specific category." }, { "info": { "name": "Microsoft Azure Post Atlas Glossary Term", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/atlas/v2/glossary/term", "params": [ { "name": "includeTermHierarchy", "value": "", "type": "query", "description": "Whether include term hierarchy" } ] }, "docs": "Create a glossary term." }, { "info": { "name": "Microsoft Azure Get Atlas Glossary Term Termguid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/atlas/v2/glossary/term/:termGuid", "params": [ { "name": "termGuid", "value": "", "type": "path", "description": "The globally unique identifier for glossary term." }, { "name": "includeTermHierarchy", "value": "", "type": "query", "description": "Whether include term hierarchy" }, { "name": "excludeRelationshipTypes", "value": "", "type": "query", "description": "An array of relationship types which need to be excluded." } ] }, "docs": "Get a specific glossary term by its GUID. Recommend using 'excludeRelationshipTypes=AtlasGlossarySemanticAssignment' to get term and using 'GET /catalog/api/atlas/v2/glossary/terms/{termGuid}/assignedEntities' to get term assignment separately." }, { "info": { "name": "Microsoft Azure Put Atlas Glossary Term Termguid", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/atlas/v2/glossary/term/:termGuid", "params": [ { "name": "termGuid", "value": "", "type": "path", "description": "The globally unique identifier for glossary term." }, { "name": "includeTermHierarchy", "value": "", "type": "query", "description": "Whether include term hierarchy" } ] }, "docs": "Update the given glossary term by its GUID." }, { "info": { "name": "Microsoft Azure Delete Atlas Glossary Term Termguid", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/atlas/v2/glossary/term/:termGuid", "params": [ { "name": "termGuid", "value": "", "type": "path", "description": "The globally unique identifier for glossary term." } ] }, "docs": "Delete a glossary term." }, { "info": { "name": "Microsoft Azure Put Atlas Glossary Term Termguid Partial", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/atlas/v2/glossary/term/:termGuid/partial", "params": [ { "name": "termGuid", "value": "", "type": "path", "description": "The globally unique identifier for glossary term." }, { "name": "includeTermHierarchy", "value": "", "type": "query", "description": "Whether include term hierarchy" } ] }, "docs": "Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term." }, { "info": { "name": "Microsoft Azure Post Atlas Glossary Terms", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/atlas/v2/glossary/terms", "params": [ { "name": "includeTermHierarchy", "value": "", "type": "query", "description": "Whether include term hierarchy" } ] }, "docs": "Create glossary terms in bulk." }, { "info": { "name": "Microsoft Azure Get Atlas Glossary Terms Termguid Assignedentities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/atlas/v2/glossary/terms/:termGuid/assignedEntities", "params": [ { "name": "termGuid", "value": "", "type": "path", "description": "The globally unique identifier for glossary term." }, { "name": "limit", "value": "", "type": "query", "description": "The page size - by default there is no paging." }, { "name": "offset", "value": "", "type": "query", "description": "The offset for pagination purpose." }, { "name": "sort", "value": "", "type": "query", "description": "The sort order, ASC (default) or DESC." } ] }, "docs": "Get all related objects assigned with the specified term. Recommend using limit/offset to get pagination result." }, { "info": { "name": "Microsoft Azure Post Atlas Glossary Terms Termguid Assignedentities", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/atlas/v2/glossary/terms/:termGuid/assignedEntities", "params": [ { "name": "termGuid", "value": "", "type": "path", "description": "The globally unique identifier for glossary term." } ] }, "docs": "Assign the given term to the provided list of related objects. Recommend using small batches with multiple API calls." }, { "info": { "name": "Microsoft Azure Put Atlas Glossary Terms Termguid Assignedentities", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/atlas/v2/glossary/terms/:termGuid/assignedEntities", "params": [ { "name": "termGuid", "value": "", "type": "path", "description": "The globally unique identifier for glossary term." } ] }, "docs": "Delete the term assignment for the given list of related objects. This API is not recommended since duplicated with 'DELETE /catalog/api/atlas/v2/glossary/terms/{termGuid}/assignedEntities'. Please use later one instead." }, { "info": { "name": "Microsoft Azure Delete Atlas Glossary Terms Termguid Assignedentities", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/atlas/v2/glossary/terms/:termGuid/assignedEntities", "params": [ { "name": "termGuid", "value": "", "type": "path", "description": "The globally unique identifier for glossary term." } ] }, "docs": "Delete the term assignment for the given list of related objects." }, { "info": { "name": "Microsoft Azure Get Atlas Glossary Terms Termguid Related", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/atlas/v2/glossary/terms/:termGuid/related", "params": [ { "name": "termGuid", "value": "", "type": "path", "description": "The globally unique identifier for glossary term." }, { "name": "limit", "value": "", "type": "query", "description": "The page size - by default there is no paging." }, { "name": "offset", "value": "", "type": "query", "description": "The offset for pagination purpose." }, { "name": "sort", "value": "", "type": "query", "description": "The sort order, ASC (default) or DESC." }, { "name": "includeTermHierarchy", "value": "", "type": "query", "description": "Whether include term hierarchy" } ] }, "docs": "Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed." }, { "info": { "name": "Microsoft Azure Get Atlas Glossary Glossaryguid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/atlas/v2/glossary/:glossaryGuid", "params": [ { "name": "glossaryGuid", "value": "", "type": "path", "description": "The globally unique identifier for glossary." } ] }, "docs": "Get a specific Glossary by its GUID." }, { "info": { "name": "Microsoft Azure Put Atlas Glossary Glossaryguid", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/atlas/v2/glossary/:glossaryGuid", "params": [ { "name": "glossaryGuid", "value": "", "type": "path", "description": "The globally unique identifier for glossary." }, { "name": "ignoreTermsAndCategories", "value": "", "type": "query", "description": "Whether ignore terms and categories" } ] }, "docs": "Update the given glossary." }, { "info": { "name": "Microsoft Azure Delete Atlas Glossary Glossaryguid", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/atlas/v2/glossary/:glossaryGuid", "params": [ { "name": "glossaryGuid", "value": "", "type": "path", "description": "The globally unique identifier for glossary." } ] }, "docs": "Delete a glossary. Will delete underlying terms/categories together. Recommend separate delete terms and categories." }, { "info": { "name": "Microsoft Azure Get Atlas Glossary Glossaryguid Categories", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/atlas/v2/glossary/:glossaryGuid/categories", "params": [ { "name": "glossaryGuid", "value": "", "type": "path", "description": "The globally unique identifier for glossary." }, { "name": "limit", "value": "", "type": "query", "description": "The page size - by default there is no paging." }, { "name": "offset", "value": "", "type": "query", "description": "The offset for pagination purpose." }, { "name": "sort", "value": "", "type": "query", "description": "The sort order, ASC (default) or DESC." } ] }, "docs": "Get the categories belonging to a specific glossary. Recommend using limit/offset to get pagination result." }, { "info": { "name": "Microsoft Azure Get Atlas Glossary Glossaryguid Categories Headers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/atlas/v2/glossary/:glossaryGuid/categories/headers", "params": [ { "name": "glossaryGuid", "value": "", "type": "path", "description": "The globally unique identifier for glossary." }, { "name": "limit", "value": "", "type": "query", "description": "The page size - by default there is no paging." }, { "name": "offset", "value": "", "type": "query", "description": "The offset for pagination purpose." }, { "name": "sort", "value": "", "type": "query", "description": "The sort order, ASC (default) or DESC." } ] }, "docs": "Get the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination result." }, { "info": { "name": "Microsoft Azure Get Atlas Glossary Glossaryguid Detailed", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/atlas/v2/glossary/:glossaryGuid/detailed", "params": [ { "name": "glossaryGuid", "value": "", "type": "path", "description": "The globally unique identifier for glossary." }, { "name": "includeTermHierarchy", "value": "", "type": "query", "description": "Whether include term hierarchy" } ] }, "docs": "Get a specific glossary with detailed information. This API is not recommend. Recommended fetch terms/categories details separately using 'GET /catalog/api/atlas/v2/glossary/{glossaryGuid}/terms' and 'GET '/catalog/api/atlas/v2/glossary/{glossaryGuid}/categories'." }, { "info": { "name": "Microsoft Azure Put Atlas Glossary Glossaryguid Partial", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/atlas/v2/glossary/:glossaryGuid/partial", "params": [ { "name": "glossaryGuid", "value": "", "type": "path", "description": "The globally unique identifier for glossary." }, { "name": "ignoreTermsAndCategories", "value": "", "type": "query", "description": "Whether ignore terms and categories" } ] }, "docs": "Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated. So far we only supports partial updating shortDescription, longDescription, language and usage for glossary. Recommend using 'ignoreTermsAndCategories=true' to reduce response body size." }, { "info": { "name": "Microsoft Azure Get Atlas Glossary Glossaryguid Terms", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/atlas/v2/glossary/:glossaryGuid/terms", "params": [ { "name": "glossaryGuid", "value": "", "type": "path", "description": "The globally unique identifier for glossary." }, { "name": "includeTermHierarchy", "value": "", "type": "query", "description": "Whether include term hierarchy" }, { "name": "limit", "value": "", "type": "query", "description": "The page size - by default there is no paging." }, { "name": "offset", "value": "", "type": "query", "description": "The offset for pagination purpose." }, { "name": "sort", "value": "", "type": "query", "description": "The sort order, ASC (default) or DESC." } ] }, "docs": "Get terms belonging to a specific glossary. Recommend using limit/offset to get pagination result." }, { "info": { "name": "Microsoft Azure Get Atlas Glossary Glossaryguid Terms Headers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/atlas/v2/glossary/:glossaryGuid/terms/headers", "params": [ { "name": "glossaryGuid", "value": "", "type": "path", "description": "The globally unique identifier for glossary." }, { "name": "limit", "value": "", "type": "query", "description": "The page size - by default there is no paging." }, { "name": "offset", "value": "", "type": "query", "description": "The offset for pagination purpose." }, { "name": "sort", "value": "", "type": "query", "description": "The sort order, ASC (default) or DESC." } ] }, "docs": "Get term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result." }, { "info": { "name": "Microsoft Azure Post Glossary Glossaryguid Terms Import", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/glossary/:glossaryGuid/terms/import", "params": [ { "name": "glossaryGuid", "value": "", "type": "path", "description": "The globally unique identifier for glossary." }, { "name": "includeTermHierarchy", "value": "", "type": "query", "description": "Whether include term hierarchy" }, { "name": "includeMultiTemplates", "value": "", "type": "query", "description": "Whether include multi term templates for term import/export" }, { "name": "api-version", "value": "", "type": "query", "description": "Version of Purview APIs" } ] }, "docs": "Import Glossary Terms from local csv file. Note the csv file should be uploaded in formData with key='file'." }, { "info": { "name": "Microsoft Azure Post Glossary Name Glossaryname Terms Import", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/glossary/name/:glossaryName/terms/import", "params": [ { "name": "glossaryName", "value": "", "type": "path", "description": "The name of the glossary." }, { "name": "includeTermHierarchy", "value": "", "type": "query", "description": "Whether include term hierarchy" }, { "name": "includeMultiTemplates", "value": "", "type": "query", "description": "Whether include multi term templates for term import/export" }, { "name": "api-version", "value": "", "type": "query", "description": "Version of Purview APIs" } ] }, "docs": "Import Glossary Terms from local csv file by glossaryName. Note this API has been deprecated. Please use 'POST /catalog/api/glossary/{glossaryGuid}/terms/import' instead." }, { "info": { "name": "Microsoft Azure Get Glossary Terms Import Operationguid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/glossary/terms/import/:operationGuid", "params": [ { "name": "operationGuid", "value": "", "type": "path", "description": "The globally unique identifier for async operation job." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of Purview APIs" } ] }, "docs": "Get the status of import csv operation" }, { "info": { "name": "Microsoft Azure Post Glossary Glossaryguid Terms Export", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/glossary/:glossaryGuid/terms/export", "params": [ { "name": "glossaryGuid", "value": "", "type": "path", "description": "The globally unique identifier for glossary." }, { "name": "includeTermHierarchy", "value": "", "type": "query", "description": "Whether include term hierarchy" }, { "name": "includeMultiTemplates", "value": "", "type": "query", "description": "Whether include multi term templates for term import/export" }, { "name": "includeRichTextFlag", "value": "", "type": "query", "description": "Whether include rich text for term export" }, { "name": "api-version", "value": "", "type": "query", "description": "Version of Purview APIs" } ] }, "docs": "Export Glossary Terms as csv file" }, { "info": { "name": "Microsoft Azure Get Glossary Name Glossaryname Terms", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/glossary/name/:glossaryName/terms", "params": [ { "name": "glossaryName", "value": "", "type": "path", "description": "The name of the glossary." }, { "name": "limit", "value": "", "type": "query", "description": "The page size - by default there is no paging." }, { "name": "offset", "value": "", "type": "query", "description": "The offset for pagination purpose." }, { "name": "includeTermHierarchy", "value": "", "type": "query", "description": "Whether include term hierarchy" }, { "name": "extInfo", "value": "", "type": "query", "description": "Whether include extended information like contact display name and attribute values" }, { "name": "api-version", "value": "", "type": "query", "description": "Version of Purview APIs" } ] }, "docs": "Get terms by glossary name. Note this API has been deprecated. Please use 'GET /catalog/api/glossary/{glossaryGuid}/terms' instead." }, { "info": { "name": "Microsoft Azure Get Glossary Terms Bulkdeletion Operationguid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/glossary/terms/bulkDeletion/:operationGuid", "params": [ { "name": "operationGuid", "value": "", "type": "path", "description": "The globally unique identifier for async operation job." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of Purview APIs" } ] }, "docs": "Get the status of bulk delete operation" }, { "info": { "name": "Microsoft Azure Post Glossary Terms:delete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/glossary/terms:delete", "params": [ { "name": "forceDeleteEntityAssignment", "value": "", "type": "query", "description": "Whether delete entity assignment" }, { "name": "forceDeleteChild", "value": "", "type": "query", "description": "Whether delete child terms together with the parent term" }, { "name": "api-version", "value": "", "type": "query", "description": "Version of Purview APIs" } ] }, "docs": "Delete Glossary Terms" }, { "info": { "name": "Microsoft Azure Get Glossary Terms", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/glossary/terms", "params": [ { "name": "guid", "value": "", "type": "query", "description": "An array of GUIDs of terms to list." }, { "name": "excludeRelationshipTypes", "value": "", "type": "query", "description": "An array of the relationship types need to be excluded from the response." } ] }, "docs": "Get terms by guids." }, { "info": { "name": "Microsoft Azure Put Glossary Terms", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/glossary/terms" }, "docs": "Update terms in bulk." } ] } ], "bundled": true }