{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Entity API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Entity", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Post Entity Moveto", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/entity/moveTo", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "collectionId", "value": "", "type": "query", "description": "The collection where entities will be moved to." } ] }, "docs": "Move existing entities to the target collection." }, { "info": { "name": "Microsoft Azure Post Atlas Entity", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/atlas/v2/entity", "params": [ { "name": "businessAttributeUpdateBehavior", "value": "", "type": "query", "description": "Used to define the update behavior for business attributes when updating entities." } ] }, "docs": "Create or update an entity in Atlas.
Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName.
Map and array of collections are not well supported. E.g., array>, array>.
For each contact type, the maximum number of contacts is 20." }, { "info": { "name": "Microsoft Azure Get Atlas Entity Bulk", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/atlas/v2/entity/bulk", "params": [ { "name": "guid", "value": "", "type": "query", "description": "An array of GUIDs of entities to list." }, { "name": "minExtInfo", "value": "", "type": "query", "description": "Whether to return minimal information for referred entities." }, { "name": "ignoreRelationships", "value": "", "type": "query", "description": "Whether to ignore relationship attributes." }, { "name": "excludeRelationshipTypes", "value": "", "type": "query", "description": "An array of the relationship types need to be excluded from the response." } ] }, "docs": "List entities in bulk identified by its GUIDs." }, { "info": { "name": "Microsoft Azure Post Atlas Entity Bulk", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/atlas/v2/entity/bulk", "params": [ { "name": "businessAttributeUpdateBehavior", "value": "", "type": "query", "description": "Used to define the update behavior for business attributes when updating entities." } ] }, "docs": "Create or update entities in Atlas in bulk.
Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName.
Map and array of collections are not well supported. E.g., array>, array>.
For each contact type, the maximum number of contacts is 20." }, { "info": { "name": "Microsoft Azure Delete Atlas Entity Bulk", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/atlas/v2/entity/bulk", "params": [ { "name": "guid", "value": "", "type": "query", "description": "An array of GUIDs of entities to delete." } ] }, "docs": "Delete a list of entities in bulk identified by their GUIDs or unique attributes." }, { "info": { "name": "Microsoft Azure Post Atlas Entity Bulk Classification", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/atlas/v2/entity/bulk/classification" }, "docs": "Associate a classification to multiple entities in bulk." }, { "info": { "name": "Microsoft Azure Get Atlas Entity Guid Guid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/atlas/v2/entity/guid/:guid", "params": [ { "name": "guid", "value": "", "type": "path", "description": "The globally unique identifier of the entity." }, { "name": "minExtInfo", "value": "", "type": "query", "description": "Whether to return minimal information for referred entities." }, { "name": "ignoreRelationships", "value": "", "type": "query", "description": "Whether to ignore relationship attributes." } ] }, "docs": "Get complete definition of an entity given its GUID." }, { "info": { "name": "Microsoft Azure Put Atlas Entity Guid Guid", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/atlas/v2/entity/guid/:guid", "params": [ { "name": "guid", "value": "", "type": "path", "description": "The globally unique identifier of the entity." }, { "name": "name", "value": "", "type": "query", "description": "The name of the attribute." } ] }, "docs": "Update entity partially - create or update entity attribute identified by its GUID.
Supports only primitive attribute type and entity references.
It does not support updating complex types like arrays, and maps.
Null updates are not possible." }, { "info": { "name": "Microsoft Azure Delete Atlas Entity Guid Guid", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/atlas/v2/entity/guid/:guid", "params": [ { "name": "guid", "value": "", "type": "path", "description": "The globally unique identifier of the entity." } ] }, "docs": "Delete an entity identified by its GUID." }, { "info": { "name": "Microsoft Azure Get Atlas Entity Guid Guid Classification Classificationname", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/atlas/v2/entity/guid/:guid/classification/:classificationName", "params": [ { "name": "guid", "value": "", "type": "path", "description": "The globally unique identifier of the entity." }, { "name": "classificationName", "value": "", "type": "path", "description": "The name of the classification." } ] }, "docs": "List classifications for a given entity represented by a GUID." }, { "info": { "name": "Microsoft Azure Delete Atlas Entity Guid Guid Classification Classificationname", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/atlas/v2/entity/guid/:guid/classification/:classificationName", "params": [ { "name": "guid", "value": "", "type": "path", "description": "The globally unique identifier of the entity." }, { "name": "classificationName", "value": "", "type": "path", "description": "The name of the classification." } ] }, "docs": "Delete a given classification from an existing entity represented by a GUID." }, { "info": { "name": "Microsoft Azure Get Atlas Entity Guid Guid Classifications", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/atlas/v2/entity/guid/:guid/classifications", "params": [ { "name": "guid", "value": "", "type": "path", "description": "The globally unique identifier of the entity." } ] }, "docs": "List classifications for a given entity represented by a GUID." }, { "info": { "name": "Microsoft Azure Post Atlas Entity Guid Guid Classifications", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/atlas/v2/entity/guid/:guid/classifications", "params": [ { "name": "guid", "value": "", "type": "path", "description": "The globally unique identifier of the entity." } ] }, "docs": "Add classifications to an existing entity represented by a GUID." }, { "info": { "name": "Microsoft Azure Put Atlas Entity Guid Guid Classifications", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/atlas/v2/entity/guid/:guid/classifications", "params": [ { "name": "guid", "value": "", "type": "path", "description": "The globally unique identifier of the entity." } ] }, "docs": "Update classifications to an existing entity represented by a guid." }, { "info": { "name": "Microsoft Azure Get Atlas Entity Uniqueattribute Type Typename", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/atlas/v2/entity/uniqueAttribute/type/:typeName", "params": [ { "name": "typeName", "value": "", "type": "path", "description": "The name of the type." }, { "name": "minExtInfo", "value": "", "type": "query", "description": "Whether to return minimal information for referred entities." }, { "name": "ignoreRelationships", "value": "", "type": "query", "description": "Whether to ignore relationship attributes." }, { "name": "attr:qualifiedName", "value": "", "type": "query", "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)" } ] }, "docs": "Get complete definition of an entity given its type and unique attribute.
In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format:
attr:\\=.
NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.
The REST request would look something like this:
GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue." }, { "info": { "name": "Microsoft Azure Put Atlas Entity Uniqueattribute Type Typename", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/atlas/v2/entity/uniqueAttribute/type/:typeName", "params": [ { "name": "typeName", "value": "", "type": "path", "description": "The name of the type." }, { "name": "attr:qualifiedName", "value": "", "type": "query", "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)" } ] }, "docs": "Update entity partially - Allow a subset of attributes to be updated on
an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName.
Null updates are not possible.
In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format:
attr:=.
NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.
The REST request would look something like this:
PUT /v2/entity/uniqueAt" }, { "info": { "name": "Microsoft Azure Delete Atlas Entity Uniqueattribute Type Typename", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/atlas/v2/entity/uniqueAttribute/type/:typeName", "params": [ { "name": "typeName", "value": "", "type": "path", "description": "The name of the type." }, { "name": "attr:qualifiedName", "value": "", "type": "query", "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)" } ] }, "docs": "Delete an entity identified by its type and unique attributes.
In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format:
attr:\\=\\.
NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.
The REST request would look something like this:
DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue." }, { "info": { "name": "Microsoft Azure Delete Atlas Entity Uniqueattribute Type Typename Classification Classificationname", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/atlas/v2/entity/uniqueAttribute/type/:typeName/classification/:classificationName", "params": [ { "name": "typeName", "value": "", "type": "path", "description": "The name of the type." }, { "name": "classificationName", "value": "", "type": "path", "description": "The name of the classification." }, { "name": "attr:qualifiedName", "value": "", "type": "query", "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)" } ] }, "docs": "Delete a given classification from an entity identified by its type and unique attributes." }, { "info": { "name": "Microsoft Azure Post Atlas Entity Uniqueattribute Type Typename Classifications", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/atlas/v2/entity/uniqueAttribute/type/:typeName/classifications", "params": [ { "name": "typeName", "value": "", "type": "path", "description": "The name of the type." }, { "name": "attr:qualifiedName", "value": "", "type": "query", "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)" } ] }, "docs": "Add classification to the entity identified by its type and unique attributes." }, { "info": { "name": "Microsoft Azure Put Atlas Entity Uniqueattribute Type Typename Classifications", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/atlas/v2/entity/uniqueAttribute/type/:typeName/classifications", "params": [ { "name": "typeName", "value": "", "type": "path", "description": "The name of the type." }, { "name": "attr:qualifiedName", "value": "", "type": "query", "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)" } ] }, "docs": "Update classification on an entity identified by its type and unique attributes." }, { "info": { "name": "Microsoft Azure Post Atlas Entity Bulk Setclassifications", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/atlas/v2/entity/bulk/setClassifications" }, "docs": "Set classifications on entities in bulk." }, { "info": { "name": "Microsoft Azure Get Atlas Entity Bulk Uniqueattribute Type Typename", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/atlas/v2/entity/bulk/uniqueAttribute/type/:typeName", "params": [ { "name": "typeName", "value": "", "type": "path", "description": "The name of the type." }, { "name": "minExtInfo", "value": "", "type": "query", "description": "Whether to return minimal information for referred entities." }, { "name": "ignoreRelationships", "value": "", "type": "query", "description": "Whether to ignore relationship attributes." }, { "name": "attr_N:qualifiedName", "value": "", "type": "query", "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 only an example. qualifiedName can be changed to other unique attributes)" } ] }, "docs": "Bulk API to retrieve list of entities identified by its unique attributes.

In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format

typeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\

NOTE: The attrName should be an unique attribute for the given entity-type

The REST request would look something like this

GET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1
N" }, { "info": { "name": "Microsoft Azure Get Atlas Entity Guid Guid Header", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/atlas/v2/entity/guid/:guid/header", "params": [ { "name": "guid", "value": "", "type": "path", "description": "The globally unique identifier of the entity." } ] }, "docs": "Get entity header given its GUID." }, { "info": { "name": "Microsoft Azure Post Atlas Entity Guid Guid Businessmetadata", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/atlas/v2/entity/guid/:guid/businessmetadata", "params": [ { "name": "guid", "value": "", "type": "path", "description": "The globally unique identifier of the entity." }, { "name": "isOverwrite", "value": "", "type": "query", "description": "Whether to overwrite the existing business metadata on the entity or not, default is false." } ] }, "docs": "Add business metadata to an entity." }, { "info": { "name": "Microsoft Azure Delete Atlas Entity Guid Guid Businessmetadata", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/atlas/v2/entity/guid/:guid/businessmetadata", "params": [ { "name": "guid", "value": "", "type": "path", "description": "The globally unique identifier of the entity." } ] }, "docs": "Remove business metadata from an entity." }, { "info": { "name": "Microsoft Azure Post Atlas Entity Guid Guid Businessmetadata Bmname", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/atlas/v2/entity/guid/:guid/businessmetadata/:bmName", "params": [ { "name": "bmName", "value": "", "type": "path", "description": "BusinessMetadata name" }, { "name": "guid", "value": "", "type": "path", "description": "The globally unique identifier of the entity." } ] }, "docs": "Add or update business metadata attributes" }, { "info": { "name": "Microsoft Azure Delete Atlas Entity Guid Guid Businessmetadata Bmname", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/atlas/v2/entity/guid/:guid/businessmetadata/:bmName", "params": [ { "name": "bmName", "value": "", "type": "path", "description": "BusinessMetadata name" }, { "name": "guid", "value": "", "type": "path", "description": "The globally unique identifier of the entity." } ] }, "docs": "Delete business metadata attributes from an entity." }, { "info": { "name": "Microsoft Azure Get Atlas Entity Businessmetadata Import Template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/atlas/v2/entity/businessmetadata/import/template" }, "docs": "Get the sample Template for uploading/creating bulk BusinessMetaData" }, { "info": { "name": "Microsoft Azure Post Atlas Entity Businessmetadata Import", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/atlas/v2/entity/businessmetadata/import" }, "docs": "Upload the file for creating Business Metadata in BULK" }, { "info": { "name": "Microsoft Azure Post Atlas Entity Guid Guid Labels", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/atlas/v2/entity/guid/:guid/labels", "params": [ { "name": "guid", "value": "", "type": "path", "description": "The globally unique identifier of the entity." } ] }, "docs": "Set labels to a given entity" }, { "info": { "name": "Microsoft Azure Put Atlas Entity Guid Guid Labels", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/atlas/v2/entity/guid/:guid/labels", "params": [ { "name": "guid", "value": "", "type": "path", "description": "The globally unique identifier of the entity." } ] }, "docs": "add given labels to a given entity" }, { "info": { "name": "Microsoft Azure Delete Atlas Entity Guid Guid Labels", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/atlas/v2/entity/guid/:guid/labels", "params": [ { "name": "guid", "value": "", "type": "path", "description": "The globally unique identifier of the entity." } ] }, "docs": "delete given labels to a given entity" }, { "info": { "name": "Microsoft Azure Post Atlas Entity Uniqueattribute Type Typename Labels", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/atlas/v2/entity/uniqueAttribute/type/:typeName/labels", "params": [ { "name": "typeName", "value": "", "type": "path", "description": "The name of the type." }, { "name": "attr:qualifiedName", "value": "", "type": "query", "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)" } ] }, "docs": "Set labels to a given entity identified by its type and unique attributes, if labels is null/empty, existing labels will all be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue." }, { "info": { "name": "Microsoft Azure Put Atlas Entity Uniqueattribute Type Typename Labels", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/atlas/v2/entity/uniqueAttribute/type/:typeName/labels", "params": [ { "name": "typeName", "value": "", "type": "path", "description": "The name of the type." }, { "name": "attr:qualifiedName", "value": "", "type": "query", "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)" } ] }, "docs": "Add given labels to a given entity identified by its type and unique attributes, if labels is null/empty, no labels will be added. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue." }, { "info": { "name": "Microsoft Azure Delete Atlas Entity Uniqueattribute Type Typename Labels", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/atlas/v2/entity/uniqueAttribute/type/:typeName/labels", "params": [ { "name": "typeName", "value": "", "type": "path", "description": "The name of the type." }, { "name": "attr:qualifiedName", "value": "", "type": "query", "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)" } ] }, "docs": "Delete given labels to a given entity identified by its type and unique attributes, if labels is null/empty, no labels will be removed. If any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like t" }, { "info": { "name": "Microsoft Azure Delete Entity Bulk Delete", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/entity/bulk/delete", "params": [ { "name": "guid", "value": "", "type": "query", "description": "An array of GUIDs of entities to delete." }, { "name": "parallelCount", "value": "", "type": "query", "description": "This parameter is used only for entity bulk delete to define the number of concurrent threads." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API." } ] }, "docs": "Delete entities with hierarchy" }, { "info": { "name": "Microsoft Azure Get Entity Operations Operationid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/entity/operations/:operationId", "params": [ { "name": "operationId", "value": "", "type": "path", "description": "The globally unique identifier for async operation job." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API." } ] }, "docs": "Get the status of entity long running operation" } ] } ], "bundled": true }