swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Glossary API
schemes:
- https
tags:
- name: Glossary
paths:
  /atlas/v2/glossary:
    get:
      tags:
      - Glossary
      description: 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'.
      operationId: microsoftAzureGlossaryListglossaries
      x-ms-examples:
        Glossary_ListGlossaries:
          $ref: ./examples/Glossary_ListGlossaries.json
      parameters:
      - $ref: '#/parameters/limit'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/sort'
      - $ref: '#/parameters/ignoreTermsAndCategories'
      responses:
        '200':
          description: An array of existing glossaries fitting the search criteria or empty list if nothing matches.
          schema:
            type: array
            items:
              $ref: '#/definitions/AtlasGlossary'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary
    post:
      tags:
      - Glossary
      description: Create a glossary.
      operationId: microsoftAzureGlossaryCreateglossary
      x-ms-examples:
        Glossary_CreateGlossary:
          $ref: ./examples/Glossary_CreateGlossary.json
      parameters:
      - in: body
        name: atlasGlossary
        description: 'Glossary definition, terms & categories can be anchored to a glossary.

          Using the anchor attribute when creating the Term/Category.'
        required: true
        schema:
          $ref: '#/definitions/AtlasGlossary'
      responses:
        '200':
          description: OK. If glossary creation was successful.
          schema:
            $ref: '#/definitions/AtlasGlossary'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Glossary
  /atlas/v2/glossary/categories:
    post:
      tags:
      - Glossary
      description: Create glossary category in bulk.
      operationId: microsoftAzureGlossaryCreateglossarycategories
      x-ms-examples:
        Glossary_CreateGlossaryCategories:
          $ref: ./examples/Glossary_CreateGlossaryCategories.json
      parameters:
      - in: body
        name: glossaryCategory
        description: An array of glossary category definitions to be created.
        required: true
        schema:
          type: array
          description: An array of glossary category definitions.
          items:
            $ref: '#/definitions/AtlasGlossaryCategory'
      responses:
        '200':
          description: OK. If bulk glossary category creation was successful.
          schema:
            type: array
            description: An array of glossary category created successfully in bulk.
            items:
              $ref: '#/definitions/AtlasGlossaryCategory'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Glossary Categories
  /atlas/v2/glossary/category:
    post:
      tags:
      - Glossary
      description: Create a glossary category.
      operationId: microsoftAzureGlossaryCreateglossarycategory
      x-ms-examples:
        Glossary_CreateGlossaryCategory:
          $ref: ./examples/Glossary_CreateGlossaryCategory.json
      parameters:
      - in: body
        name: glossaryCategory
        description: 'The glossary category definition. A category must be anchored to a Glossary when creating.

          Optionally, terms belonging to the category and the hierarchy can also be defined during creation.'
        required: true
        schema:
          $ref: '#/definitions/AtlasGlossaryCategory'
      responses:
        '200':
          description: OK. If glossary category creation was successful.
          schema:
            $ref: '#/definitions/AtlasGlossaryCategory'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Glossary Category
  /atlas/v2/glossary/category/{categoryGuid}:
    get:
      tags:
      - Glossary
      description: Get specific glossary category by its GUID.
      operationId: microsoftAzureGlossaryGetglossarycategory
      x-ms-examples:
        Glossary_GetGlossaryCategory:
          $ref: ./examples/Glossary_GetGlossaryCategory.json
      parameters:
      - $ref: '#/parameters/categoryGuid'
      responses:
        '200':
          description: OK. If glossary category exists for given GUID.
          schema:
            $ref: '#/definitions/AtlasGlossaryCategory'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Category Categoryguid
    put:
      tags:
      - Glossary
      description: Update the given glossary category by its GUID.
      operationId: microsoftAzureGlossaryUpdateglossarycategory
      x-ms-examples:
        Glossary_UpdateGlossaryCategory:
          $ref: ./examples/Glossary_UpdateGlossaryCategory.json
      parameters:
      - $ref: '#/parameters/categoryGuid'
      - in: body
        name: glossaryCategory
        description: The glossary category to be updated.
        required: true
        schema:
          $ref: '#/definitions/AtlasGlossaryCategory'
      responses:
        '200':
          description: OK. If glossary category partial update was successful.
          schema:
            $ref: '#/definitions/AtlasGlossaryCategory'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Glossary Category Categoryguid
    delete:
      tags:
      - Glossary
      description: Delete a glossary category.
      operationId: microsoftAzureGlossaryDeleteglossarycategory
      x-ms-examples:
        Glossary_DeleteGlossaryCategory:
          $ref: ./examples/Glossary_DeleteGlossaryCategory.json
      parameters:
      - $ref: '#/parameters/categoryGuid'
      responses:
        '204':
          description: OK. If glossary category deletion is successful.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Atlas Glossary Category Categoryguid
  /atlas/v2/glossary/category/{categoryGuid}/partial:
    put:
      tags:
      - Glossary
      description: Update the glossary category partially. So far we only supports partial updating shortDescription and longDescription for category.
      operationId: microsoftAzureGlossaryPartialupdateglossarycategory
      x-ms-examples:
        Glossary_PartialUpdateGlossaryCategory:
          $ref: ./examples/Glossary_PartialUpdateGlossaryCategory.json
      parameters:
      - $ref: '#/parameters/categoryGuid'
      - in: body
        name: partialUpdates
        description: A map containing keys as attribute names and values as corresponding attribute values for partial update.
        required: true
        schema:
          type: object
          description: A map containing keys as attribute names and values as corresponding attribute values.
      responses:
        '200':
          description: OK. If glossary category partial update was successful.
          schema:
            $ref: '#/definitions/AtlasGlossaryCategory'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Glossary Category Categoryguid Partial
  /atlas/v2/glossary/category/{categoryGuid}/related:
    get:
      tags:
      - Glossary
      description: 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.
      operationId: microsoftAzureGlossaryListrelatedcategories
      x-ms-examples:
        Glossary_ListRelatedCategories:
          $ref: ./examples/Glossary_ListRelatedCategories.json
      parameters:
      - $ref: '#/parameters/categoryGuid'
      - $ref: '#/parameters/limit'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/sort'
      responses:
        '200':
          description: OK. Gets an array of related categories.
          schema:
            type: object
            description: An array of related categories.
            additionalProperties:
              type: array
              items:
                $ref: '#/definitions/AtlasRelatedCategoryHeader'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Category Categoryguid Related
  /atlas/v2/glossary/category/{categoryGuid}/terms:
    get:
      tags:
      - Glossary
      description: Get all terms associated with the specific category.
      operationId: microsoftAzureGlossaryListcategoryterms
      x-ms-examples:
        Glossary_ListCategoryTerms:
          $ref: ./examples/Glossary_ListCategoryTerms.json
      parameters:
      - $ref: '#/parameters/categoryGuid'
      - $ref: '#/parameters/limit'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/sort'
      responses:
        '200':
          description: An array of terms for the given category or an empty list.
          schema:
            type: array
            description: An array of terms for the given category or an empty list.
            items:
              $ref: '#/definitions/AtlasRelatedTermHeader'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Category Categoryguid Terms
  /atlas/v2/glossary/term:
    post:
      tags:
      - Glossary
      description: Create a glossary term.
      operationId: microsoftAzureGlossaryCreateglossaryterm
      x-ms-examples:
        Glossary_CreateGlossaryTerm:
          $ref: ./examples/Glossary_CreateGlossaryTerm.json
        Glossary_CreateGlossaryTermWithTermTemplate:
          $ref: ./examples/Glossary_CreateGlossaryTermWithTermTemplate.json
      parameters:
      - in: body
        name: glossaryTerm
        description: 'The glossary term definition. A term must be anchored to a Glossary at the time of creation.

          Optionally it can be categorized as well.'
        required: true
        schema:
          $ref: '#/definitions/AtlasGlossaryTerm'
      - $ref: '#/parameters/includeTermHierarchy'
      responses:
        '200':
          description: OK. If glossary term creation was successful.
          schema:
            $ref: '#/definitions/AtlasGlossaryTerm'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Glossary Term
  /atlas/v2/glossary/term/{termGuid}:
    get:
      tags:
      - Glossary
      description: 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.
      operationId: microsoftAzureGlossaryGetglossaryterm
      x-ms-examples:
        Glossary_GetGlossaryTerm:
          $ref: ./examples/Glossary_GetGlossaryTerm.json
        Glossary_GetGlossaryTerm_WithoutAssets:
          $ref: ./examples/Glossary_GetGlossaryTerm_WithoutAssets.json
      parameters:
      - $ref: '#/parameters/termGuid'
      - $ref: '#/parameters/includeTermHierarchy'
      - name: excludeRelationshipTypes
        in: query
        description: An array of relationship types which need to be excluded.
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
        x-ms-client-name: excludeRelationshipTypeList
      responses:
        '200':
          description: OK. If glossary term exists for given GUID.
          schema:
            $ref: '#/definitions/AtlasGlossaryTerm'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Term Termguid
    put:
      tags:
      - Glossary
      description: Update the given glossary term by its GUID.
      operationId: microsoftAzureGlossaryUpdateglossaryterm
      x-ms-examples:
        Glossary_UpdateGlossaryTerm:
          $ref: ./examples/Glossary_UpdateGlossaryTerm.json
      parameters:
      - $ref: '#/parameters/termGuid'
      - in: body
        name: glossaryTerm
        description: The glossary term to be updated.
        required: true
        schema:
          $ref: '#/definitions/AtlasGlossaryTerm'
      - $ref: '#/parameters/includeTermHierarchy'
      responses:
        '200':
          description: OK. If glossary term update was successful.
          schema:
            $ref: '#/definitions/AtlasGlossaryTerm'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Glossary Term Termguid
    delete:
      tags:
      - Glossary
      description: Delete a glossary term.
      operationId: microsoftAzureGlossaryDeleteglossaryterm
      x-ms-examples:
        Glossary_DeleteGlossaryTerm:
          $ref: ./examples/Glossary_DeleteGlossaryTerm.json
      parameters:
      - $ref: '#/parameters/termGuid'
      responses:
        '204':
          description: OK. If glossary term delete was successful.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Atlas Glossary Term Termguid
  /atlas/v2/glossary/term/{termGuid}/partial:
    put:
      tags:
      - Glossary
      description: Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term.
      operationId: microsoftAzureGlossaryPartialupdateglossaryterm
      x-ms-examples:
        Glossary_PartialUpdateGlossaryTerm:
          $ref: ./examples/Glossary_PartialUpdateGlossaryTerm.json
      parameters:
      - $ref: '#/parameters/termGuid'
      - $ref: '#/parameters/includeTermHierarchy'
      - in: body
        name: partialUpdates
        description: A map containing keys as attribute names and values as corresponding attribute values to be updated.
        required: true
        schema:
          type: object
          description: A map containing keys as attribute names and values as corresponding attribute values.
      responses:
        '200':
          description: OK. If glossary partial update was successful.
          schema:
            $ref: '#/definitions/AtlasGlossaryTerm'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Glossary Term Termguid Partial
  /atlas/v2/glossary/terms:
    post:
      tags:
      - Glossary
      description: Create glossary terms in bulk.
      operationId: microsoftAzureGlossaryCreateglossaryterms
      x-ms-examples:
        Glossary_CreateGlossaryTerms:
          $ref: ./examples/Glossary_CreateGlossaryTerms.json
      parameters:
      - in: body
        name: glossaryTerm
        description: An array of glossary term definitions to be created in bulk.
        required: true
        schema:
          type: array
          description: An array of glossary term definitions.
          items:
            $ref: '#/definitions/AtlasGlossaryTerm'
      - $ref: '#/parameters/includeTermHierarchy'
      responses:
        '200':
          description: OK. If bulk glossary terms creation was successful.
          schema:
            type: array
            description: If bulk glossary terms creation was successful.
            items:
              $ref: '#/definitions/AtlasGlossaryTerm'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Glossary Terms
  /atlas/v2/glossary/terms/{termGuid}/assignedEntities:
    get:
      tags:
      - Glossary
      description: Get all related objects assigned with the specified term. Recommend using limit/offset to get pagination result.
      operationId: microsoftAzureGlossaryGetentitiesassignedwithterm
      x-ms-examples:
        Glossary_GetEntitiesAssignedWithTerm:
          $ref: ./examples/Glossary_ListEntitiesAssignedWithTerm.json
      parameters:
      - $ref: '#/parameters/termGuid'
      - $ref: '#/parameters/limit'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/sort'
      responses:
        '200':
          description: OK. An array of related objects (if any) for the given glossary or an empty list.
          schema:
            type: array
            description: An array of related objects (if any) for the given glossary or an empty list.
            items:
              $ref: '#/definitions/AtlasRelatedObjectId'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Terms Termguid Assignedentities
    post:
      tags:
      - Glossary
      description: Assign the given term to the provided list of related objects. Recommend using small batches with multiple API calls.
      operationId: microsoftAzureGlossaryAssigntermtoentities
      x-ms-examples:
        Glossary_AssignTermToEntities:
          $ref: ./examples/Glossary_AssignTermToEntities.json
      parameters:
      - $ref: '#/parameters/termGuid'
      - in: body
        name: relatedObjectIds
        description: An array of related object IDs to which the term has to be associated.
        required: true
        schema:
          type: array
          description: An array of related object IDs to which the term has to be associated.
          items:
            $ref: '#/definitions/AtlasRelatedObjectId'
      responses:
        '204':
          description: OK. If the term assignment was successful.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Glossary Terms Termguid Assignedentities
    put:
      tags:
      - Glossary
      description: 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.
      operationId: microsoftAzureGlossaryRemovetermassignmentfromentities
      x-ms-examples:
        Glossary_RemoveTermAssignmentFromEntities:
          $ref: ./examples/Glossary_RemoveTermAssignmentFromEntities.json
      parameters:
      - $ref: '#/parameters/termGuid'
      - in: body
        name: relatedObjectIds
        description: An array of related object IDs from which the term has to be dissociated.
        required: true
        schema:
          type: array
          description: An array of related object IDs from which the term has to be dissociated.
          items:
            $ref: '#/definitions/AtlasRelatedObjectId'
      responses:
        '204':
          description: OK. If glossary term dissociation was successful.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Glossary Terms Termguid Assignedentities
    delete:
      tags:
      - Glossary
      description: Delete the term assignment for the given list of related objects.
      operationId: microsoftAzureGlossaryDeletetermassignmentfromentities
      x-ms-examples:
        Glossary_RemoveTermAssignmentFromEntities:
          $ref: ./examples/Glossary_RemoveTermAssignmentFromEntities.json
      parameters:
      - $ref: '#/parameters/termGuid'
      - in: body
        name: relatedObjectIds
        description: An array of related object IDs from which the term has to be dissociated.
        required: true
        schema:
          type: array
          description: An array of related object IDs from which the term has to be dissociated.
          items:
            $ref: '#/definitions/AtlasRelatedObjectId'
      responses:
        '204':
          description: OK. If glossary term dissociation was successful.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Atlas Glossary Terms Termguid Assignedentities
  /atlas/v2/glossary/terms/{termGuid}/related:
    get:
      tags:
      - Glossary
      description: 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.
      operationId: microsoftAzureGlossaryListrelatedterms
      x-ms-examples:
        Glossary_ListRelatedTerms:
          $ref: ./examples/Glossary_ListRelatedTerms.json
      parameters:
      - $ref: '#/parameters/termGuid'
      - $ref: '#/parameters/limit'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/sort'
      - $ref: '#/parameters/includeTermHierarchy'
      responses:
        '200':
          description: OK. An array of related glossary terms for the given glossary or an empty list.
          schema:
            type: object
            description: An array of related glossary terms for the given glossary or an empty list.
            additionalProperties:
              type: array
              items:
                $ref: '#/definitions/AtlasRelatedTermHeader'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Terms Termguid Related
  /atlas/v2/glossary/{glossaryGuid}:
    get:
      tags:
      - Glossary
      description: Get a specific Glossary by its GUID.
      operationId: microsoftAzureGlossaryGetglossary
      x-ms-examples:
        Glossary_GetGlossary:
          $ref: ./examples/Glossary_GetGlossary.json
      parameters:
      - $ref: '#/parameters/glossaryGuid'
      responses:
        '200':
          description: OK. If glossary with given guid exists.
          schema:
            $ref: '#/definitions/AtlasGlossary'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Glossaryguid
    put:
      tags:
      - Glossary
      description: Update the given glossary.
      operationId: microsoftAzureGlossaryUpdateglossary
      x-ms-examples:
        Glossary_UpdateGlossary:
          $ref: ./examples/Glossary_UpdateGlossary.json
      parameters:
      - $ref: '#/parameters/glossaryGuid'
      - $ref: '#/parameters/ignoreTermsAndCategories'
      - in: body
        name: updatedGlossary
        description: The glossary definition to be updated.
        required: true
        schema:
          $ref: '#/definitions/AtlasGlossary'
      responses:
        '200':
          description: OK. If glossary update was successful.
          schema:
            $ref: '#/definitions/AtlasGlossary'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Glossary Glossaryguid
    delete:
      tags:
      - Glossary
      description: Delete a glossary. Will delete underlying terms/categories together. Recommend separate delete terms and categories.
      operationId: microsoftAzureGlossaryDeleteglossary
      x-ms-examples:
        Glossary_DeleteGlossary:
          $ref: ./examples/Glossary_DeleteGlossary.json
      parameters:
      - $ref: '#/parameters/glossaryGuid'
      responses:
        '204':
          description: OK. If glossary delete was successful.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Atlas Glossary Glossaryguid
  /atlas/v2/glossary/{glossaryGuid}/categories:
    get:
      tags:
      - Glossary
      description: Get the categories belonging to a specific glossary. Recommend using limit/offset to get pagination result.
      operationId: microsoftAzureGlossaryListglossarycategories
      x-ms-examples:
        Glossary_ListGlossaryCategories:
          $ref: ./examples/Glossary_ListGlossaryCategories.json
      parameters:
      - $ref: '#/parameters/glossaryGuid'
      - $ref: '#/parameters/limit'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/sort'
      responses:
        '200':
          description: OK. An array of glossary categories for the given glossary or an empty list.
          schema:
            type: array
            description: An array of glossary categories for the given glossary or an empty list.
            items:
              $ref: '#/definitions/AtlasGlossaryCategory'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Glossaryguid Categories
  /atlas/v2/glossary/{glossaryGuid}/categories/headers:
    get:
      tags:
      - Glossary
      description: Get the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.
      operationId: microsoftAzureGlossaryListglossarycategoriesheaders
      x-ms-examples:
        Glossary_ListGlossaryCategoriesHeaders:
          $ref: ./examples/Glossary_ListGlossaryCategoriesHeaders.json
      parameters:
      - $ref: '#/parameters/glossaryGuid'
      - $ref: '#/parameters/limit'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/sort'
      responses:
        '200':
          description: OK. An array of glossary category headers for the given glossary or an empty list.
          schema:
            type: array
            description: An array of glossary category headers for the given glossary or an empty list.
            items:
              $ref: '#/definitions/AtlasRelatedCategoryHeader'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Glossaryguid Categories Headers
  /atlas/v2/glossary/{glossaryGuid}/detailed:
    get:
      tags:
      - Glossary
      description: 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'.
      operationId: microsoftAzureGlossaryGetdetailedglossary
      x-ms-examples:
        Glossary_GetDetailedGlossary:
          $ref: ./examples/Glossary_GetDetailedGlossary.json
      parameters:
      - $ref: '#/parameters/glossaryGuid'
      - $ref: '#/parameters/includeTermHierarchy'
      responses:
        '200':
          description: OK. If glossary exists for given GUID.
          schema:
            $ref: '#/definitions/AtlasGlossaryExtInfo'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Glossaryguid Detailed
  /atlas/v2/glossary/{glossaryGuid}/partial:
    put:
      tags:
      - Glossary
      description: 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.
      operationId: microsoftAzureGlossaryPartialupdateglossary
      x-ms-examples:
        Glossary_PartialUpdateGlossary:
          $ref: ./examples/Glossary_PartialUpdateGlossary.json
      parameters:
      - $ref: '#/parameters/glossaryGuid'
      - $ref: '#/parameters/ignoreTermsAndCategories'
      - in: body
        name: partialUpdates
        description: A map containing keys as attribute names and values as corresponding attribute values.
        required: true
        schema:
          type: object
          description: A map containing keys as attribute names and values as corresponding attribute values.
      responses:
        '200':
          description: OK. If glossary partial update was successful.
          schema:
            $ref: '#/definitions/AtlasGlossary'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Glossary Glossaryguid Partial
  /atlas/v2/glossary/{glossaryGuid}/terms:
    get:
      tags:
      - Glossary
      description: Get terms belonging to a specific glossary. Recommend using limit/offset to get pagination result.
      operationId: microsoftAzureGlossaryListglossaryterms
      x-ms-examples:
        Glossary_ListGlossaryTerms:
          $ref: ./examples/Glossary_ListGlossaryTerms.json
      parameters:
      - $ref: '#/parameters/glossaryGuid'
      - $ref: '#/parameters/includeTermHierarchy'
      - $ref: '#/parameters/limit'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/sort'
      responses:
        '200':
          description: OK. An array of glossary terms for the given glossary or an empty list.
          schema:
            type: array
            description: An array of glossary terms for the given glossary or an empty list.
            items:
              $ref: '#/definitions/AtlasGlossaryTerm'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Glossaryguid Terms
  /atlas/v2/glossary/{glossaryGuid}/terms/headers:
    get:
      tags:
      - Glossary
      description: Get term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.
      operationId: microsoftAzureGlossaryListglossarytermheaders
      x-ms-examples:
        Glossary_ListGlossaryTermHeaders:
          $ref: ./examples/Glossary_ListGlossaryTermHeaders.json
      parameters:
      - $ref: '#/parameters/glossaryGuid'
      - $ref: '#/parameters/limit'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/sort'
      responses:
        '200':
          description: OK. An array of glossary terms for the given glossary or an empty list.
          schema:
            type: array
            description: An array of glossary terms for the given glossary or an empty list.
            items:
              $ref: '#/definitions/AtlasRelatedTermHeader'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Glossaryguid Terms Headers
  /glossary/{glossaryGuid}/terms/import:
    post:
      tags:
      - Glossary
      consumes:
      - multipart/form-data
      description: Import Glossary Terms from local csv file. Note the csv file should be uploaded in formData with key='file'.
      operationId: microsoftAzureGlossaryImportglossarytermsviacsv
      x-ms-examples:
        Glossary_ImportGlossaryTermsViaCsv:
          $ref: ./examples/Glossary_GetImportCSVOperationStatus.json
      parameters:
      - $ref: '#/parameters/glossaryGuid'
      - $ref: '#/parameters/includeTermHierarchy'
      - $ref: '#/parameters/includeMultiTemplates'
      - in: formData
        name: file
        description: The csv file to import glossary terms from.
        required: true
        type: file
      - $ref: '#/parameters/purviewAPIVersion'
      responses:
        '202':
          description: Accepted. A job to import glossary terms via csv has been accepted.
          headers:
            Operation-Location:
              description: Response header for long running operation
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      summary: Microsoft Azure Post Glossary Glossaryguid Terms Import
  /glossary/name/{glossaryName}/terms/import:
    post:
      tags:
      - Glossary
      consumes:
      - multipart/form-data
      description: 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.
      operationId: microsoftAzureGlossaryImportglossarytermsviacsvbyglossaryname
      x-ms-examples:
        Glossary_ImportGlossaryTermsViaCsvByGlossaryName:
          $ref: ./examples/Glossary_GetImportCSVOperationStatusByGloassaryName.json
      parameters:
      - $ref: '#/parameters/glossaryName'
      - $ref: '#/parameters/includeTermHierarchy'
      - $ref: '#/parameters/includeMultiTemplates'
      - in: formData
        name: file
        description: The csv file to import glossary terms from.
        required: true
        type: file
      - $ref: '#/parameters/purviewAPIVersion'
      responses:
        '202':
          description: Accepted. A job to import glossary terms via csv has been accepted.
          headers:
            Operation-Location:
              description: Response header for long running operation
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      summary: Microsoft Azure Post Glossary Name Glossaryname Terms Import
  /glossary/terms/import/{operationGuid}:
    get:
      tags:
      - Glossary
      description: Get the status of import csv operation
      operationId: microsoftAzureGlossaryGetimportcsvoperationstatus
      x-ms-examples:
        Glossary_GetImportCsvOperationStatus:
          $ref: ./examples/Glossary_GetImportCSVOperationStatusByOperationguid.json
      parameters:
      - $ref: '#/parameters/operationGuid'
      - $ref: '#/parameters/purviewAPIVersion'
      responses:
        '200':
          description: OK. Return the status of import csv operation.
          schema:
            $ref: '#/definitions/ImportCSVOperation'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Glossary Terms Import Operationguid
  /glossary/{glossaryGuid}/terms/export:
    post:
      tags:
      - Glossary
      description: Export Glossary Terms as csv file
      operationId: microsoftAzureGlossaryExportglossarytermsascsv
      x-ms-examples:
        Glossary_ExportGlossaryTermsAsCsv:
          $ref: ./examples/Glossary_ExportGlossaryTermsAsCsv.json
      produces:
      - text/csv
      parameters:
      - $ref: '#/parameters/glossaryGuid'
      - $ref: '#/parameters/includeTermHierarchy'
      - $ref: '#/parameters/includeMultiTemplates'
      - $ref: '#/parameters/includeRichTextFlag'
      - in: body
        name: termGuids
        description: An array of term guids.
        required: true
        schema:
          type: array
          description: An array of term guids.
          items:
            $ref: '#/definitions/TermGuid'
      - $ref: '#/parameters/purviewAPIVersion'
      responses:
        '200':
          description: OK. A csv file contains terms with given term guids will be generated.
          schema:
            type: file
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Glossary Glossaryguid Terms Export
  /glossary/name/{glossaryName}/terms:
    get:
      tags:
      - Glossary
      description: Get terms by glossary name. Note this API has been deprecated. Please use 'GET /catalog/api/glossary/{glossaryGuid}/terms' instead.
      operationId: microsoftAzureGlossaryListtermsbyglossaryname
      x-ms-examples:
        Glossary_ListTermsByGlossaryName:
          $ref: ./examples/Glossary_ListTermsByGlossaryName.json
      parameters:
      - $ref: '#/parameters/glossaryName'
      - $ref: '#/parameters/limit'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/includeTermHierarchy'
      - $ref: '#/parameters/extInfo'
      - $ref: '#/parameters/purviewAPIVersion'
      responses:
        '200':
          description: OK. An array of glossary terms for the given glossary or an empty list.
          schema:
            type: array
            description: An array of glossary terms for the given glossary or an empty list.
            items:
              $ref: '#/definitions/AtlasGlossaryTerm'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Glossary Name Glossaryname Terms
  /glossary/terms/bulkDeletion/{operationGuid}:
    get:
      tags:
      - Glossary
      description: Get the status of bulk delete operation
      operationId: microsoftAzureGlossaryGetbulkdeleteoperationstatus
      x-ms-examples:
        Glossary_GetBulkDeleteOperationStatus:
          $ref: ./examples/Glossary_GetBulkDeleteOperationStatusByOperationguid.json
      parameters:
      - $ref: '#/parameters/operationGuid'
      - $ref: '#/parameters/purviewAPIVersion'
      responses:
        '200':
          description: OK. Return the status of bulk delete operation.
          schema:
            $ref: '#/definitions/BulkDeleteOperation'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Glossary Terms Bulkdeletion Operationguid
  /glossary/terms:delete:
    post:
      tags:
      - Glossary
      description: Delete Glossary Terms
      operationId: microsoftAzureGlossaryBulkdeletetermsbyguids
      x-ms-examples:
        Glossary_BulkDeleteTermsByGuids:
          $ref: ./examples/Glossary_GetBulkDeleteOperationStatus.json
      parameters:
      - $ref: '#/parameters/forceDeleteEntityAssignment'
      - $ref: '#/parameters/forceDeleteChild'
      - $ref: '#/parameters/purviewAPIVersion'
      - in: body
        name: termGuids
        description: An array of term guids to be deleted.
        required: true
        schema:
          type: array
          description: An array of term guids to be deleted.
          items:
            $ref: '#/definitions/TermGuid'
      responses:
        '202':
          description: Accepted. A job to delete glossary terms has been accepted.
          headers:
            Operation-Location:
              description: Response header for long running operation
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      summary: Microsoft Azure Post Glossary Terms:delete
  /glossary/terms:
    put:
      tags:
      - Glossary
      description: Update terms in bulk.
      operationId: microsoftAzureGlossaryBulkupdateterms
      x-ms-examples:
        Glossary_BulkUpdateGlossaryTerms:
          $ref: ./examples/Glossary_BulkUpdateGlossaryTerms.json
      parameters:
      - in: body
        name: terms
        description: An array of terms to update.
        required: true
        schema:
          type: array
          description: An array of glossary terms.
          items:
            $ref: '#/definitions/AtlasGlossaryTerm'
      responses:
        '200':
          description: OK. An array of glossary terms.
          schema:
            type: array
            description: An array of glossary terms.
            items:
              $ref: '#/definitions/AtlasGlossaryTerm'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Glossary Terms
    get:
      tags:
      - Glossary
      description: Get terms by guids.
      operationId: microsoftAzureGlossaryListtermsbyguids
      x-ms-examples:
        Glossary_ListGlossaryTermsByGuids:
          $ref: ./examples/Glossary_ListGlossaryTermsByGuids.json
      parameters:
      - name: guid
        in: query
        description: An array of GUIDs of terms to list.
        required: true
        type: array
        items:
          type: string
        collectionFormat: multi
        x-ms-client-name: guids
      - $ref: '#/parameters/excludeRelationshipTypes'
      responses:
        '200':
          description: OK. An array of glossary terms or an empty list.
          schema:
            type: array
            description: An array of glossary terms or an empty list.
            items:
              $ref: '#/definitions/AtlasGlossaryTerm'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Glossary Terms
