PurviewCollections.MoveEntitiesToCollection Method

Definition

Namespace:

Azure.Analytics.Purview.Catalog

Assembly:

Azure.Analytics.Purview.Catalog.dll

Package:

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

Source:

PurviewCollections.cs

Move existing entities to the target collection.

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

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

Public Overridable Function MoveEntitiesToCollection (collection As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response

Parameters

collection

String

the collection unique name.

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

collection or content is null.

ArgumentException

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

Remarks

Schema for Request Body:

{
              entityGuids: [string]
            }

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
            }