Create terms

POST /api/meta/entity/bulk#createTerms

Create one or more terms.

Note that the creation relies on no matches being found for the provided qualifiedNames. If any of the qualifiedNames match any existing term, those terms will be updated rather than created. Also be aware that the qualifiedName is case-sensitive.

For more details on the semantics and other attributes available through this interface, see the Upsert entities operation.

Body Required

List of terms to create.

  • entities array[object] Required

    Instance of a term asset in Atlan, with its detailed information.

    • typeName string Required

      Should always be AtlasGlossaryTerm.

    • attributes object Required

      Attributes that can exist in term assets in Atlan.

      • qualifiedName string Required

        Unique name for this term. During creation this can be a readable name, but it will be replaced by a uniquely hashed name generated by Atlan. This is to ensure consistency even if the name of the term changes.

      • name string Required

        Human-readable name of the term.

      • userDescription string | null

        Meaningful explanation of the term.

    • relationshipAttributes object | null Required

      Map of the relationships to this term.

      • anchor object Required

        Details to use within an asset when referring to a glossary.

        • typeName string

          Should always be AtlasGlossary.

        • guid string | null

          Unique identifier of the related glossary. If the uniqueAttributes are not provided, this must be provided.

        • uniqueAttributes object | null

          Attribute(s) that uniquely identify the related glossary. If the guid is not provided, these must be provided.

          • qualifiedName string

            Unique name of the related glossary. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

      • assignedEntities array[object]

        Instance of an asset in Atlan, with its detailed information.

        • typeName string

          Name of the type definition that defines this instance.

        • attributes object | null

          Attributes that can exist across all assets in Atlan.

          • qualifiedName string

            Unique name for this asset. This is typically a concatenation of the asset's name onto its parent's qualifiedName.

          • name string

            Human-readable name of the asset.

          • displayName string | null

            Name used for display purposes (in user interfaces).

          • description string | null

            Description of the asset, as crawled from a source.

          • userDescription string | null

            Description of the asset, as provided by a user. If present, this will be used for the description in user interfaces. If not present, the description will be used.

          • tenantId string

            Name of the Atlan workspace in which the table exists.

          • certificateStatus string | null

            Status of the asset's certification.

            Values are VERIFIED, DRAFT, or DEPRECATED.

          • certificateStatusMessage string | null

            Human-readable descriptive message that can optionally be submitted when the certificateStatus is changed.

          • announcementTitle string | null

            Brief title for the announcement on this asset. Required when announcementType is specified.

          • announcementMessage string | null

            Detailed message to include in the announcement on this asset.

          • announcementType string | null

            Type of announcement on the asset.

            Values are information, warning, or issue.

          • ownerUsers array[string] | null

            List of users who own the asset.

          • ownerGroups array[string] | null

            List of groups who own the asset.

          • adminUsers array[string] | null

            List of users who administer the asset. (This is only used for Connection assets?)

          • adminGroups array[string] | null

            List of groups who administer the asset. (This is only used for Connection assets?)

          • viewerUsers array[string] | null
          • viewerGroups array[string] | null
          • connectorName string | null

            Name of the connector through which this asset is accessible.

          • connectionName string | null Deprecated

            Unused.

          • connectionQualifiedName string | null

            Unique name of the connection through which this asset is accessible.

          • isDiscoverable boolean
          • isEditable boolean
          • subType object | null
          • viewScore number | null
          • popularityScore number | null
          • sourceOwners array[string] | null
          • sourceURL string | null
          • lastSyncWorkflowName string | null

            Name of the crawler that last synchronized this asset.

          • lastSyncRunAt integer | null

            Time (epoch) at which the table was last crawled, in milliseconds.

          • lastSyncRun string | null

            Name of the last run of the crawler that last synchronized this asset.

        • classifications array[object] | null

          Instance of a classification in Atlan.

          • typeName string

            Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.

          • entityGuid string

            Unique identifier of the entity to which this classification is attached.

          • propagate boolean | null

            Whether to propagate this classification to other entities related to the entity to which the classification is attached.

          • removePropagationsOnEntityDelete boolean | null

            Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.

        • displayText string | null

          Human-readable name of the entity.

        • guid string

          Unique identifier of the entity instance.

        • isIncomplete boolean | null

          Default value is false.

        • businessAttributes object | null

          Map of custom metadata attributes and values defined on the entity.

        • relationshipAttributes object | null

          Map of the relationships to this asset.

          • links array[object]

            Details to use within an asset when referring to a link (resource).

            • typeName string

              Should always be Link.

            • guid string | null

              Unique identifier of the related link. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related link. If the guid is not provided, these must be provided.

              • qualifiedName string

                Unique name of the related link. Note that this is a generated unique name which is not visible in the UI.

          • readme object

            Details to use within an asset when referring to a readme.

            • typeName string

              Should always be Readme.

            • guid string | null

              Unique identifier of the related readme. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related readme. If the guid is not provided, these must be provided.

          • meanings array[object]

            Details to use within an asset when referring to a term.

            • typeName string

              Should always be AtlasnGlossaryTerm.

            • guid string | null

              Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.

              • qualifiedName string

                Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

      • categories array[object]

        Details to use within an asset when referring to a category.

        • typeName string

          Should always be AtlasGlossaryCategory.

        • guid string | null

          Unique identifier of the related category. If the uniqueAttributes are not provided, this must be provided.

        • uniqueAttributes object | null

          Attribute(s) that uniquely identify the related category. If the guid is not provided, these must be provided.

          • qualifiedName string

            Unique name of the related category. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

