Condividi tramite


PurviewEntities.DeleteByUniqueAttribute Method

Definition

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:<attrName>=<attrValue>. 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.

public virtual Azure.Response DeleteByUniqueAttribute (string typeName, string attrQualifiedName = default, Azure.RequestContext context = default);
abstract member DeleteByUniqueAttribute : string * string * Azure.RequestContext -> Azure.Response
override this.DeleteByUniqueAttribute : string * string * Azure.RequestContext -> Azure.Response
Public Overridable Function DeleteByUniqueAttribute (typeName As String, Optional attrQualifiedName As String = Nothing, Optional context As RequestContext = Nothing) As Response

Parameters

typeName
String

The name of the type.

attrQualifiedName
String

The qualified name of the entity.

context
RequestContext

The request context, which can override default behaviors on the request on a per-call basis.

Returns

Exceptions

typeName is null.

typeName is an empty string, and was expected to be non-empty.

Remarks

Schema for Response Body:

{
              guidAssignments: Dictionary<string, string>,
              mutatedEntities: Dictionary<string, AtlasEntityHeader[]>,
              partialUpdatedEntities: [
                {
                  attributes: Dictionary<string, AnyObject>,
                  typeName: string,
                  lastModifiedTS: string,
                  classificationNames: [string],
                  classifications: [
                    {
                      attributes: Dictionary<string, AnyObject>,
                      typeName: string,
                      lastModifiedTS: string,
                      entityGuid: string,
                      entityStatus: "ACTIVE" | "DELETED",
                      removePropagationsOnEntityDelete: boolean,
                      validityPeriods: [
                        {
                          endTime: string,
                          startTime: string,
                          timeZone: string
                        }
                      ],
                      source: string,
                      sourceDetails: Dictionary<string, AnyObject>
                    }
                  ],
                  displayText: string,
                  guid: string,
                  isIncomplete: boolean,
                  labels: [string],
                  meaningNames: [string],
                  meanings: [
                    {
                      confidence: number,
                      createdBy: string,
                      description: string,
                      displayText: string,
                      expression: string,
                      relationGuid: string,
                      source: string,
                      status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER",
                      steward: string,
                      termGuid: string
                    }
                  ],
                  status: "ACTIVE" | "DELETED"
                }
              ]
            }

Schema for Response Error:

{
              requestId: string,
              errorCode: string,
              errorMessage: string
            }

Applies to