definitions:
  LastModifiedTS:
    type: string
    title: lastModifiedTS
    description: ETag for concurrency control.
  BulkDeleteOperationProperties:
    type: object
    properties:
      deletedTerms:
        type: string
        description: Term numbers that already deleted successfully
      totalTermsDetected:
        type: string
        description: Total term numbers that detected in a bulk delete job
  AtlasRelatedTermHeader:
    type: object
    properties:
      description:
        type: string
        description: The description of the related term.
      displayText:
        type: string
        description: The display text.
      expression:
        type: string
        description: The expression of the term.
      relationGuid:
        type: string
        description: The GUID of the relationship.
      source:
        type: string
        description: The source of the term.
      status:
        $ref: '#/definitions/AtlasTermRelationshipStatus'
      steward:
        type: string
        description: The steward of the term.
      termGuid:
        type: string
        description: The GUID of the term.
    title: AtlasRelatedTermHeader
    description: The header of the related term.
  TermCustomAttributesExtraProperties:
    type: object
    description: The term attribute name and attribute value, which is map<string,object>
    additionalProperties:
      description: The value of custom term attribute
  AtlasGlossaryTerm:
    type: object
    title: AtlasGlossaryTerm
    allOf:
    - $ref: '#/definitions/AtlasGlossaryBaseObject'
    - properties:
        abbreviation:
          type: string
          description: The abbreviation of the term.
        templateName:
          type: array
          items:
            type: object
        anchor:
          $ref: '#/definitions/AtlasGlossaryHeader'
        antonyms:
          type: array
          description: An array of related term headers as antonyms.
          items:
            $ref: '#/definitions/AtlasRelatedTermHeader'
        status:
          $ref: '#/definitions/TermStatus'
        nickName:
          type: string
          description: The nick name of the term.
        hierarchyInfo:
          type: array
          description: The hierarchy information of the term.
          items:
            $ref: '#/definitions/PurviewObjectId'
        resources:
          type: array
          description: An array of resource link for term
          items:
            $ref: '#/definitions/ResourceLink'
        contacts:
          type: object
          description: The dictionary of contacts for terms. Key could be Expert or Steward.
          additionalProperties:
            type: array
            items:
              $ref: '#/definitions/ContactBasic'
        attributes:
          $ref: '#/definitions/TermCustomAttributes'
        assignedEntities:
          type: array
          description: An array of related object IDs.
          items:
            $ref: '#/definitions/AtlasRelatedObjectId'
        categories:
          type: array
          description: An array of term categorization headers.
          items:
            $ref: '#/definitions/AtlasTermCategorizationHeader'
        classifies:
          type: array
          description: An array of related term headers.
          items:
            $ref: '#/definitions/AtlasRelatedTermHeader'
        examples:
          type: array
          description: An array of examples.
          items:
            type: string
        isA:
          type: array
          description: An array of related term headers indicating the is-a relationship.
          items:
            $ref: '#/definitions/AtlasRelatedTermHeader'
        preferredTerms:
          type: array
          description: An array of preferred related term headers.
          items:
            $ref: '#/definitions/AtlasRelatedTermHeader'
        preferredToTerms:
          type: array
          description: An array of related term headers that are preferred to.
          items:
            $ref: '#/definitions/AtlasRelatedTermHeader'
        replacedBy:
          type: array
          description: An array of related term headers that are replaced by.
          items:
            $ref: '#/definitions/AtlasRelatedTermHeader'
        replacementTerms:
          type: array
          description: An array of related term headers for replacement.
          items:
            $ref: '#/definitions/AtlasRelatedTermHeader'
        seeAlso:
          type: array
          description: An array of related term headers for see also.
          items:
            $ref: '#/definitions/AtlasRelatedTermHeader'
        synonyms:
          type: array
          description: An array of related term headers as synonyms.
          items:
            $ref: '#/definitions/AtlasRelatedTermHeader'
        translatedTerms:
          type: array
          description: An array of translated related term headers.
          items:
            $ref: '#/definitions/AtlasRelatedTermHeader'
        translationTerms:
          type: array
          description: An array of related term headers for translation.
          items:
            $ref: '#/definitions/AtlasRelatedTermHeader'
        usage:
          type: string
          description: The usage of the term.
        validValues:
          type: array
          description: An array of related term headers as valid values.
          items:
            $ref: '#/definitions/AtlasRelatedTermHeader'
        validValuesFor:
          type: array
          description: An array of related term headers as valid values for other records.
          items:
            $ref: '#/definitions/AtlasRelatedTermHeader'
    description: The glossary term.
  AtlasRelatedObjectId:
    type: object
    title: AtlasRelatedObjectId
    allOf:
    - $ref: '#/definitions/AtlasObjectId'
    - properties:
        displayText:
          type: string
          description: The display text.
        entityStatus:
          $ref: '#/definitions/Status'
        relationshipType:
          type: string
        relationshipAttributes:
          $ref: '#/definitions/AtlasStruct'
        relationshipGuid:
          type: string
          description: The GUID of the relationship.
        relationshipStatus:
          $ref: '#/definitions/Status_AtlasRelationship'
    description: Reference to an object-instance of AtlasEntity type used in relationship attribute values
  AtlasGlossary:
    type: object
    title: AtlasGlossary
    allOf:
    - $ref: '#/definitions/AtlasGlossaryBaseObject'
    - properties:
        categories:
          type: array
          description: An array of categories.
          items:
            $ref: '#/definitions/AtlasRelatedCategoryHeader'
        language:
          type: string
          description: The language of the glossary.
        terms:
          type: array
          description: An array of related term headers.
          items:
            $ref: '#/definitions/AtlasRelatedTermHeader'
        usage:
          type: string
          description: The usage of the glossary.
    description: The glossary object.
  AtlasObjectId:
    type: object
    properties:
      guid:
        type: string
        description: The GUID of the object.
      typeName:
        type: string
        description: The name of the type.
      uniqueAttributes:
        type: object
        description: The unique attributes of the object.
        additionalProperties: {}
    title: AtlasObjectId
    description: Reference to an object-instance of an Atlas type - like entity.
  ImportCSVOperation:
    type: object
    title: Status of import csv operation
    description: The status of import csv operation
    required:
    - id
    - status
    properties:
      id:
        type: string
      status:
        $ref: '#/definitions/ImportCSVOperationStatus'
      createTime:
        type: string
        description: The created time of the record.
      lastUpdateTime:
        type: string
        description: The last updated time of the record.
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ImportCSVOperationProperties'
      error:
        x-ms-client-flatten: true
        $ref: '#/definitions/AsyncOperationError'
  AtlasGlossaryHeader:
    type: object
    properties:
      displayText:
        type: string
        description: The display text.
      glossaryGuid:
        type: string
        description: The GUID of the glossary.
      relationGuid:
        type: string
        description: The GUID of the relationship.
    title: AtlasGlossaryHeader
    description: The glossary header with basic information.
  AtlasStruct:
    type: object
    properties:
      attributes:
        type: object
        description: The attributes of the struct.
        additionalProperties: {}
      typeName:
        type: string
        description: The name of the type.
      lastModifiedTS:
        $ref: '#/definitions/LastModifiedTS'
    title: AtlasStruct
    description: Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.
  ContactBasic:
    title: ContactBasic
    type: object
    properties:
      id:
        type: string
        description: Azure Active Directory object Id.
      info:
        type: string
        description: additional information to describe this contact.
  ImportCSVOperationStatus:
    type: string
    enum:
    - NotStarted
    - Succeeded
    - Failed
    - Running
    x-ms-enum:
      name: ImportCSVOperationStatus
      modelAsString: true
    title: ImportCSVOperationStatus
    description: Enum of the status of import csv operation.
  AtlasGlossaryExtInfo:
    type: object
    title: AtlasGlossaryExtInfo
    allOf:
    - $ref: '#/definitions/AtlasGlossary'
    - properties:
        categoryInfo:
          type: object
          description: The glossary category information.
          additionalProperties:
            $ref: '#/definitions/AtlasGlossaryCategory'
        termInfo:
          type: object
          description: The glossary term information.
          additionalProperties:
            $ref: '#/definitions/AtlasGlossaryTerm'
    description: The extended information of glossary.
  TermCustomAttributes:
    title: attributes
    description: 'The custom attributes of the term, which is map<string,map<string,object>>.

      The key of the first layer map is term template name.'
    type: object
    additionalProperties:
      $ref: '#/definitions/TermCustomAttributesExtraProperties'
  AtlasBaseModelObject:
    type: object
    properties:
      guid:
        type: string
        description: The GUID of the object.
    title: AtlasBaseModelObject
    description: The base model object.
  BulkDeleteOperationStatus:
    type: string
    enum:
    - NotStarted
    - Succeeded
    - Failed
    - Running
    x-ms-enum:
      name: BulkDeleteOperationStatus
      modelAsString: true
    title: BulkDeleteOperationStatus
    description: Enum of the status of bulk delete operation.
  AtlasRelatedCategoryHeader:
    type: object
    properties:
      categoryGuid:
        type: string
        description: The GUID of the category.
      description:
        type: string
        description: The description of the category header.
      displayText:
        type: string
        description: The display text.
      parentCategoryGuid:
        type: string
        description: The GUID of the parent category.
      relationGuid:
        type: string
        description: The GUID of the relationship.
    title: AtlasRelatedCategoryHeader
    description: The header of the related category.
  ImportCSVOperationProperties:
    type: object
    properties:
      importedTerms:
        type: string
        description: Term numbers that already imported successfully
      totalTermsDetected:
        type: string
        description: Total term numbers that detected in csv
  Status:
    type: string
    title: Status
    description: Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.
    enum:
    - ACTIVE
    - DELETED
    x-ms-enum:
      name: Status
      modelAsString: true
  AtlasTermRelationshipStatus:
    type: string
    title: AtlasTermRelationshipStatus
    description: The status of term relationship.
    enum:
    - DRAFT
    - ACTIVE
    - DEPRECATED
    - OBSOLETE
    - OTHER
    x-ms-enum:
      name: AtlasTermRelationshipStatus
      modelAsString: true
  AtlasClassification:
    type: object
    title: AtlasClassification
    allOf:
    - $ref: '#/definitions/AtlasStruct'
    - properties:
        entityGuid:
          type: string
          description: The GUID of the entity.
        entityStatus:
          $ref: '#/definitions/Status'
        removePropagationsOnEntityDelete:
          type: boolean
          description: Determines if propagations will be removed on entity deletion.
        validityPeriods:
          type: array
          description: An array of time boundaries indicating validity periods.
          items:
            $ref: '#/definitions/TimeBoundary'
        source:
          type: string
          description: indicate the source who create the classification detail
        sourceDetails:
          type: object
          additionalProperties:
            type: object
            properties: {}
          description: more detail on source information
    description: An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.
  ErrorResponse:
    description: An error response from the service
    type: object
    properties:
      requestId:
        type: string
        description: The request ID.
      errorCode:
        type: string
        description: The error code.
      errorMessage:
        type: string
        description: The error message.
  TimeBoundary:
    type: object
    properties:
      endTime:
        type: string
        description: The end of the time boundary.
      startTime:
        type: string
        description: The start of the time boundary.
      timeZone:
        type: string
        description: The timezone of the time boundary.
    title: TimeBoundary
    description: Captures time-boundary details
  ResourceLink:
    title: ResourceLink
    type: object
    properties:
      displayName:
        type: string
        description: Display name for url.
      url:
        type: string
        description: web url. http or https
  PurviewObjectId:
    type: object
    properties:
      name:
        type: string
      displayText:
        type: string
      itemPath:
        type: string
      resourceId:
        type: string
      properties:
        type: object
        additionalProperties: {}
    allOf:
    - $ref: '#/definitions/AtlasObjectId'
    title: PurviewObjectId
  BulkDeleteOperation:
    type: object
    title: Status of bulk delete operation
    description: The status of bulk delete operation
    required:
    - id
    - status
    properties:
      id:
        type: string
      status:
        $ref: '#/definitions/BulkDeleteOperationStatus'
      createTime:
        type: string
        description: The created time of the record.
      lastUpdateTime:
        type: string
        description: The last updated time of the record.
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/BulkDeleteOperationProperties'
      error:
        x-ms-client-flatten: true
        $ref: '#/definitions/AsyncOperationError'
  AtlasTermCategorizationHeader:
    type: object
    properties:
      categoryGuid:
        type: string
        description: The GUID of the category.
      description:
        type: string
        description: The description of the record.
      displayText:
        type: string
        description: The display text.
      relationGuid:
        type: string
        description: The GUID of the relationship.
      status:
        $ref: '#/definitions/AtlasTermRelationshipStatus'
    title: AtlasTermCategorizationHeader
    description: The basic information for term categorization.
  AtlasGlossaryCategory:
    type: object
    title: AtlasGlossaryCategory
    allOf:
    - $ref: '#/definitions/AtlasGlossaryBaseObject'
    - properties:
        anchor:
          $ref: '#/definitions/AtlasGlossaryHeader'
        childrenCategories:
          type: array
          description: An array of children categories.
          items:
            $ref: '#/definitions/AtlasRelatedCategoryHeader'
        parentCategory:
          $ref: '#/definitions/AtlasRelatedCategoryHeader'
        terms:
          type: array
          description: An array of related term headers.
          items:
            $ref: '#/definitions/AtlasRelatedTermHeader'
    description: The glossary category.
  TermGuid:
    type: string
    title: termGuid
    description: The globally unique identifier for glossary term.
  AtlasGlossaryBaseObject:
    type: object
    title: AtlasGlossaryBaseObject
    allOf:
    - $ref: '#/definitions/AtlasBaseModelObject'
    - properties:
        classifications:
          type: array
          description: An array of classifications.
          items:
            $ref: '#/definitions/AtlasClassification'
        longDescription:
          type: string
          description: The long version description.
        name:
          type: string
          description: The name of the glossary object.
        qualifiedName:
          type: string
          description: The qualified name of the glossary object.
        shortDescription:
          type: string
          description: The short version of description.
        lastModifiedTS:
          $ref: '#/definitions/LastModifiedTS'
        createTime:
          type: integer
          format: int64
          description: The created time of the record.
        createdBy:
          type: string
          description: The user who created the record.
        updateTime:
          type: integer
          format: int64
          description: The update time of the record.
        updatedBy:
          type: string
          description: The user who updated the record.
    description: The glossary base object.
  TermStatus:
    type: string
    title: Status
    description: Status of the AtlasGlossaryTerm
    enum:
    - Draft
    - Approved
    - Alert
    - Expired
    x-ms-enum:
      name: TermStatus
      modelAsString: true
  Status_AtlasRelationship:
    type: string
    title: Status
    description: The enum of relationship status.
    enum:
    - ACTIVE
    - DELETED
    x-ms-enum:
      name: Status_AtlasRelationship
      modelAsString: true
  AsyncOperationError:
    type: object
    properties:
      code:
        type: string
        description: Code from async job if fail
      message:
        type: string
        description: Message from async job if fail
