{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:azure-purview-datamap/entity-create-or-update":{"post":{"operationId":"cloud_azure_purview_datamap_entity_create_or_update","summary":"Create or update an entity. Existing entity is matched using its unique guid if supplied or by its unique…","description":"POST /atlas/v2/entity","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"api-version":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."},"businessAttributeUpdateBehavior":{"type":"string","enum":["ignore","replace","merge"],"description":"Used to define the update behavior for business attributes when updating entities."},"collectionId":{"type":"string","description":"The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-list-by-guids":{"get":{"operationId":"cloud_azure_purview_datamap_entity_list_by_guids","summary":"List entities in bulk identified by its GUIDs.","description":"GET /atlas/v2/entity/bulk","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."}},{"name":"guid","in":"query","required":true,"description":"An array of GUIDs of entities to list.","schema":{"type":"array","description":"An array of GUIDs of entities to list."}},{"name":"minExtInfo","in":"query","required":false,"description":"Whether to return minimal information for referred entities.","schema":{"type":"boolean","description":"Whether to return minimal information for referred entities."}},{"name":"ignoreRelationships","in":"query","required":false,"description":"Whether to ignore relationship attributes.","schema":{"type":"boolean","description":"Whether to ignore relationship attributes."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-bulk-create-or-update":{"post":{"operationId":"cloud_azure_purview_datamap_entity_bulk_create_or_update","summary":"Create or update entities in bulk. Existing entity is matched using its unique guid if supplied or by its…","description":"POST /atlas/v2/entity/bulk","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"api-version":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."},"collectionId":{"type":"string","description":"The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection."},"businessAttributeUpdateBehavior":{"type":"string","enum":["ignore","replace","merge"],"description":"Used to define the update behavior for business attributes when updating entities."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-bulk-delete":{"post":{"operationId":"cloud_azure_purview_datamap_entity_bulk_delete","summary":"Delete a list of entities in bulk identified by their GUIDs or unique attributes.","description":"DELETE /atlas/v2/entity/bulk","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","guid"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"guid":{"type":"array","description":"An array of GUIDs of entities to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-add-classification":{"post":{"operationId":"cloud_azure_purview_datamap_entity_add_classification","summary":"Associate a classification to multiple entities in bulk.","description":"POST /atlas/v2/entity/bulk/classification","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-bulk-set-classifications":{"post":{"operationId":"cloud_azure_purview_datamap_entity_bulk_set_classifications","summary":"Set classifications on entities in bulk.","description":"POST /atlas/v2/entity/bulk/setClassifications","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-list-by-unique-attributes":{"get":{"operationId":"cloud_azure_purview_datamap_entity_list_by_unique_attributes","summary":"Bulk API to retrieve list of entities identified by its unique attributes. In addition to the typeName path…","description":"GET /atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"typeName","in":"query","required":true,"description":"The name of the type.","schema":{"type":"string","description":"The name of the type."}},{"name":"minExtInfo","in":"query","required":false,"description":"Whether to return minimal information for referred entities.","schema":{"type":"boolean","description":"Whether to return minimal information for referred entities."}},{"name":"ignoreRelationships","in":"query","required":false,"description":"Whether to ignore relationship attributes.","schema":{"type":"boolean","description":"Whether to ignore relationship attributes."}},{"name":"attr_N:qualifiedName","in":"query","required":false,"description":"Qualified name of an entity. E.g. to find 2 entities you can set attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is…","schema":{"type":"string","description":"Qualified name of an entity. E.g. to find 2 entities you can set attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-import-business-metadata":{"post":{"operationId":"cloud_azure_purview_datamap_entity_import_business_metadata","summary":"Upload the file for creating Business Metadata in BULK","description":"POST /atlas/v2/entity/businessmetadata/import","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-get-sample-business-metadata-template":{"get":{"operationId":"cloud_azure_purview_datamap_entity_get_sample_business_metadata_template","summary":"Get the sample Template for uploading/creating bulk BusinessMetaData","description":"GET /atlas/v2/entity/businessmetadata/import/template","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-get":{"get":{"operationId":"cloud_azure_purview_datamap_entity_get","summary":"Get complete definition of an entity given its GUID.","description":"GET /atlas/v2/entity/guid/{guid}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"guid","in":"query","required":true,"description":"The globally unique identifier of the entity.","schema":{"type":"string","description":"The globally unique identifier of the entity."}},{"name":"minExtInfo","in":"query","required":false,"description":"Whether to return minimal information for referred entities.","schema":{"type":"boolean","description":"Whether to return minimal information for referred entities."}},{"name":"ignoreRelationships","in":"query","required":false,"description":"Whether to ignore relationship attributes.","schema":{"type":"boolean","description":"Whether to ignore relationship attributes."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-partial-update-attribute-by-guid":{"post":{"operationId":"cloud_azure_purview_datamap_entity_partial_update_attribute_by_guid","summary":"Update entity partially - create or update entity attribute identified by its GUID. Supports only primitive…","description":"PUT /atlas/v2/entity/guid/{guid}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","guid","name","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"guid":{"type":"string","description":"The globally unique identifier of the entity."},"name":{"type":"string","description":"The name of the attribute."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-delete":{"post":{"operationId":"cloud_azure_purview_datamap_entity_delete","summary":"Delete an entity identified by its GUID.","description":"DELETE /atlas/v2/entity/guid/{guid}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","guid"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"guid":{"type":"string","description":"The globally unique identifier of the entity."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-add-or-update-business-metadata":{"post":{"operationId":"cloud_azure_purview_datamap_entity_add_or_update_business_metadata","summary":"Add business metadata to an entity.","description":"POST /atlas/v2/entity/guid/{guid}/businessmetadata","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","guid","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"guid":{"type":"string","description":"The globally unique identifier of the entity."},"isOverwrite":{"type":"boolean","description":"Whether to overwrite the existing business metadata on the entity or not, default is false."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-remove-business-metadata":{"post":{"operationId":"cloud_azure_purview_datamap_entity_remove_business_metadata","summary":"Remove business metadata from an entity.","description":"DELETE /atlas/v2/entity/guid/{guid}/businessmetadata","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","guid","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"guid":{"type":"string","description":"The globally unique identifier of the entity."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-add-or-update-business-metadata-attributes":{"post":{"operationId":"cloud_azure_purview_datamap_entity_add_or_update_business_metadata_attributes","summary":"Add or update business metadata attributes.","description":"POST /atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","businessMetadataName","guid","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"businessMetadataName":{"type":"string","description":"BusinessMetadata name"},"guid":{"type":"string","description":"The globally unique identifier of the entity."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-remove-business-metadata-attributes":{"post":{"operationId":"cloud_azure_purview_datamap_entity_remove_business_metadata_attributes","summary":"Delete business metadata attributes from an entity.","description":"DELETE /atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","businessMetadataName","guid","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"businessMetadataName":{"type":"string","description":"BusinessMetadata name"},"guid":{"type":"string","description":"The globally unique identifier of the entity."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-get-classification":{"get":{"operationId":"cloud_azure_purview_datamap_entity_get_classification","summary":"Get classification for a given entity represented by a GUID.","description":"GET /atlas/v2/entity/guid/{guid}/classification/{classificationName}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"guid","in":"query","required":true,"description":"The globally unique identifier of the entity.","schema":{"type":"string","description":"The globally unique identifier of the entity."}},{"name":"classificationName","in":"query","required":true,"description":"The name of the classification.","schema":{"type":"string","description":"The name of the classification."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-remove-classification":{"post":{"operationId":"cloud_azure_purview_datamap_entity_remove_classification","summary":"Delete a given classification from an existing entity represented by a GUID.","description":"DELETE /atlas/v2/entity/guid/{guid}/classification/{classificationName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","guid","classificationName"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"guid":{"type":"string","description":"The globally unique identifier of the entity."},"classificationName":{"type":"string","description":"The name of the classification."},"suppressDeletedClassification":{"type":"boolean","description":"To prevent classification changes from being overridden during regular scans, set this parameter to true. The default value is false."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-get-classifications":{"get":{"operationId":"cloud_azure_purview_datamap_entity_get_classifications","summary":"List classifications for a given entity represented by a GUID.","description":"GET /atlas/v2/entity/guid/{guid}/classifications","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"guid","in":"query","required":true,"description":"The globally unique identifier of the entity.","schema":{"type":"string","description":"The globally unique identifier of the entity."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-add-classifications":{"post":{"operationId":"cloud_azure_purview_datamap_entity_add_classifications","summary":"Add classifications to an existing entity represented by a GUID.","description":"POST /atlas/v2/entity/guid/{guid}/classifications","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","guid","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"guid":{"type":"string","description":"The globally unique identifier of the entity."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-update-classifications":{"post":{"operationId":"cloud_azure_purview_datamap_entity_update_classifications","summary":"Update classifications to an existing entity represented by a guid.","description":"PUT /atlas/v2/entity/guid/{guid}/classifications","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","guid","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"guid":{"type":"string","description":"The globally unique identifier of the entity."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-get-header":{"get":{"operationId":"cloud_azure_purview_datamap_entity_get_header","summary":"Get entity header given its GUID.","description":"GET /atlas/v2/entity/guid/{guid}/header","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"guid","in":"query","required":true,"description":"The globally unique identifier of the entity.","schema":{"type":"string","description":"The globally unique identifier of the entity."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-set-labels":{"post":{"operationId":"cloud_azure_purview_datamap_entity_set_labels","summary":"Set labels to a given entity.","description":"POST /atlas/v2/entity/guid/{guid}/labels","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","guid"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"guid":{"type":"string","description":"The globally unique identifier of the entity."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-add-label":{"post":{"operationId":"cloud_azure_purview_datamap_entity_add_label","summary":"Add given labels to a given entity.","description":"PUT /atlas/v2/entity/guid/{guid}/labels","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","guid"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"guid":{"type":"string","description":"The globally unique identifier of the entity."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-remove-labels":{"post":{"operationId":"cloud_azure_purview_datamap_entity_remove_labels","summary":"Delete given labels to a given entity.","description":"DELETE /atlas/v2/entity/guid/{guid}/labels","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","guid"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"guid":{"type":"string","description":"The globally unique identifier of the entity."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-get-by-unique-attributes":{"get":{"operationId":"cloud_azure_purview_datamap_entity_get_by_unique_attributes","summary":"Get complete definition of an entity given its type and unique attribute. In addition to the typeName path…","description":"GET /atlas/v2/entity/uniqueAttribute/type/{typeName}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"typeName","in":"query","required":true,"description":"The name of the type.","schema":{"type":"string","description":"The name of the type."}},{"name":"minExtInfo","in":"query","required":false,"description":"Whether to return minimal information for referred entities.","schema":{"type":"boolean","description":"Whether to return minimal information for referred entities."}},{"name":"ignoreRelationships","in":"query","required":false,"description":"Whether to ignore relationship attributes.","schema":{"type":"boolean","description":"Whether to ignore relationship attributes."}},{"name":"attr:qualifiedName","in":"query","required":false,"description":"The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)","schema":{"type":"string","description":"The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-partial-update-by-unique-attributes":{"post":{"operationId":"cloud_azure_purview_datamap_entity_partial_update_by_unique_attributes","summary":"Update entity partially - Allow a subset of attributes to be updated on an entity which is identified by its…","description":"PUT /atlas/v2/entity/uniqueAttribute/type/{typeName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","typeName","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"typeName":{"type":"string","description":"The name of the type."},"attr:qualifiedName":{"type":"string","description":"The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-delete-by-unique-attribute":{"post":{"operationId":"cloud_azure_purview_datamap_entity_delete_by_unique_attribute","summary":"Delete an entity identified by its type and unique attributes. In addition to the typeName path parameter,…","description":"DELETE /atlas/v2/entity/uniqueAttribute/type/{typeName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","typeName"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"typeName":{"type":"string","description":"The name of the type."},"attr:qualifiedName":{"type":"string","description":"The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-remove-classification-by-unique-attribute":{"post":{"operationId":"cloud_azure_purview_datamap_entity_remove_classification_by_unique_attribute","summary":"Delete a given classification from an entity identified by its type and unique attributes.","description":"DELETE /atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","typeName","classificationName"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"typeName":{"type":"string","description":"The name of the type."},"classificationName":{"type":"string","description":"The name of the classification."},"attr:qualifiedName":{"type":"string","description":"The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-add-classifications-by-unique-attribute":{"post":{"operationId":"cloud_azure_purview_datamap_entity_add_classifications_by_unique_attribute","summary":"Add classification to the entity identified by its type and unique attributes.","description":"POST /atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","typeName","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"typeName":{"type":"string","description":"The name of the type."},"attr:qualifiedName":{"type":"string","description":"The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-update-classifications-by-unique-attribute":{"post":{"operationId":"cloud_azure_purview_datamap_entity_update_classifications_by_unique_attribute","summary":"Update classification on an entity identified by its type and unique attributes.","description":"PUT /atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","typeName","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"typeName":{"type":"string","description":"The name of the type."},"attr:qualifiedName":{"type":"string","description":"The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-set-labels-by-unique-attribute":{"post":{"operationId":"cloud_azure_purview_datamap_entity_set_labels_by_unique_attribute","summary":"Set labels to a given entity identified by its type and unique attributes. If labels is null/empty, existing…","description":"POST /atlas/v2/entity/uniqueAttribute/type/{typeName}/labels","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","typeName"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"typeName":{"type":"string","description":"The name of the type."},"attr:qualifiedName":{"type":"string","description":"The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-add-labels-by-unique-attribute":{"post":{"operationId":"cloud_azure_purview_datamap_entity_add_labels_by_unique_attribute","summary":"Add given labels to a given entity identified by its type and unique attributes. If labels is null/empty, no…","description":"PUT /atlas/v2/entity/uniqueAttribute/type/{typeName}/labels","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","typeName"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"typeName":{"type":"string","description":"The name of the type."},"attr:qualifiedName":{"type":"string","description":"The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-remove-labels-by-unique-attribute":{"post":{"operationId":"cloud_azure_purview_datamap_entity_remove_labels_by_unique_attribute","summary":"Delete given labels to a given entity identified by its type and unique attribute. If labels is null/empty,…","description":"DELETE /atlas/v2/entity/uniqueAttribute/type/{typeName}/labels","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","typeName"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"typeName":{"type":"string","description":"The name of the type."},"attr:qualifiedName":{"type":"string","description":"The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-list":{"get":{"operationId":"cloud_azure_purview_datamap_glossary_list","summary":"Get all glossaries. Recommend using limit/offset to get pagination result. Recommend using…","description":"GET /atlas/v2/glossary","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."}},{"name":"limit","in":"query","required":false,"description":"The page size - by default there is no paging.","schema":{"type":"integer","description":"The page size - by default there is no paging."}},{"name":"offset","in":"query","required":false,"description":"The offset for pagination purpose.","schema":{"type":"integer","description":"The offset for pagination purpose."}},{"name":"sort","in":"query","required":false,"description":"The sort order, ASC (default) or DESC.","schema":{"type":"string","description":"The sort order, ASC (default) or DESC."}},{"name":"ignoreTermsAndCategories","in":"query","required":false,"description":"Whether ignore terms and categories","schema":{"type":"boolean","description":"Whether ignore terms and categories"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-create":{"post":{"operationId":"cloud_azure_purview_datamap_glossary_create","summary":"Create a glossary.","description":"POST /atlas/v2/glossary","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-get":{"get":{"operationId":"cloud_azure_purview_datamap_glossary_get","summary":"Get a specific Glossary by its GUID.","description":"GET /atlas/v2/glossary/{glossaryId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"glossaryId","in":"query","required":true,"description":"The globally unique identifier for glossary.","schema":{"type":"string","description":"The globally unique identifier for glossary."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-update":{"post":{"operationId":"cloud_azure_purview_datamap_glossary_update","summary":"Update the given glossary.","description":"PUT /atlas/v2/glossary/{glossaryId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","glossaryId","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"api-version":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."},"glossaryId":{"type":"string","description":"The globally unique identifier for glossary."},"ignoreTermsAndCategories":{"type":"boolean","description":"Whether ignore terms and categories"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-delete":{"post":{"operationId":"cloud_azure_purview_datamap_glossary_delete","summary":"Delete a glossary. Will delete underlying terms/categories together. Recommend separate delete terms and…","description":"DELETE /atlas/v2/glossary/{glossaryId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","glossaryId"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"glossaryId":{"type":"string","description":"The globally unique identifier for glossary."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-list-categories":{"get":{"operationId":"cloud_azure_purview_datamap_glossary_list_categories","summary":"Get the categories belonging to a specific glossary. Recommend using limit/offset to get pagination result.","description":"GET /atlas/v2/glossary/{glossaryId}/categories","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"glossaryId","in":"query","required":true,"description":"The globally unique identifier for glossary.","schema":{"type":"string","description":"The globally unique identifier for glossary."}},{"name":"limit","in":"query","required":false,"description":"The page size - by default there is no paging.","schema":{"type":"integer","description":"The page size - by default there is no paging."}},{"name":"offset","in":"query","required":false,"description":"The offset for pagination purpose.","schema":{"type":"integer","description":"The offset for pagination purpose."}},{"name":"sort","in":"query","required":false,"description":"The sort order, ASC (default) or DESC.","schema":{"type":"string","description":"The sort order, ASC (default) or DESC."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-list-categories-headers":{"get":{"operationId":"cloud_azure_purview_datamap_glossary_list_categories_headers","summary":"Get the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination…","description":"GET /atlas/v2/glossary/{glossaryId}/categories/headers","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"glossaryId","in":"query","required":true,"description":"The globally unique identifier for glossary.","schema":{"type":"string","description":"The globally unique identifier for glossary."}},{"name":"limit","in":"query","required":false,"description":"The page size - by default there is no paging.","schema":{"type":"integer","description":"The page size - by default there is no paging."}},{"name":"offset","in":"query","required":false,"description":"The offset for pagination purpose.","schema":{"type":"integer","description":"The offset for pagination purpose."}},{"name":"sort","in":"query","required":false,"description":"The sort order, ASC (default) or DESC.","schema":{"type":"string","description":"The sort order, ASC (default) or DESC."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-get-detailed":{"get":{"operationId":"cloud_azure_purview_datamap_glossary_get_detailed","summary":"Get a specific glossary with detailed information. This API is not recommend. Recommend to fetch…","description":"GET /atlas/v2/glossary/{glossaryId}/detailed","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."}},{"name":"glossaryId","in":"query","required":true,"description":"The globally unique identifier for glossary.","schema":{"type":"string","description":"The globally unique identifier for glossary."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-partial-update":{"post":{"operationId":"cloud_azure_purview_datamap_glossary_partial_update","summary":"Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated. So far…","description":"PUT /atlas/v2/glossary/{glossaryId}/partial","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","glossaryId","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"api-version":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."},"glossaryId":{"type":"string","description":"The globally unique identifier for glossary."},"ignoreTermsAndCategories":{"type":"boolean","description":"Whether ignore terms and categories"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-list-terms":{"get":{"operationId":"cloud_azure_purview_datamap_glossary_list_terms","summary":"Get terms belonging to a specific glossary. Recommend using limit/offset to get pagination result.","description":"GET /atlas/v2/glossary/{glossaryId}/terms","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."}},{"name":"glossaryId","in":"query","required":true,"description":"The globally unique identifier for glossary.","schema":{"type":"string","description":"The globally unique identifier for glossary."}},{"name":"limit","in":"query","required":false,"description":"The page size - by default there is no paging.","schema":{"type":"integer","description":"The page size - by default there is no paging."}},{"name":"offset","in":"query","required":false,"description":"The offset for pagination purpose.","schema":{"type":"integer","description":"The offset for pagination purpose."}},{"name":"sort","in":"query","required":false,"description":"The sort order, ASC (default) or DESC.","schema":{"type":"string","description":"The sort order, ASC (default) or DESC."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-list-term-headers":{"get":{"operationId":"cloud_azure_purview_datamap_glossary_list_term_headers","summary":"Get term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.","description":"GET /atlas/v2/glossary/{glossaryId}/terms/headers","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"glossaryId","in":"query","required":true,"description":"The globally unique identifier for glossary.","schema":{"type":"string","description":"The globally unique identifier for glossary."}},{"name":"limit","in":"query","required":false,"description":"The page size - by default there is no paging.","schema":{"type":"integer","description":"The page size - by default there is no paging."}},{"name":"offset","in":"query","required":false,"description":"The offset for pagination purpose.","schema":{"type":"integer","description":"The offset for pagination purpose."}},{"name":"sort","in":"query","required":false,"description":"The sort order, ASC (default) or DESC.","schema":{"type":"string","description":"The sort order, ASC (default) or DESC."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-create-categories":{"post":{"operationId":"cloud_azure_purview_datamap_glossary_create_categories","summary":"Create glossary category in bulk.","description":"POST /atlas/v2/glossary/categories","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-create-category":{"post":{"operationId":"cloud_azure_purview_datamap_glossary_create_category","summary":"Create a glossary category.","description":"POST /atlas/v2/glossary/category","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-get-category":{"get":{"operationId":"cloud_azure_purview_datamap_glossary_get_category","summary":"Get specific glossary category by its GUID.","description":"GET /atlas/v2/glossary/category/{categoryId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"categoryId","in":"query","required":true,"description":"The globally unique identifier of the category.","schema":{"type":"string","description":"The globally unique identifier of the category."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-update-category":{"post":{"operationId":"cloud_azure_purview_datamap_glossary_update_category","summary":"Update the given glossary category by its GUID.","description":"PUT /atlas/v2/glossary/category/{categoryId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","categoryId","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"categoryId":{"type":"string","description":"The globally unique identifier of the category."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-delete-category":{"post":{"operationId":"cloud_azure_purview_datamap_glossary_delete_category","summary":"Delete a glossary category.","description":"DELETE /atlas/v2/glossary/category/{categoryId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","categoryId"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"categoryId":{"type":"string","description":"The globally unique identifier of the category."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-partial-update-category":{"post":{"operationId":"cloud_azure_purview_datamap_glossary_partial_update_category","summary":"Update the glossary category partially. So far we only supports partial updating shortDescription and…","description":"PUT /atlas/v2/glossary/category/{categoryId}/partial","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","categoryId","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"categoryId":{"type":"string","description":"The globally unique identifier of the category."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-list-related-categories":{"get":{"operationId":"cloud_azure_purview_datamap_glossary_list_related_categories","summary":"Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being…","description":"GET /atlas/v2/glossary/category/{categoryId}/related","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"categoryId","in":"query","required":true,"description":"The globally unique identifier of the category.","schema":{"type":"string","description":"The globally unique identifier of the category."}},{"name":"limit","in":"query","required":false,"description":"The page size - by default there is no paging.","schema":{"type":"integer","description":"The page size - by default there is no paging."}},{"name":"offset","in":"query","required":false,"description":"The offset for pagination purpose.","schema":{"type":"integer","description":"The offset for pagination purpose."}},{"name":"sort","in":"query","required":false,"description":"The sort order, ASC (default) or DESC.","schema":{"type":"string","description":"The sort order, ASC (default) or DESC."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-list-category-terms":{"get":{"operationId":"cloud_azure_purview_datamap_glossary_list_category_terms","summary":"Get all terms associated with the specific category.","description":"GET /atlas/v2/glossary/category/{categoryId}/terms","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"categoryId","in":"query","required":true,"description":"The globally unique identifier of the category.","schema":{"type":"string","description":"The globally unique identifier of the category."}},{"name":"limit","in":"query","required":false,"description":"The page size - by default there is no paging.","schema":{"type":"integer","description":"The page size - by default there is no paging."}},{"name":"offset","in":"query","required":false,"description":"The offset for pagination purpose.","schema":{"type":"integer","description":"The offset for pagination purpose."}},{"name":"sort","in":"query","required":false,"description":"The sort order, ASC (default) or DESC.","schema":{"type":"string","description":"The sort order, ASC (default) or DESC."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-create-term":{"post":{"operationId":"cloud_azure_purview_datamap_glossary_create_term","summary":"Create a glossary term.","description":"POST /atlas/v2/glossary/term","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"includeTermHierarchy":{"type":"boolean","description":"Whether include term hierarchy"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-get-term":{"get":{"operationId":"cloud_azure_purview_datamap_glossary_get_term","summary":"Get a specific glossary term by its GUID.","description":"GET /atlas/v2/glossary/term/{termId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."}},{"name":"termId","in":"query","required":true,"description":"The globally unique identifier for glossary term.","schema":{"type":"string","description":"The globally unique identifier for glossary term."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-update-term":{"post":{"operationId":"cloud_azure_purview_datamap_glossary_update_term","summary":"Update the given glossary term by its GUID.","description":"PUT /atlas/v2/glossary/term/{termId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","termId","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"api-version":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."},"termId":{"type":"string","description":"The globally unique identifier for glossary term."},"includeTermHierarchy":{"type":"boolean","description":"Whether include term hierarchy"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-delete-term":{"post":{"operationId":"cloud_azure_purview_datamap_glossary_delete_term","summary":"Delete a glossary term.","description":"DELETE /atlas/v2/glossary/term/{termId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","termId"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"termId":{"type":"string","description":"The globally unique identifier for glossary term."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-partial-update-term":{"post":{"operationId":"cloud_azure_purview_datamap_glossary_partial_update_term","summary":"Update the glossary term partially. So far we only supports partial updating shortDescription,…","description":"PUT /atlas/v2/glossary/term/{termId}/partial","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","termId","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"api-version":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."},"termId":{"type":"string","description":"The globally unique identifier for glossary term."},"includeTermHierarchy":{"type":"boolean","description":"Whether include term hierarchy"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-create-terms":{"post":{"operationId":"cloud_azure_purview_datamap_glossary_create_terms","summary":"Create glossary terms in bulk.","description":"POST /atlas/v2/glossary/terms","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"api-version":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."},"includeTermHierarchy":{"type":"boolean","description":"Whether include term hierarchy"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-list-entities-assigned-with-term":{"get":{"operationId":"cloud_azure_purview_datamap_glossary_list_entities_assigned_with_term","summary":"List all related objects assigned with the specified term. Recommend using limit/offset to get pagination…","description":"GET /atlas/v2/glossary/terms/{termId}/assignedEntities","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"termId","in":"query","required":true,"description":"The globally unique identifier for glossary term.","schema":{"type":"string","description":"The globally unique identifier for glossary term."}},{"name":"limit","in":"query","required":false,"description":"The page size - by default there is no paging.","schema":{"type":"integer","description":"The page size - by default there is no paging."}},{"name":"offset","in":"query","required":false,"description":"The offset for pagination purpose.","schema":{"type":"integer","description":"The offset for pagination purpose."}},{"name":"sort","in":"query","required":false,"description":"The sort order, ASC (default) or DESC.","schema":{"type":"string","description":"The sort order, ASC (default) or DESC."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-assign-term-to-entities":{"post":{"operationId":"cloud_azure_purview_datamap_glossary_assign_term_to_entities","summary":"Assign the given term to the provided list of related objects. Recommend using small batches with multiple…","description":"POST /atlas/v2/glossary/terms/{termId}/assignedEntities","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","termId","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"termId":{"type":"string","description":"The globally unique identifier for glossary term."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-delete-term-assignment-from-entities":{"post":{"operationId":"cloud_azure_purview_datamap_glossary_delete_term_assignment_from_entities","summary":"Delete the term assignment for the given list of related objects.","description":"DELETE /atlas/v2/glossary/terms/{termId}/assignedEntities","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","termId","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"termId":{"type":"string","description":"The globally unique identifier for glossary term."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/glossary-list-related-terms":{"get":{"operationId":"cloud_azure_purview_datamap_glossary_list_related_terms","summary":"Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not…","description":"GET /atlas/v2/glossary/terms/{termId}/related","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."}},{"name":"termId","in":"query","required":true,"description":"The globally unique identifier for glossary term.","schema":{"type":"string","description":"The globally unique identifier for glossary term."}},{"name":"limit","in":"query","required":false,"description":"The page size - by default there is no paging.","schema":{"type":"integer","description":"The page size - by default there is no paging."}},{"name":"offset","in":"query","required":false,"description":"The offset for pagination purpose.","schema":{"type":"integer","description":"The offset for pagination purpose."}},{"name":"sort","in":"query","required":false,"description":"The sort order, ASC (default) or DESC.","schema":{"type":"string","description":"The sort order, ASC (default) or DESC."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/lineage-get":{"get":{"operationId":"cloud_azure_purview_datamap_lineage_get","summary":"Get lineage info of the entity specified by GUID.","description":"GET /atlas/v2/lineage/{guid}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"guid","in":"query","required":true,"description":"The globally unique identifier of the entity.","schema":{"type":"string","description":"The globally unique identifier of the entity."}},{"name":"depth","in":"query","required":false,"description":"The number of hops for lineage.","schema":{"type":"integer","description":"The number of hops for lineage."}},{"name":"direction","in":"query","required":true,"description":"The direction of the lineage, which could be INPUT, OUTPUT or BOTH.","schema":{"type":"string","enum":["INPUT","OUTPUT","BOTH"],"description":"The direction of the lineage, which could be INPUT, OUTPUT or BOTH."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/lineage-get-by-unique-attribute":{"get":{"operationId":"cloud_azure_purview_datamap_lineage_get_by_unique_attribute","summary":"Return lineage info about entity. In addition to the typeName path parameter, attribute key-value pair(s)…","description":"GET /atlas/v2/lineage/uniqueAttribute/type/{typeName}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"typeName","in":"query","required":true,"description":"The name of the type.","schema":{"type":"string","description":"The name of the type."}},{"name":"depth","in":"query","required":false,"description":"The number of hops for lineage.","schema":{"type":"integer","description":"The number of hops for lineage."}},{"name":"direction","in":"query","required":true,"description":"The direction of the lineage, which could be INPUT, OUTPUT or BOTH.","schema":{"type":"string","enum":["INPUT","OUTPUT","BOTH"],"description":"The direction of the lineage, which could be INPUT, OUTPUT or BOTH."}},{"name":"attr:qualifiedName","in":"query","required":false,"description":"The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)","schema":{"type":"string","description":"The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/relationship-create":{"post":{"operationId":"cloud_azure_purview_datamap_relationship_create","summary":"Create a new relationship between entities.","description":"POST /atlas/v2/relationship","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/relationship-update":{"post":{"operationId":"cloud_azure_purview_datamap_relationship_update","summary":"Update an existing relationship between entities.","description":"PUT /atlas/v2/relationship","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/relationship-get":{"get":{"operationId":"cloud_azure_purview_datamap_relationship_get","summary":"Get relationship information between entities by its GUID.","description":"GET /atlas/v2/relationship/guid/{guid}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"guid","in":"query","required":true,"description":"The globally unique identifier of the relationship.","schema":{"type":"string","description":"The globally unique identifier of the relationship."}},{"name":"extendedInfo","in":"query","required":false,"description":"Limits whether includes extended information.","schema":{"type":"boolean","description":"Limits whether includes extended information."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/relationship-delete":{"post":{"operationId":"cloud_azure_purview_datamap_relationship_delete","summary":"Delete a relationship between entities by its GUID.","description":"DELETE /atlas/v2/relationship/guid/{guid}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","guid"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"guid":{"type":"string","description":"The globally unique identifier of the relationship."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-get-business-metadata-def-by-guid":{"get":{"operationId":"cloud_azure_purview_datamap_type_get_business_metadata_def_by_guid","summary":"Get the businessMetadata definition for the given guid.","description":"GET /atlas/v2/types/businessmetadatadef/guid/{guid}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"guid","in":"query","required":true,"description":"businessMetadata guid","schema":{"type":"string","description":"businessMetadata guid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-get-business-metadata-def-by-name":{"get":{"operationId":"cloud_azure_purview_datamap_type_get_business_metadata_def_by_name","summary":"Get the businessMetadata definition by it's name (unique).","description":"GET /atlas/v2/types/businessmetadatadef/name/{name}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"name","in":"query","required":true,"description":"businessMetadata name","schema":{"type":"string","description":"businessMetadata name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-get-classification-def-by-guid":{"get":{"operationId":"cloud_azure_purview_datamap_type_get_classification_def_by_guid","summary":"Get the classification definition for the given GUID.","description":"GET /atlas/v2/types/classificationdef/guid/{guid}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"guid","in":"query","required":true,"description":"The globally unique identifier of the classification.","schema":{"type":"string","description":"The globally unique identifier of the classification."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-get-classification-def-by-name":{"get":{"operationId":"cloud_azure_purview_datamap_type_get_classification_def_by_name","summary":"Get the classification definition by its name (unique).","description":"GET /atlas/v2/types/classificationdef/name/{name}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"name","in":"query","required":true,"description":"The name of the classification.","schema":{"type":"string","description":"The name of the classification."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-get-entity-def-by-guid":{"get":{"operationId":"cloud_azure_purview_datamap_type_get_entity_def_by_guid","summary":"Get the Entity definition for the given GUID.","description":"GET /atlas/v2/types/entitydef/guid/{guid}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"guid","in":"query","required":true,"description":"The globally unique identifier of the entity.","schema":{"type":"string","description":"The globally unique identifier of the entity."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-get-entity-def-by-name":{"get":{"operationId":"cloud_azure_purview_datamap_type_get_entity_def_by_name","summary":"Get the entity definition by its name (unique).","description":"GET /atlas/v2/types/entitydef/name/{name}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"name","in":"query","required":true,"description":"The name of the entity.","schema":{"type":"string","description":"The name of the entity."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-get-enum-def-by-guid":{"get":{"operationId":"cloud_azure_purview_datamap_type_get_enum_def_by_guid","summary":"Get the enum definition for the given GUID.","description":"GET /atlas/v2/types/enumdef/guid/{guid}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"guid","in":"query","required":true,"description":"The globally unique identifier of the enum.","schema":{"type":"string","description":"The globally unique identifier of the enum."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-get-enum-def-by-name":{"get":{"operationId":"cloud_azure_purview_datamap_type_get_enum_def_by_name","summary":"Get the enum definition by its name (unique).","description":"GET /atlas/v2/types/enumdef/name/{name}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"name","in":"query","required":true,"description":"The name of the enum.","schema":{"type":"string","description":"The name of the enum."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-get-relationship-def-by-guid":{"get":{"operationId":"cloud_azure_purview_datamap_type_get_relationship_def_by_guid","summary":"Get the relationship definition for the given GUID.","description":"GET /atlas/v2/types/relationshipdef/guid/{guid}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"guid","in":"query","required":true,"description":"The globally unique identifier of the relationship.","schema":{"type":"string","description":"The globally unique identifier of the relationship."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-get-relationship-def-by-name":{"get":{"operationId":"cloud_azure_purview_datamap_type_get_relationship_def_by_name","summary":"Get the relationship definition by its name (unique).","description":"GET /atlas/v2/types/relationshipdef/name/{name}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"name","in":"query","required":true,"description":"The name of the relationship.","schema":{"type":"string","description":"The name of the relationship."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-get-struct-def-by-guid":{"get":{"operationId":"cloud_azure_purview_datamap_type_get_struct_def_by_guid","summary":"Get the struct definition for the given GUID.","description":"GET /atlas/v2/types/structdef/guid/{guid}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"guid","in":"query","required":true,"description":"The globally unique identifier of the struct.","schema":{"type":"string","description":"The globally unique identifier of the struct."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-get-struct-def-by-name":{"get":{"operationId":"cloud_azure_purview_datamap_type_get_struct_def_by_name","summary":"Get the struct definition by its name (unique).","description":"GET /atlas/v2/types/structdef/name/{name}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"name","in":"query","required":true,"description":"The name of the struct.","schema":{"type":"string","description":"The name of the struct."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-get-by-guid":{"get":{"operationId":"cloud_azure_purview_datamap_type_get_by_guid","summary":"Get the type definition for the given GUID.","description":"GET /atlas/v2/types/typedef/guid/{guid}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"guid","in":"query","required":true,"description":"The globally unique identifier of the type.","schema":{"type":"string","description":"The globally unique identifier of the type."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-get-by-name":{"get":{"operationId":"cloud_azure_purview_datamap_type_get_by_name","summary":"Get the type definition by its name (unique).","description":"GET /atlas/v2/types/typedef/name/{name}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"name","in":"query","required":true,"description":"The name of the type.","schema":{"type":"string","description":"The name of the type."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-delete":{"post":{"operationId":"cloud_azure_purview_datamap_type_delete","summary":"Delete API for type identified by its name.","description":"DELETE /atlas/v2/types/typedef/name/{name}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","name"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"name":{"type":"string","description":"The name of the type."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-list":{"get":{"operationId":"cloud_azure_purview_datamap_type_list","summary":"List all type definitions in bulk.","description":"GET /atlas/v2/types/typedefs","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."}},{"name":"includeTermTemplate","in":"query","required":false,"description":"Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template","schema":{"type":"boolean","description":"Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template"}},{"name":"type","in":"query","required":false,"description":"Typedef name as search filter when get typedefs.","schema":{"type":"string","enum":["PRIMITIVE","OBJECT_ID_TYPE","ENUM","STRUCT","CLASSIFICATION","ENTITY","ARRAY","MAP","RELATIONSHIP","TERM_TEMPLATE"],"description":"Typedef name as search filter when get typedefs."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-bulk-create":{"post":{"operationId":"cloud_azure_purview_datamap_type_bulk_create","summary":"Create all atlas type definitions in bulk. Please avoid recreating existing types.","description":"POST /atlas/v2/types/typedefs","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-bulk-update":{"post":{"operationId":"cloud_azure_purview_datamap_type_bulk_update","summary":"Update all types in bulk, changes detected in the type definitions would be persisted.","description":"PUT /atlas/v2/types/typedefs","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-bulk-delete":{"post":{"operationId":"cloud_azure_purview_datamap_type_bulk_delete","summary":"Delete API for all types in bulk.","description":"DELETE /atlas/v2/types/typedefs","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-list-headers":{"get":{"operationId":"cloud_azure_purview_datamap_type_list_headers","summary":"List all type definitions returned as a list of minimal information header.","description":"GET /atlas/v2/types/typedefs/headers","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."}},{"name":"includeTermTemplate","in":"query","required":false,"description":"Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template","schema":{"type":"boolean","description":"Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template"}},{"name":"type","in":"query","required":false,"description":"Typedef name as search filter when get typedefs.","schema":{"type":"string","enum":["PRIMITIVE","OBJECT_ID_TYPE","ENUM","STRUCT","CLASSIFICATION","ENTITY","ARRAY","MAP","RELATIONSHIP","TERM_TEMPLATE"],"description":"Typedef name as search filter when get typedefs."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/entity-move-entities-to-collection":{"post":{"operationId":"cloud_azure_purview_datamap_entity_move_entities_to_collection","summary":"Move existing entities to the target collection.","description":"POST /entity/moveTo","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","collectionId","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"api-version":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."},"collectionId":{"type":"string","description":"The collection where entities will be moved to."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/lineage-get-next-page":{"get":{"operationId":"cloud_azure_purview_datamap_lineage_get_next_page","summary":"Return immediate next page lineage info about entity with pagination","description":"GET /lineage/{guid}/next","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."}},{"name":"guid","in":"query","required":true,"description":"The globally unique identifier of the entity.","schema":{"type":"string","description":"The globally unique identifier of the entity."}},{"name":"direction","in":"query","required":true,"description":"The direction of the lineage, which could be INPUT, OUTPUT or BOTH.","schema":{"type":"string","enum":["INPUT","OUTPUT","BOTH"],"description":"The direction of the lineage, which could be INPUT, OUTPUT or BOTH."}},{"name":"offset","in":"query","required":false,"description":"The offset for pagination purpose.","schema":{"type":"integer","description":"The offset for pagination purpose."}},{"name":"limit","in":"query","required":false,"description":"The page size - by default there is no paging.","schema":{"type":"integer","description":"The page size - by default there is no paging."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/discovery-auto-complete":{"post":{"operationId":"cloud_azure_purview_datamap_discovery_auto_complete","summary":"Get auto complete options.","description":"POST /search/autocomplete","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"api-version":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/discovery-query":{"post":{"operationId":"cloud_azure_purview_datamap_discovery_query","summary":"Get data using search.","description":"POST /search/query","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"api-version":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/discovery-suggest":{"post":{"operationId":"cloud_azure_purview_datamap_discovery_suggest","summary":"Get search suggestions by query criteria.","description":"POST /search/suggest","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"},"api-version":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-get-term-template-def-by-guid":{"get":{"operationId":"cloud_azure_purview_datamap_type_get_term_template_def_by_guid","summary":"Get the term template definition for the given GUID.","description":"GET /types/termtemplatedef/guid/{guid}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."}},{"name":"guid","in":"query","required":true,"description":"The globally unique identifier of the term template.","schema":{"type":"string","description":"The globally unique identifier of the term template."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-purview-datamap/type-get-term-template-def-by-name":{"get":{"operationId":"cloud_azure_purview_datamap_type_get_term_template_def_by_name","summary":"Get the term template definition by its name (unique).","description":"GET /types/termtemplatedef/name/{name}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com","schema":{"type":"string","description":"Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2023-09-01","description":"The API version to use for this operation."}},{"name":"name","in":"query","required":true,"description":"The unique name of the term template.","schema":{"type":"string","description":"The unique name of the term template."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}