Responses

  • • 200 object

    Terms that were successfully created or updated. Note from the example that even though we are creating a term the response includes both an update to its glossary and the creation of the term within that glossary.

    • mutatedEntities object | null

      Terms that were changed.

      • CREATE array[object]

        Instance of a term in Atlan, with its detailed response-specific information.

        • createdBy string | null

          Username of the user who created the object.

        • updatedBy string | null

          Username of the user who last updated the object.

        • createTime integer | null

          Time (epoch) at which this object was created, in milliseconds.

        • updateTime integer | null

          Time (epoch) at which this object was last updated, in milliseconds.

        • version integer | null

          Version of this object.

        • classificationNames array[string] | null

          List of classifications for this entity. Note that these are the internal hashed names used in Atlan, not the displayText of the classification.

        • labels array[string] | null

          Internal use only.

        • status string

          Status of the entity, either ACTIVE or DELETED.

          Values are ACTIVE or DELETED.

        • relationshipAttributes object | null

          Map of the relationships to this term.

          • links array[object] | null

            Details to use within an asset when referring to a link (resource).

          • readme object

            Details to use within an asset when referring to a readme.

            • typeName string

              Should always be Readme.

            • guid string | null

              Unique identifier of the related readme. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related readme. If the guid is not provided, these must be provided.

          • meanings array[object] | null

            Details to use within an asset when referring to a term.

            • typeName string

              Should always be AtlasnGlossaryTerm.

            • guid string | null

              Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.

              • qualifiedName string

                Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

          • anchor object

            Details to use within an asset when referring to a glossary.

            • typeName string

              Should always be AtlasGlossary.

            • guid string | null

              Unique identifier of the related glossary. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related glossary. If the guid is not provided, these must be provided.

              • qualifiedName string

                Unique name of the related glossary. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

          • assignedEntities array[object]

            Instance of an asset in Atlan, with its detailed information.

            • typeName string

              Name of the type definition that defines this instance.

            • attributes object | null

              Attributes that can exist across all assets in Atlan.

              • qualifiedName string

                Unique name for this asset. This is typically a concatenation of the asset's name onto its parent's qualifiedName.

              • name string

                Human-readable name of the asset.

              • displayName string | null

                Name used for display purposes (in user interfaces).

              • description string | null

                Description of the asset, as crawled from a source.

              • userDescription string | null

                Description of the asset, as provided by a user. If present, this will be used for the description in user interfaces. If not present, the description will be used.

              • tenantId string

                Name of the Atlan workspace in which the table exists.

              • certificateStatus string | null

                Status of the asset's certification.

                Values are VERIFIED, DRAFT, or DEPRECATED.

              • certificateStatusMessage string | null

                Human-readable descriptive message that can optionally be submitted when the certificateStatus is changed.

              • announcementTitle string | null

                Brief title for the announcement on this asset. Required when announcementType is specified.

              • announcementMessage string | null

                Detailed message to include in the announcement on this asset.

              • announcementType string | null

                Type of announcement on the asset.

                Values are information, warning, or issue.

              • ownerUsers array[string] | null

                List of users who own the asset.

              • ownerGroups array[string] | null

                List of groups who own the asset.

              • adminUsers array[string] | null

                List of users who administer the asset. (This is only used for Connection assets?)

              • adminGroups array[string] | null

                List of groups who administer the asset. (This is only used for Connection assets?)

              • viewerUsers array[string] | null
              • viewerGroups array[string] | null
              • connectorName string | null

                Name of the connector through which this asset is accessible.

              • connectionName string | null Deprecated

                Unused.

              • connectionQualifiedName string | null

                Unique name of the connection through which this asset is accessible.

              • isDiscoverable boolean
              • isEditable boolean
              • subType object | null
              • viewScore number | null
              • popularityScore number | null
              • sourceOwners array[string] | null
              • sourceURL string | null
              • lastSyncWorkflowName string | null

                Name of the crawler that last synchronized this asset.

              • lastSyncRunAt integer | null

                Time (epoch) at which the table was last crawled, in milliseconds.

              • lastSyncRun string | null

                Name of the last run of the crawler that last synchronized this asset.

            • classifications array[object] | null

              Instance of a classification in Atlan.

              • typeName string

                Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.

              • entityGuid string

                Unique identifier of the entity to which this classification is attached.

              • propagate boolean | null

                Whether to propagate this classification to other entities related to the entity to which the classification is attached.

              • removePropagationsOnEntityDelete boolean | null

                Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.

            • displayText string | null

              Human-readable name of the entity.

            • guid string

              Unique identifier of the entity instance.

            • isIncomplete boolean | null

              Default value is false.

            • businessAttributes object | null

              Map of custom metadata attributes and values defined on the entity.

            • relationshipAttributes object | null

              Map of the relationships to this asset.

              • links array[object]

                Details to use within an asset when referring to a link (resource).

              • readme object

                Details to use within an asset when referring to a readme.

                • typeName string

                  Should always be Readme.

                • guid string | null

                  Unique identifier of the related readme. If the uniqueAttributes are not provided, this must be provided.

                • uniqueAttributes object | null

                  Attribute(s) that uniquely identify the related readme. If the guid is not provided, these must be provided.

              • meanings array[object]

                Details to use within an asset when referring to a term.

                • typeName string

                  Should always be AtlasnGlossaryTerm.

                • guid string | null

                  Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.

                • uniqueAttributes object | null

                  Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.

                  • qualifiedName string

                    Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

          • categories array[object]

            Details to use within an asset when referring to a category.

            • typeName string

              Should always be AtlasGlossaryCategory.

            • guid string | null

              Unique identifier of the related category. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related category. If the guid is not provided, these must be provided.

              • qualifiedName string

                Unique name of the related category. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

          • translationTerms array[object] | null Deprecated

            Details to use within an asset when referring to a term.

            • typeName string

              Should always be AtlasnGlossaryTerm.

            • guid string | null

              Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.

              • qualifiedName string

                Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

          • validValuesFor array[object] | null Deprecated

            Details to use within an asset when referring to a term.

            • typeName string

              Should always be AtlasnGlossaryTerm.

            • guid string | null

              Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.

              • qualifiedName string

                Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

          • synonyms array[object] | null Deprecated

            Details to use within an asset when referring to a term.

            • typeName string

              Should always be AtlasnGlossaryTerm.

            • guid string | null

              Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.

              • qualifiedName string

                Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

          • antonyms array[object] | null Deprecated

            Details to use within an asset when referring to a term.

            • typeName string

              Should always be AtlasnGlossaryTerm.

            • guid string | null

              Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.

              • qualifiedName string

                Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

          • replacedBy array[object] | null Deprecated

            Details to use within an asset when referring to a term.

            • typeName string

              Should always be AtlasnGlossaryTerm.

            • guid string | null

              Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.

              • qualifiedName string

                Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

          • validValues array[object] | null Deprecated

            Details to use within an asset when referring to a term.

            • typeName string

              Should always be AtlasnGlossaryTerm.

            • guid string | null

              Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.

              • qualifiedName string

                Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

          • replacementTerms array[object] | null Deprecated

            Details to use within an asset when referring to a term.

            • typeName string

              Should always be AtlasnGlossaryTerm.

            • guid string | null

              Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.

              • qualifiedName string

                Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

          • seeAlso array[object] | null Deprecated

            Details to use within an asset when referring to a term.

            • typeName string

              Should always be AtlasnGlossaryTerm.

            • guid string | null

              Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.

              • qualifiedName string

                Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

          • translatedTerms array[object] | null Deprecated

            Details to use within an asset when referring to a term.

            • typeName string

              Should always be AtlasnGlossaryTerm.

            • guid string | null

              Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.

              • qualifiedName string

                Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

          • isA array[object] | null Deprecated

            Details to use within an asset when referring to a term.

            • typeName string

              Should always be AtlasnGlossaryTerm.

            • guid string | null

              Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.

              • qualifiedName string

                Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

          • classifies array[object] | null Deprecated

            Details to use within an asset when referring to a term.

            • typeName string

              Should always be AtlasnGlossaryTerm.

            • guid string | null

              Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.

              • qualifiedName string

                Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

          • preferredToTerms array[object] | null Deprecated

            Details to use within an asset when referring to a term.

            • typeName string

              Should always be AtlasnGlossaryTerm.

            • guid string | null

              Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.

              • qualifiedName string

                Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

          • preferredTerms array[object] | null Deprecated

            Details to use within an asset when referring to a term.

            • typeName string

              Should always be AtlasnGlossaryTerm.

            • guid string | null

              Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.

            • uniqueAttributes object | null

              Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.

              • qualifiedName string

                Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

        • typeName string

          Should always be AtlasGlossaryTerm.

        • attributes object | null

          Attributes that can exist in term assets in Atlan.

        • classifications array[object] | null

          Instance of a classification in Atlan, with its detailed information.

          • typeName string

            Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.

          • entityGuid string

            Unique identifier of the entity to which this classification is attached.

          • propagate boolean | null

            Whether to propagate this classification to other entities related to the entity to which the classification is attached.

          • removePropagationsOnEntityDelete boolean | null

            Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.

          • entityStatus string | null

            Status of the entity to which this classification is attached.

            Values are ACTIVE or DELETED.

        • displayText string | null

          Human-readable name of the entity.

        • guid string

          Unique identifier of the entity instance.

        • isIncomplete boolean | null

          Default value is false.

      • UPDATE array[object]
        Any of:
        Glossary asset instance with detailed response information array[object] Term asset instance with detailed response information array[object]
    • guidAssignments object

      Map of assigned unique identifiers for the created terms.