parameters:
  glossaryGuid:
    name: glossaryGuid
    in: path
    description: The globally unique identifier for glossary.
    required: true
    type: string
    minLength: 1
    maxLength: 4096
    x-ms-parameter-location: method
  limit:
    name: limit
    description: The page size - by default there is no paging.
    in: query
    required: false
    type: integer
    format: int32
    x-ms-parameter-location: method
  forceDeleteChild:
    name: forceDeleteChild
    description: Whether delete child terms together with the parent term
    in: query
    required: false
    type: boolean
    default: false
    x-ms-parameter-location: method
  categoryGuid:
    name: categoryGuid
    description: The globally unique identifier of the category.
    in: path
    required: true
    type: string
    minLength: 1
    maxLength: 4096
    x-ms-parameter-location: method
  ignoreTermsAndCategories:
    name: ignoreTermsAndCategories
    description: Whether ignore terms and categories
    in: query
    required: false
    type: boolean
    default: false
    x-ms-parameter-location: method
  sort:
    name: sort
    description: The sort order, ASC (default) or DESC.
    in: query
    required: false
    type: string
    default: ASC
    x-ms-parameter-location: method
  glossaryName:
    name: glossaryName
    in: path
    description: The name of the glossary.
    required: true
    type: string
    minLength: 1
    maxLength: 4096
    x-ms-parameter-location: method
  excludeRelationshipTypes:
    name: excludeRelationshipTypes
    description: An array of the relationship types need to be excluded from the response.
    in: query
    required: false
    type: array
    items:
      type: string
    collectionFormat: multi
    x-ms-parameter-location: method
  includeRichTextFlag:
    name: includeRichTextFlag
    description: Whether include rich text for term export
    in: query
    required: false
    type: boolean
    default: false
    x-ms-parameter-location: method
  includeTermHierarchy:
    name: includeTermHierarchy
    description: Whether include term hierarchy
    in: query
    required: false
    type: boolean
    default: false
    x-ms-parameter-location: method
  operationGuid:
    name: operationGuid
    in: path
    description: The globally unique identifier for async operation job.
    required: true
    type: string
    minLength: 1
    maxLength: 4096
    x-ms-parameter-location: method
  termGuid:
    name: termGuid
    in: path
    description: The globally unique identifier for glossary term.
    required: true
    type: string
    minLength: 1
    maxLength: 4096
    x-ms-parameter-location: method
  offset:
    name: offset
    description: The offset for pagination purpose.
    in: query
    required: false
    type: integer
    format: int32
    x-ms-parameter-location: method
  purviewAPIVersion:
    name: api-version
    description: Version of Purview APIs
    in: query
    required: true
    type: string
    x-ms-parameter-location: method
  includeMultiTemplates:
    name: includeMultiTemplates
    description: Whether include multi term templates for term import/export
    in: query
    required: false
    type: boolean
    default: false
    x-ms-parameter-location: method
  forceDeleteEntityAssignment:
    name: forceDeleteEntityAssignment
    description: Whether delete entity assignment
    in: query
    required: false
    type: boolean
    default: false
    x-ms-parameter-location: method
  extInfo:
    name: extInfo
    description: Whether include extended information like contact display name and attribute values
    in: query
    required: false
    type: boolean
    default: false
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'