Microsoft Azure Type API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Type API
schemes:
- https
tags:
- name: Type
paths:
  /atlas/v2/types/businessmetadatadef/guid/{guid}:
    get:
      tags:
      - Type
      description: Get the businessMetadata definition for the given guid
      operationId: microsoftAzureTypeGetbusinessmetadatadefbyguid
      x-ms-examples:
        Type_GetBusinessMetadataDefByGuid:
          $ref: ./examples/Type_GetBusinessMetadataDefByGuid.json
      produces:
      - application/json
      parameters:
      - name: guid
        in: path
        type: string
        description: businessMetadata guid
        required: true
      responses:
        '200':
          schema:
            $ref: '#/definitions/AtlasBusinessMetadataDef'
            description: On successful lookup of the the businessMetadata definition by it's guid
          description: On successful lookup of the the businessMetadata definition by it's guid
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Businessmetadatadef Guid Guid
  /atlas/v2/types/businessmetadatadef/name/{name}:
    get:
      tags:
      - Type
      description: Get the businessMetadata definition by it's name (unique)
      operationId: microsoftAzureTypeGetbusinessmetadatadefbyname
      x-ms-examples:
        Type_GetBusinessMetadataDefByName:
          $ref: ./examples/Type_GetBusinessMetadataDefByName.json
      produces:
      - application/json
      parameters:
      - name: name
        in: path
        type: string
        description: businessMetadata name
        required: true
      responses:
        '200':
          schema:
            $ref: '#/definitions/AtlasBusinessMetadataDef'
            description: On successful lookup of the the businessMetadata definition by it's name
          description: On successful lookup of the the businessMetadata definition by it's name
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Businessmetadatadef Name Name
  /atlas/v2/types/classificationdef/guid/{guid}:
    get:
      tags:
      - Type
      description: Get the classification definition for the given GUID.
      operationId: microsoftAzureTypeGetclassificationdefbyguid
      x-ms-examples:
        Type_GetClassificationDefByGuid:
          $ref: ./examples/Type_GetClassificationDefByGuid.json
      parameters:
      - $ref: '#/parameters/classificationDefGuid'
      responses:
        '200':
          description: OK. On successful lookup of the the classification definition by its GUID.
          schema:
            $ref: '#/definitions/AtlasClassificationDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Classificationdef Guid Guid
  /atlas/v2/types/classificationdef/name/{name}:
    get:
      tags:
      - Type
      description: Get the classification definition by its name (unique).
      operationId: microsoftAzureTypeGetclassificationdefbyname
      x-ms-examples:
        Type_GetClassificationDefByName:
          $ref: ./examples/Type_GetClassificationDefByName.json
      parameters:
      - $ref: '#/parameters/classificationDefName'
      responses:
        '200':
          description: OK. On successful lookup of the the classification definition by its name.
          schema:
            $ref: '#/definitions/AtlasClassificationDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Classificationdef Name Name
  /atlas/v2/types/entitydef/guid/{guid}:
    get:
      tags:
      - Type
      description: Get the Entity definition for the given GUID.
      operationId: microsoftAzureTypeGetentitydefbyguid
      x-ms-examples:
        Type_GetEntityDefByGuid:
          $ref: ./examples/Type_GetEntityDefByGuid.json
      parameters:
      - $ref: '#/parameters/entityDefGuid'
      responses:
        '200':
          description: OK. On successful lookup of the the entity definition by its GUID.
          schema:
            $ref: '#/definitions/AtlasEntityDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Entitydef Guid Guid
  /atlas/v2/types/entitydef/name/{name}:
    get:
      tags:
      - Type
      description: Get the entity definition by its name (unique).
      operationId: microsoftAzureTypeGetentitydefbyname
      x-ms-examples:
        Type_GetEntityDefByName:
          $ref: ./examples/Type_GetEntityDefByName.json
      parameters:
      - $ref: '#/parameters/entityDefName'
      responses:
        '200':
          description: OK. On successful lookup of the the entity definition by its name.
          schema:
            $ref: '#/definitions/AtlasEntityDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Entitydef Name Name
  /atlas/v2/types/enumdef/guid/{guid}:
    get:
      tags:
      - Type
      description: Get the enum definition for the given GUID.
      operationId: microsoftAzureTypeGetenumdefbyguid
      x-ms-examples:
        Type_GetEnumDefByGuid:
          $ref: ./examples/Type_GetEnumDefByGuid.json
      parameters:
      - $ref: '#/parameters/enumDefGuid'
      responses:
        '200':
          description: OK. On successful lookup of the the enum definition by its GUID.
          schema:
            $ref: '#/definitions/AtlasEnumDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Enumdef Guid Guid
  /atlas/v2/types/enumdef/name/{name}:
    get:
      tags:
      - Type
      description: Get the enum definition by its name (unique).
      operationId: microsoftAzureTypeGetenumdefbyname
      x-ms-examples:
        Type_GetEnumDefByName:
          $ref: ./examples/Type_GetEnumDefByName.json
      parameters:
      - $ref: '#/parameters/enumDefName'
      responses:
        '200':
          description: OK. On successful lookup of the the enum definition by its name.
          schema:
            $ref: '#/definitions/AtlasEnumDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Enumdef Name Name
  /atlas/v2/types/relationshipdef/guid/{guid}:
    get:
      tags:
      - Type
      description: Get the relationship definition for the given GUID.
      operationId: microsoftAzureTypeGetrelationshipdefbyguid
      x-ms-examples:
        Type_GetRelationshipDefByGuid:
          $ref: ./examples/Type_GetRelationshipDefByGuid.json
      parameters:
      - $ref: '#/parameters/relationshipDefGuid'
      responses:
        '200':
          description: OK. On successful lookup of the the relationship definition by its GUID.
          schema:
            $ref: '#/definitions/AtlasRelationshipDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Relationshipdef Guid Guid
  /atlas/v2/types/relationshipdef/name/{name}:
    get:
      tags:
      - Type
      description: Get the relationship definition by its name (unique).
      operationId: microsoftAzureTypeGetrelationshipdefbyname
      x-ms-examples:
        Type_GetRelationshipDefByName:
          $ref: ./examples/Type_GetRelationshipDefByName.json
      parameters:
      - $ref: '#/parameters/relationshipDefName'
      responses:
        '200':
          description: OK. On successful lookup of the the relationship definition by its name.
          schema:
            $ref: '#/definitions/AtlasRelationshipDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Relationshipdef Name Name
  /atlas/v2/types/structdef/guid/{guid}:
    get:
      tags:
      - Type
      description: Get the struct definition for the given GUID.
      operationId: microsoftAzureTypeGetstructdefbyguid
      x-ms-examples:
        Type_GetStructDefByGuid:
          $ref: ./examples/Type_GetStructDefByGuid.json
      parameters:
      - $ref: '#/parameters/structDefGuid'
      responses:
        '200':
          description: OK. On successful lookup of the the struct definition by its GUID.
          schema:
            $ref: '#/definitions/AtlasStructDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Structdef Guid Guid
  /atlas/v2/types/structdef/name/{name}:
    get:
      tags:
      - Type
      description: Get the struct definition by its name (unique).
      operationId: microsoftAzureTypeGetstructdefbyname
      x-ms-examples:
        Type_GetStructDefByName:
          $ref: ./examples/Type_GetStructDefByName.json
      parameters:
      - $ref: '#/parameters/structDefName'
      responses:
        '200':
          description: OK. On successful lookup of the the struct definition by its name.
          schema:
            $ref: '#/definitions/AtlasStructDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Structdef Name Name
  /atlas/v2/types/typedef/guid/{guid}:
    get:
      tags:
      - Type
      description: Get the type definition for the given GUID.
      operationId: microsoftAzureTypeGetbyguid
      x-ms-examples:
        Type_GetByGuid:
          $ref: ./examples/Type_GetByGuid.json
      parameters:
      - $ref: '#/parameters/typeDefGuid'
      responses:
        '200':
          description: OK. On successful lookup of the the type definition by its GUID.
          schema:
            $ref: '#/definitions/AtlasTypeDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Typedef Guid Guid
  /atlas/v2/types/typedef/name/{name}:
    get:
      tags:
      - Type
      description: Get the type definition by its name (unique).
      operationId: microsoftAzureTypeGetbyname
      x-ms-examples:
        Type_GetByName:
          $ref: ./examples/Type_GetByName.json
      parameters:
      - $ref: '#/parameters/typeDefName'
      responses:
        '200':
          description: OK. On successful lookup of the the type definition by its name.
          schema:
            $ref: '#/definitions/AtlasTypeDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Typedef Name Name
    delete:
      tags:
      - Type
      description: Delete API for type identified by its name.
      operationId: microsoftAzureTypeDelete
      x-ms-examples:
        Type_Delete:
          $ref: ./examples/Type_Delete.json
      parameters:
      - $ref: '#/parameters/typeDefName'
      responses:
        '204':
          description: On successful deletion of the requested type definitions
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Atlas Types Typedef Name Name
  /atlas/v2/types/typedefs:
    get:
      tags:
      - Type
      description: List all type definitions in bulk.
      operationId: microsoftAzureTypeList
      x-ms-examples:
        Type_List:
          $ref: ./examples/Type_List.json
        Type_ListEnumDefs:
          $ref: ./examples/Type_ListEnumDefs.json
        Type_ListTermTemplateDefs:
          $ref: ./examples/Type_ListTermTemplateDefs.json
      parameters:
      - $ref: '#/parameters/includeTermTemplate'
      - $ref: '#/parameters/type'
      - $ref: '#/parameters/purviewAPIVersion'
      responses:
        '200':
          description: OK. AtlasTypesDef with type definitions matching the search criteria or else returns empty list of type definitions.
          schema:
            $ref: '#/definitions/AtlasTypesDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Typedefs
    post:
      tags:
      - Type
      description: Create all atlas type definitions in bulk, only new definitions will be created.<br>Any changes to the existing definitions will be discarded.
      operationId: microsoftAzureTypeBulkcreate
      x-ms-examples:
        Type_BulkCreate:
          $ref: ./examples/Type_BulkCreate.json
        Type_BulkCreateBusinessMetadataDefs:
          $ref: ./examples/Type_BulkCreateBusinessMetadataDefs.json
      parameters:
      - in: body
        name: typesDef
        description: A composite wrapper object with corresponding lists of the type definition.
        required: true
        schema:
          $ref: '#/definitions/AtlasTypesDef'
      responses:
        '200':
          description: OK. On successful update of requested type definitions.
          schema:
            $ref: '#/definitions/AtlasTypesDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Types Typedefs
    put:
      tags:
      - Type
      description: Update all types in bulk, changes detected in the type definitions would be persisted.
      operationId: microsoftAzureTypeBulkupdate
      x-ms-examples:
        Type_BulkUpdate:
          $ref: ./examples/Type_BulkUpdate.json
      parameters:
      - in: body
        name: typesDef
        description: A composite object that captures all type definition changes.
        required: true
        schema:
          $ref: '#/definitions/AtlasTypesDef'
      responses:
        '200':
          description: OK. On successful update of requested type definitions.
          schema:
            $ref: '#/definitions/AtlasTypesDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Types Typedefs
    delete:
      tags:
      - Type
      description: Delete API for all types in bulk.
      operationId: microsoftAzureTypeBulkdelete
      x-ms-examples:
        Type_BulkDelete:
          $ref: ./examples/Type_BulkDelete.json
      parameters:
      - in: body
        name: typesDef
        description: A composite object that captures all types to be deleted
        required: true
        schema:
          $ref: '#/definitions/AtlasTypesDef'
      responses:
        '204':
          description: OK. On successful deletion of the requested type definitions.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Atlas Types Typedefs
  /atlas/v2/types/typedefs/headers:
    get:
      tags:
      - Type
      description: List all type definitions returned as a list of minimal information header.
      operationId: microsoftAzureTypeListheaders
      x-ms-examples:
        Type_ListHeaders:
          $ref: ./examples/Type_ListHeaders.json
      parameters:
      - $ref: '#/parameters/includeTermTemplate'
      - $ref: '#/parameters/type'
      - $ref: '#/parameters/purviewAPIVersion'
      responses:
        '200':
          description: 'An array of AtlasTypeDefHeader matching the search criteria

            or an empty list if no match.'
          schema:
            type: array
            description: 'An array of AtlasTypeDefHeader matching the search criteria

              or an empty list if no match.'
            items:
              $ref: '#/definitions/AtlasTypeDefHeader'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Typedefs Headers
  /types/termtemplatedef/guid/{guid}:
    get:
      tags:
      - Type
      description: Get the term template definition for the given GUID.
      operationId: microsoftAzureTypeGettermtemplatedefbyguid
      x-ms-examples:
        Type_GetTermTemplateDefByGuid:
          $ref: ./examples/Type_GetTermTemplateDefByGuid.json
      parameters:
      - $ref: '#/parameters/termTemplateDefGuid'
      - $ref: '#/parameters/purviewAPIVersion'
      responses:
        '200':
          description: OK. On successful lookup of the the term template definition by its GUID.
          schema:
            $ref: '#/definitions/TermTemplateDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Types Termtemplatedef Guid Guid
  /types/termtemplatedef/name/{name}:
    get:
      tags:
      - Type
      description: Get the term template definition by its name (unique).
      operationId: microsoftAzureTypeGettermtemplatedefbyname
      x-ms-examples:
        Type_GetTermTemplateDefByName:
          $ref: ./examples/Type_GetTermTemplateDefByName.json
      parameters:
      - $ref: '#/parameters/termTemplateDefName'
      - $ref: '#/parameters/purviewAPIVersion'
      responses:
        '200':
          description: OK. On successful lookup of the the term template definition by its name.
          schema:
            $ref: '#/definitions/TermTemplateDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Types Termtemplatedef Name Name
