Relationship - Get

Reference

Service:: Purview

API Version:: 2023-09-01

Get relationship information between entities by its GUID.

GET {endpoint}/datamap/api/atlas/v2/relationship/guid/{guid}

With optional parameters:

GET {endpoint}/datamap/api/atlas/v2/relationship/guid/{guid}?extendedInfo={extendedInfo}

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string
guid	path	True	string	The globally unique identifier of the relationship.
extendedInfo	query		boolean	Limits whether includes extended information.

Responses

Name	Type	Description
200 OK	AtlasRelationshipWithExtInfo	The request has succeeded.
Other Status Codes	AtlasErrorResponse	An unexpected error response.

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://purview.azure.net/.default

Examples

Relationship_Get

Sample request

HTTP

GET {endpoint}/datamap/api/atlas/v2/relationship/guid/5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb?extendedInfo=false

Sample response

Status code:: 200

{
  "relationship": {
    "typeName": "AtlasGlossarySynonym",
    "attributes": {
      "expression": null,
      "steward": null,
      "description": null,
      "source": null,
      "status": null
    },
    "guid": "de23cd5a-021c-413d-98a5-98752a1f7a3b",
    "end1": {
      "guid": "856d31e6-e342-a1ce-6273-22ddb77029c6",
      "typeName": "AtlasGlossaryTerm"
    },
    "end2": {
      "guid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef",
      "typeName": "AtlasGlossaryTerm"
    },
    "label": "r:AtlasGlossarySynonym",
    "status": "ACTIVE",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "createTime": 1553838993803,
    "updateTime": 1553838993803,
    "version": 0
  }
}

Definitions

Name	Description
AtlasClassification	An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.
AtlasEntityHeader	An instance of an entity - like hive_table, hive_database.
AtlasErrorResponse	An error response from the service
AtlasObjectId	Reference to an object-instance of a type - like entity.
AtlasRelationship	Atlas relationship instance.
AtlasRelationshipWithExtInfo	The relationship with extended information.
AtlasTermAssignmentHeader	The header for term assignment.
AtlasTermAssignmentStatus	Status for term assignment
EntityStatus	Status - can be active or deleted
StatusAtlasRelationship	Status for atlas relationship
TimeBoundary	Captures time-boundary details

AtlasClassification

An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.

Name	Type	Description
attributes		The attributes of the struct.
entityGuid	string	The GUID of the entity.
entityStatus	EntityStatus	Status of the entity - can be active or deleted. Deleted entities are not removed.
lastModifiedTS	string	ETag for concurrency control.
removePropagationsOnEntityDelete	boolean	Determines if propagations will be removed on entity deletion.
typeName	string	The name of the type.
validityPeriods	TimeBoundary[]	An array of time boundaries indicating validity periods.

AtlasEntityHeader

An instance of an entity - like hive_table, hive_database.

Name	Type	Description
attributes		The attributes of the struct.
classificationNames	string[]	An array of classification names.
classifications	AtlasClassification[]	An array of classifications.
displayText	string	The display text.
guid	string	The GUID of the record.
isIncomplete	boolean	Whether it is a shell entity
labels	string[]	labels
lastModifiedTS	string	ETag for concurrency control.
meaningNames	string[]	An array of meanings.
meanings	AtlasTermAssignmentHeader[]	An array of term assignment headers.
status	EntityStatus	Status of the entity - can be active or deleted. Deleted entities are not removed.
typeName	string	The name of the type.

AtlasErrorResponse

An error response from the service

Name	Type	Description
errorCode	string	The error code.
errorMessage	string	The error message.
requestId	string	The request ID.

AtlasObjectId

Reference to an object-instance of a type - like entity.

Name	Type	Description
guid	string	The GUID of the object.
typeName	string	The name of the type.
uniqueAttributes		The unique attributes of the object.

AtlasRelationship

Atlas relationship instance.

Name	Type	Description
attributes		The attributes of the struct.
createTime	integer	The created time of the record.
createdBy	string	The user who created the record.
end1	AtlasObjectId	Reference to an object-instance of a type - like entity.
end2	AtlasObjectId	Reference to an object-instance of a type - like entity.
guid	string	The GUID of the relationship.
homeId	string	The home ID of the relationship.
label	string	The label of the relationship.
lastModifiedTS	string	ETag for concurrency control.
provenanceType	integer	Used to record the provenance of an instance of an entity or relationship
status	StatusAtlasRelationship	The enum of relationship status.
typeName	string	The name of the type.
updateTime	integer	The update time of the record.
updatedBy	string	The user who updated the record.
version	integer	The version of the relationship.

AtlasRelationshipWithExtInfo

The relationship with extended information.

Name	Type	Description
referredEntities	<string, AtlasEntityHeader>	The referred entity header.
relationship	AtlasRelationship	Atlas relationship instance.

AtlasTermAssignmentHeader

The header for term assignment.

Name	Type	Description
confidence	integer	The confidence of the term assignment.
createdBy	string	The user who created the record.
description	string	The description of the term assignment.
displayText	string	The display text.
expression	string	The expression of the term assignment.
relationGuid	string	The GUID of the relationship.
status	AtlasTermAssignmentStatus	The status of terms assignment.
steward	string	The steward of the term.
termGuid	string	The GUID of the term.

AtlasTermAssignmentStatus

Status for term assignment

Name	Type	Description
DEPRECATED	string	The status is deprecated.
DISCOVERED	string	The status is discovered.
IMPORTED	string	The status is imported.
OBSOLETE	string	The status is obsolete.
OTHER	string	Other status.
PROPOSED	string	The status is proposed.
VALIDATED	string	The status is validated.

EntityStatus

Status - can be active or deleted

Name	Type	Description
ACTIVE	string	The status is active.
DELETED	string	The status is deleted.

StatusAtlasRelationship

Status for atlas relationship

Name	Type	Description
ACTIVE	string	active
DELETED	string	deleted

TimeBoundary

Captures time-boundary details

Name	Type	Description
endTime	string	The end of the time boundary.
startTime	string	The start of the time boundary.
timeZone	string	The timezone of the time boundary.

Share via