{
  "opencollection": "1.0.0",
  "info": {
    "name": "Microsoft Purview Data Map API",
    "version": "Thu Aug 31 2023 20:00:00 GMT-0400 (Eastern Daylight Time)"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Entity",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Microsoft Purview Create or update an entity",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/entity",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create or update an entity. Existing entity is matched using its unique guid if supplied or by its unique attributes such as qualifiedName. Map and array of collections are not well supported and may result in data loss."
        },
        {
          "info": {
            "name": "Microsoft Purview Get entity by GUID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/entity/guid/:guid",
            "params": [
              {
                "name": "guid",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              },
              {
                "name": "minExtInfo",
                "value": "",
                "type": "query"
              },
              {
                "name": "ignoreRelationships",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get complete definition of an entity given its GUID."
        },
        {
          "info": {
            "name": "Microsoft Purview Delete an entity",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/entity/guid/:guid",
            "params": [
              {
                "name": "guid",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Delete an entity identified by its GUID."
        },
        {
          "info": {
            "name": "Microsoft Purview Get entity header",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/entity/guid/:guid/header",
            "params": [
              {
                "name": "guid",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get entity header given its GUID."
        },
        {
          "info": {
            "name": "Microsoft Purview List entities by GUIDs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/entity/bulk",
            "params": [
              {
                "name": "guid",
                "value": "",
                "type": "query"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              },
              {
                "name": "minExtInfo",
                "value": "",
                "type": "query"
              },
              {
                "name": "ignoreRelationships",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "List entities in bulk identified by their GUIDs."
        },
        {
          "info": {
            "name": "Microsoft Purview Bulk create or update entities",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/entity/bulk",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create or update entities in bulk. Existing entity is matched using its unique guid if supplied or by its unique attributes."
        },
        {
          "info": {
            "name": "Microsoft Purview Bulk delete entities",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/entity/bulk",
            "params": [
              {
                "name": "guid",
                "value": "",
                "type": "query"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Delete a list of entities in bulk identified by their GUIDs or unique attributes."
        },
        {
          "info": {
            "name": "Microsoft Purview List classifications for entity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/entity/guid/:guid/classifications",
            "params": [
              {
                "name": "guid",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "List classifications for a given entity represented by a GUID."
        },
        {
          "info": {
            "name": "Microsoft Purview Add classifications to entity",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/entity/guid/:guid/classifications",
            "params": [
              {
                "name": "guid",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add classifications to an existing entity represented by a GUID."
        },
        {
          "info": {
            "name": "Microsoft Purview Add labels to entity",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/entity/guid/:guid/labels",
            "params": [
              {
                "name": "guid",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add given labels to a given entity."
        },
        {
          "info": {
            "name": "Microsoft Purview Set labels on entity",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/entity/guid/:guid/labels",
            "params": [
              {
                "name": "guid",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Set labels to a given entity."
        },
        {
          "info": {
            "name": "Microsoft Purview Remove labels from entity",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/entity/guid/:guid/labels",
            "params": [
              {
                "name": "guid",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Delete given labels from a given entity."
        },
        {
          "info": {
            "name": "Microsoft Purview Add or update business metadata",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/entity/guid/:guid/businessmetadata",
            "params": [
              {
                "name": "guid",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              },
              {
                "name": "isOverwrite",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add business metadata to an entity."
        },
        {
          "info": {
            "name": "Microsoft Purview Remove business metadata",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/entity/guid/:guid/businessmetadata",
            "params": [
              {
                "name": "guid",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Remove business metadata from an entity."
        },
        {
          "info": {
            "name": "Microsoft Purview Move entities to collection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/entity/bulk/collection/:collectionId",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Move existing entities to the target collection."
        }
      ]
    },
    {
      "info": {
        "name": "Glossary",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Microsoft Purview List all glossaries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/glossary",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query"
              },
              {
                "name": "ignoreTermsAndCategories",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get all glossaries. Recommend using limit/offset to get pagination result."
        },
        {
          "info": {
            "name": "Microsoft Purview Create a glossary",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/glossary",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a glossary."
        },
        {
          "info": {
            "name": "Microsoft Purview Get a glossary",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/glossary/:glossaryId",
            "params": [
              {
                "name": "glossaryId",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get a specific Glossary by its GUID."
        },
        {
          "info": {
            "name": "Microsoft Purview Update a glossary",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/glossary/:glossaryId",
            "params": [
              {
                "name": "glossaryId",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the given glossary."
        },
        {
          "info": {
            "name": "Microsoft Purview Delete a glossary",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/glossary/:glossaryId",
            "params": [
              {
                "name": "glossaryId",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Delete a glossary. Will delete underlying terms/categories together."
        },
        {
          "info": {
            "name": "Microsoft Purview Create a glossary term",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/glossary/term",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              },
              {
                "name": "includeTermHierarchy",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a glossary term."
        },
        {
          "info": {
            "name": "Microsoft Purview Get a glossary term",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/glossary/term/:termId",
            "params": [
              {
                "name": "termId",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get a specific glossary term by its GUID."
        },
        {
          "info": {
            "name": "Microsoft Purview Update a glossary term",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/glossary/term/:termId",
            "params": [
              {
                "name": "termId",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              },
              {
                "name": "includeTermHierarchy",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the given glossary term by its GUID."
        },
        {
          "info": {
            "name": "Microsoft Purview Delete a glossary term",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/glossary/term/:termId",
            "params": [
              {
                "name": "termId",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Delete a glossary term."
        }
      ]
    },
    {
      "info": {
        "name": "Discovery",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Microsoft Purview Search data assets",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{accountName}.purview.azure.com/datamap/api/search/query",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Get data using search."
        },
        {
          "info": {
            "name": "Microsoft Purview Get search suggestions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{accountName}.purview.azure.com/datamap/api/search/suggest",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Get search suggestions by query criteria."
        },
        {
          "info": {
            "name": "Microsoft Purview Get auto complete options",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{accountName}.purview.azure.com/datamap/api/search/autocomplete",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Get auto complete options."
        }
      ]
    },
    {
      "info": {
        "name": "Lineage",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Microsoft Purview Get lineage by GUID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/lineage/:guid",
            "params": [
              {
                "name": "guid",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              },
              {
                "name": "direction",
                "value": "",
                "type": "query"
              },
              {
                "name": "depth",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get lineage info of the entity specified by GUID."
        },
        {
          "info": {
            "name": "Microsoft Purview Get next page of lineage",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/lineage/:guid/next",
            "params": [
              {
                "name": "guid",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              },
              {
                "name": "direction",
                "value": "",
                "type": "query"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Return immediate next page lineage info about entity with pagination."
        },
        {
          "info": {
            "name": "Microsoft Purview Get lineage by unique attribute",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/lineage/uniqueAttribute/type/:typeName",
            "params": [
              {
                "name": "typeName",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              },
              {
                "name": "direction",
                "value": "",
                "type": "query"
              },
              {
                "name": "depth",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Return lineage info about entity. In addition to the typeName path parameter, attribute key-value pair(s) can be provided."
        }
      ]
    },
    {
      "info": {
        "name": "Relationship",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Microsoft Purview Create a relationship",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/relationship",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new relationship between entities."
        },
        {
          "info": {
            "name": "Microsoft Purview Update a relationship",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/relationship",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing relationship between entities."
        },
        {
          "info": {
            "name": "Microsoft Purview Get relationship by GUID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/relationship/guid/:guid",
            "params": [
              {
                "name": "guid",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              },
              {
                "name": "extendedInfo",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get relationship information between entities by its GUID."
        },
        {
          "info": {
            "name": "Microsoft Purview Delete a relationship",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/relationship/guid/:guid",
            "params": [
              {
                "name": "guid",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Delete a relationship between entities by its GUID."
        }
      ]
    },
    {
      "info": {
        "name": "Type",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Microsoft Purview List all type definitions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/types/typedefs",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              },
              {
                "name": "includeTermTemplate",
                "value": "",
                "type": "query"
              },
              {
                "name": "type",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "List all type definitions in bulk."
        },
        {
          "info": {
            "name": "Microsoft Purview Create type definitions in bulk",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/types/typedefs",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create all atlas type definitions in bulk."
        },
        {
          "info": {
            "name": "Microsoft Purview Update type definitions in bulk",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/types/typedefs",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update all types in bulk."
        },
        {
          "info": {
            "name": "Microsoft Purview Delete type definitions in bulk",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/types/typedefs",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Delete API for all types in bulk."
        },
        {
          "info": {
            "name": "Microsoft Purview List type definition headers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/types/typedefs/headers",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              },
              {
                "name": "includeTermTemplate",
                "value": "",
                "type": "query"
              },
              {
                "name": "type",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "List all type definitions returned as a list of minimal information header."
        },
        {
          "info": {
            "name": "Microsoft Purview Get type definition by name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/types/typedef/name/:name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get the type definition by its name (unique)."
        },
        {
          "info": {
            "name": "Microsoft Purview Delete type definition by name",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/types/typedef/name/:name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Delete API for type identified by its name."
        },
        {
          "info": {
            "name": "Microsoft Purview Get type definition by GUID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{accountName}.purview.azure.com/datamap/api/atlas/v2/types/typedef/guid/:guid",
            "params": [
              {
                "name": "guid",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get the type definition for the given GUID."
        }
      ]
    }
  ],
  "bundled": true
}