definitions:
  LastModifiedTS:
    type: string
    title: lastModifiedTS
    description: ETag for concurrency control.
  AtlasRelationshipDef:
    type: object
    title: AtlasRelationshipDef
    properties:
      endDef1:
        $ref: '#/definitions/AtlasRelationshipEndDef'
      endDef2:
        $ref: '#/definitions/AtlasRelationshipEndDef'
      relationshipCategory:
        $ref: '#/definitions/RelationshipCategory'
      relationshipLabel:
        type: string
        description: The label of the relationship.
    allOf:
    - $ref: '#/definitions/AtlasStructDef'
    description: "AtlasRelationshipDef is a TypeDef that defines a relationship.\n<p>\nAs with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid.\nThe name and the guid are the 2 ways that the RelationshipDef is identified.\n<p>\nRelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally\nwhether the end is a container.\n<p>\nRelationshipDefs can have AttributeDefs - though only primitive types are allowed. <br>\nRelationshipDefs have a relationshipCategory specifying the UML type of relationship required <br>\nThe way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs\nwill not specify an EntityDef type name as their types.\n<p>\nRelationshipDefs introduce new attributes to the entity instances. For example\n<p>\nEntityDef A might have attributes attr1,attr2,attr3 <br>\nEntityDef B might have attributes attr4,attr5,attr6 <br>\nRelationshipDef AtoB might define 2 ends <br>\n\n<pre>\n   end1:  type A, name attr7\n   end2:  type B, name attr8  </pre>\n\n<p>\nWhen an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7 <br>\nWhen an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8\n<p>\nIn this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into\nthe entity instances"
  TermTemplateDef:
    type: object
    title: TermTemplateDef
    allOf:
    - $ref: '#/definitions/AtlasStructDef'
    description: term template definition for glossary term.
  AtlasTypeDefHeader:
    type: object
    properties:
      category:
        $ref: '#/definitions/TypeCategory'
      guid:
        type: string
        description: The GUID of the type definition.
      name:
        type: string
        description: The name of the type definition.
    title: AtlasTypeDefHeader
    description: The basic information of the type definition.
  AtlasTypesDef:
    type: object
    properties:
      businessMetadataDefs:
        readOnly: false
        description: businessMetadataDefs
        type: array
        items:
          $ref: '#/definitions/AtlasBusinessMetadataDef'
      classificationDefs:
        type: array
        description: An array of classification definitions.
        items:
          $ref: '#/definitions/AtlasClassificationDef'
      entityDefs:
        type: array
        description: An array of entity definitions.
        items:
          $ref: '#/definitions/AtlasEntityDef'
      enumDefs:
        type: array
        description: An array of enum definitions.
        items:
          $ref: '#/definitions/AtlasEnumDef'
      relationshipDefs:
        type: array
        description: An array of relationship definitions.
        items:
          $ref: '#/definitions/AtlasRelationshipDef'
      structDefs:
        type: array
        description: An array of struct definitions.
        items:
          $ref: '#/definitions/AtlasStructDef'
      termTemplateDefs:
        type: array
        description: An array of term template definitions.
        items:
          $ref: '#/definitions/TermTemplateDef'
    title: AtlasTypesDef
    description: The definitions of types.
  AtlasEnumElementDef:
    type: object
    properties:
      description:
        type: string
        description: The description of the enum element definition.
      ordinal:
        type: number
        description: The ordinal of the enum element definition.
      value:
        type: string
        description: The value of the enum element definition.
    title: AtlasEnumElementDef
    description: class that captures details of an enum-element.
  RelationshipCategory:
    type: string
    title: RelationshipCategory
    description: 'The Relationship category determines the style of relationship around containment and lifecycle.

      UML terminology is used for the values.

      <p>

      ASSOCIATION is a relationship with no containment. <br>

      COMPOSITION and AGGREGATION are containment relationships.

      <p>

      The difference being in the lifecycles of the container and its children. In the COMPOSITION case,

      the children cannot exist without the container. For AGGREGATION, the life cycles

      of the container and children are totally independent.'
    enum:
    - ASSOCIATION
    - AGGREGATION
    - COMPOSITION
    x-ms-enum:
      name: RelationshipCategory
      modelAsString: true
  AtlasEnumDef:
    type: object
    title: AtlasEnumDef
    properties:
      defaultValue:
        type: string
        description: The default value.
      elementDefs:
        type: array
        description: An array of enum element definitions.
        items:
          $ref: '#/definitions/AtlasEnumElementDef'
    allOf:
    - $ref: '#/definitions/AtlasBaseTypeDef'
    description: class that captures details of an enum-type.
  Cardinality:
    type: string
    title: Cardinality
    description: single-valued attribute or multi-valued attribute.
    enum:
    - SINGLE
    - LIST
    - SET
    x-ms-enum:
      name: Cardinality
      modelAsString: true
  DateFormat:
    type: object
    title: DateFormat
    properties:
      availableLocales:
        type: array
        description: An array of available locales.
        items:
          type: string
      calendar:
        type: number
      dateInstance:
        $ref: '#/definitions/DateFormat'
      dateTimeInstance:
        $ref: '#/definitions/DateFormat'
      instance:
        $ref: '#/definitions/DateFormat'
      lenient:
        type: boolean
        description: Determines the leniency of the date format.
      numberFormat:
        $ref: '#/definitions/NumberFormat'
      timeInstance:
        $ref: '#/definitions/DateFormat'
      timeZone:
        $ref: '#/definitions/TimeZone'
    description: The date format.
  AtlasBusinessMetadataDef:
    type: object
    title: AtlasBusinessMetadataDef
    allOf:
    - $ref: '#/definitions/AtlasStructDef'
    description: class that captures details of a struct-type.
  RoundingMode:
    type: string
    title: RoundingMode
    description: The enum of rounding mode.
    enum:
    - UP
    - DOWN
    - CEILING
    - FLOOR
    - HALF_UP
    - HALF_DOWN
    - HALF_EVEN
    - UNNECESSARY
    x-ms-enum:
      name: RoundingMode
      modelAsString: true
  AtlasEntityDef:
    type: object
    title: AtlasEntityDef
    properties:
      subTypes:
        type: array
        description: An array of sub types.
        items:
          type: string
      superTypes:
        type: array
        description: An array of super types.
        items:
          type: string
      relationshipAttributeDefs:
        type: array
        description: An array of relationship attributes.
        items:
          $ref: '#/definitions/AtlasRelationshipAttributeDef'
    allOf:
    - $ref: '#/definitions/AtlasStructDef'
    description: class that captures details of a entity-type.
  TimeZone:
    type: object
    properties:
      dstSavings:
        type: integer
        format: int32
        description: The value of the daylight saving time.
      id:
        type: string
        description: The ID of the timezone.
      availableIds:
        type: array
        description: An array of available IDs.
        items:
          type: string
      default:
        $ref: '#/definitions/TimeZone'
      displayName:
        type: string
        description: The display name of the timezone.
      rawOffset:
        type: integer
        format: int32
        description: The raw offset of the timezone.
    title: TimeZone
    description: The timezone information.
  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.
  AtlasAttributeDef:
    type: object
    properties:
      cardinality:
        $ref: '#/definitions/Cardinality'
      constraints:
        type: array
        description: An array of constraints.
        items:
          $ref: '#/definitions/AtlasConstraintDef'
      defaultValue:
        type: string
        description: The default value of the attribute.
      description:
        type: string
        description: The description of the attribute.
      includeInNotification:
        type: boolean
        description: Determines if it is included in notification.
      isIndexable:
        type: boolean
        description: Determines if it is indexable.
      isOptional:
        type: boolean
        description: Determines if it is optional.
      isUnique:
        type: boolean
        description: Determines if it unique.
      name:
        type: string
        description: The name of the attribute.
      options:
        type: object
        description: The options for the attribute.
        additionalProperties:
          type: string
      typeName:
        type: string
        description: The name of the type.
      valuesMaxCount:
        type: integer
        format: int32
        description: The maximum count of the values.
      valuesMinCount:
        type: integer
        format: int32
        description: The minimum count of the values.
    title: AtlasAttributeDef
    description: class that captures details of a struct-attribute.
  NumberFormat:
    type: object
    title: NumberFormat
    properties:
      availableLocales:
        type: array
        description: The number format.
        items:
          type: string
      currency:
        type: string
        description: The currency.
      currencyInstance:
        $ref: '#/definitions/NumberFormat'
      groupingUsed:
        type: boolean
        description: Determines if grouping is used.
      instance:
        $ref: '#/definitions/NumberFormat'
      integerInstance:
        $ref: '#/definitions/NumberFormat'
      maximumFractionDigits:
        type: integer
        format: int32
        description: The maximum of fraction digits.
      maximumIntegerDigits:
        type: integer
        format: int32
        description: The maximum of integer digits.
      minimumFractionDigits:
        type: integer
        format: int32
        description: The minimum of fraction digits.
      minimumIntegerDigits:
        type: integer
        format: int32
        description: The minimum of integer digits.
      numberInstance:
        $ref: '#/definitions/NumberFormat'
      parseIntegerOnly:
        type: boolean
        description: Determines if only integer is parsed.
      percentInstance:
        $ref: '#/definitions/NumberFormat'
      roundingMode:
        $ref: '#/definitions/RoundingMode'
    description: The number format.
  AtlasBaseTypeDef:
    type: object
    properties:
      category:
        $ref: '#/definitions/TypeCategory'
      createTime:
        type: integer
        format: int64
        description: The created time of the record.
      createdBy:
        type: string
        description: The user who created the record.
      dateFormatter:
        $ref: '#/definitions/DateFormat'
      description:
        type: string
        description: The description of the type definition.
      guid:
        type: string
        description: The GUID of the type definition.
      name:
        type: string
        description: The name of the type definition.
      options:
        type: object
        description: The options for the type definition.
        additionalProperties:
          type: string
      serviceType:
        readOnly: false
        description: The service type.
        type: string
      typeVersion:
        type: string
        description: The version of the type.
      updateTime:
        type: integer
        format: int64
        description: The update time of the record.
      updatedBy:
        type: string
        description: The user who updated the record.
      version:
        type: number
        description: The version of the record.
      lastModifiedTS:
        $ref: '#/definitions/LastModifiedTS'
    title: AtlasBaseTypeDef
    description: Base class that captures common-attributes for all types.
  AtlasRelationshipAttributeDef:
    type: object
    properties:
      isLegacyAttribute:
        type: boolean
        description: Determines if it is a legacy attribute.
      relationshipTypeName:
        type: string
        description: The name of the relationship type.
    allOf:
    - $ref: '#/definitions/AtlasAttributeDef'
    title: AtlasRelationshipEndDef
    description: 'The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an

      attribute name, cardinality and whether it  is the container end of the relationship.'
  AtlasExtraTypeDef:
    type: object
    properties:
      entityTypes:
        type: array
        description:

# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-type-api-openapi.yml