PurviewEntities.GetByGuids 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

List entities in bulk identified by its GUIDs.

public virtual Azure.Response GetByGuids (System.Collections.Generic.IEnumerable<string> guids, bool? minExtInfo = default, bool? ignoreRelationships = default, System.Collections.Generic.IEnumerable<string> excludeRelationshipTypes = default, Azure.RequestContext context = default);

abstract member GetByGuids : seq<string> * Nullable<bool> * Nullable<bool> * seq<string> * Azure.RequestContext -> Azure.Response
override this.GetByGuids : seq<string> * Nullable<bool> * Nullable<bool> * seq<string> * Azure.RequestContext -> Azure.Response

Public Overridable Function GetByGuids (guids As IEnumerable(Of String), Optional minExtInfo As Nullable(Of Boolean) = Nothing, Optional ignoreRelationships As Nullable(Of Boolean) = Nothing, Optional excludeRelationshipTypes As IEnumerable(Of String) = Nothing, Optional context As RequestContext = Nothing) As Response

Parameters

guids

IEnumerable<String>

An array of GUIDs of entities to list.

minExtInfo

Nullable<Boolean>

Whether to return minimal information for referred entities.

ignoreRelationships

Nullable<Boolean>

Whether to ignore relationship attributes.

excludeRelationshipTypes

IEnumerable<String>

An array of the relationship types need to be excluded from the response.

context

RequestContext

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

Returns

Response

Exceptions

ArgumentNullException

guids is null.

Remarks

Schema for Response Body:

{
              referredEntities: Dictionary<string, AtlasEntity>,
              entities: [
                {
                  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 Error:

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