POST /api/meta/entity/bulk#createTerms 
curl \
 -X POST https://tenant.atlan.com/api/meta/entity/bulk#createTerms \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"entities":[{"typeName":"AtlasGlossaryTerm","attributes":{"qualifiedName":"MAU@kRCbrmy1phqOyEQBade9H","name":"MAU"},"relationshipAttributes":{"anchor":{"typeName":"AtlasGlossary","guid":"b1e07ba1-33b3-4e2c-aa50-80c19846b5fe"}}}]}'
Request example 
{
  "entities": [
    {
      "typeName": "AtlasGlossaryTerm",
      "attributes": {
        "qualifiedName": "MAU@kRCbrmy1phqOyEQBade9H",
        "name": "MAU"
      },
      "relationshipAttributes": {
        "anchor": {
          "typeName": "AtlasGlossary",
          "guid": "b1e07ba1-33b3-4e2c-aa50-80c19846b5fe"
        }
      }
    }
  ]
}
Response example (200) 
{
  "mutatedEntities": {
    "CREATE": [
      {
        "typeName": "AtlasGlossaryTerm",
        "attributes": {
          "popularityScore": 1.17549435e-38,
          "viewerUsers": [],
          "sourceCreatedAt": 0,
          "viewScore": 1.17549435e-38,
          "lastSyncRunAt": 0,
          "adminRoles": [],
          "adminGroups": [],
          "qualifiedName": "6fMclebRamwTWg1ggJbLB@kRCbrmy1phqOyEQBade9H",
          "__hasLineage": false,
          "adminUsers": [],
          "ownerGroups": [],
          "isEditable": true,
          "sourceUpdatedAt": 0,
          "examples": [],
          "announcementUpdatedAt": 0,
          "name": "MAU",
          "certificateUpdatedAt": 0,
          "isDiscoverable": true,
          "viewerGroups": [],
          "ownerUsers": []
        },
        "guid": "fe368878-1cd6-440b-99e8-2f86b6e3bc69",
        "status": "ACTIVE",
        "displayText": "MAU",
        "classificationNames": [],
        "classifications": [],
        "meaningNames": [],
        "meanings": [],
        "isIncomplete": false,
        "labels": [],
        "createdBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
        "updatedBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
        "createTime": 1655141616243,
        "updateTime": 1655141616243
      }
    ],
    "UPDATE": [
      {
        "typeName": "AtlasGlossary",
        "attributes": {
          "qualifiedName": "kRCbrmy1phqOyEQBade9H",
          "name": "Metrics"
        },
        "guid": "eb81a273-65d0-4f3f-8da4-59d2eaa597dc",
        "status": "ACTIVE",
        "displayText": "Metrics",
        "classificationNames": [],
        "meaningNames": [],
        "meanings": [],
        "isIncomplete": false,
        "labels": [],
        "createdBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
        "updatedBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
        "createTime": 1655139776124,
        "updateTime": 1655141616243
      }
    ]
  },
  "guidAssignments": {
    "-494990470246419": "fe368878-1cd6-440b-99e8-2f86b6e3bc69"
  }
}