PurviewEntities.CreateOrUpdate(RequestContent, RequestContext) Method

Definition

Namespace:

Azure.Analytics.Purview.Catalog

Assembly:

Azure.Analytics.Purview.Catalog.dll

Package:

Azure.Analytics.Purview.Catalog v1.0.0-beta.4

Source:

PurviewEntities.cs

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<int>>, array<map<string, int>>.

public virtual Azure.Response CreateOrUpdate (Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member CreateOrUpdate : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.CreateOrUpdate : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response

Public Overridable Function CreateOrUpdate (content As RequestContent, Optional context As RequestContext = Nothing) As Response

Parameters

content

RequestContent

The content to send as the body of the request.

context

RequestContext

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

Returns

Response

Exceptions

ArgumentNullException

content is null.

Remarks

Schema for Request Body:

{
              referredEntities: Dictionary<string, AtlasEntity>,
              entity: {
                attributes: Dictionary<string, AnyObject>,
                typeName: string,
                lastModifiedTS: string,
                businessAttributes: Dictionary<string, AnyObject>,
                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>
                  }
                ],
                createTime: number,
                createdBy: string,
                customAttributes: Dictionary<string, string>,
                guid: string,
                homeId: string,
                isIncomplete: boolean,
                labels: [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
                  }
                ],
                provenanceType: number,
                proxy: boolean,
                relationshipAttributes: Dictionary<string, AnyObject>,
                status: "ACTIVE" | "DELETED",
                updateTime: number,
                updatedBy: string,
                version: number,
                source: string,
                sourceDetails: Dictionary<string, AnyObject>,
                contacts: Dictionary<string, ContactBasic[]>
              }
            }

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
            }