Relationship - Create

Reference

Service:: Purview

API Version:: 2023-09-01

Create a new relationship between entities.

POST {endpoint}/datamap/api/atlas/v2/relationship

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string

Request Body

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.

Responses

Name	Type	Description
200 OK	AtlasRelationship	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_Create

Sample request

HTTP

POST {endpoint}/datamap/api/atlas/v2/relationship

{
  "typeName": "AtlasGlossarySynonym",
  "attributes": {
    "expression": "Example Expression",
    "steward": "Example Steward",
    "description": "Example Description",
    "source": null,
    "status": null
  },
  "end1": {
    "guid": "856d31e6-e342-a1ce-6273-22ddb77029c6",
    "typeName": "AtlasGlossaryTerm"
  },
  "end2": {
    "guid": "77481037-2874-9bdc-9b9e-76bb94ee71aa",
    "typeName": "AtlasGlossaryTerm"
  },
  "label": "r:AtlasGlossarySynonym",
  "status": "ACTIVE",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "version": 0
}

Sample response

Status code:: 200

{
  "typeName": "AtlasGlossarySynonym",
  "attributes": {
    "expression": "Example Expression",
    "steward": "Example Steward",
    "description": "Example Description",
    "source": null,
    "status": null
  },
  "guid": "63023d5b-c499-4360-a513-16bcbf73b039",
  "end1": {
    "guid": "856d31e6-e342-a1ce-6273-22ddb77029c6",
    "typeName": "AtlasGlossaryTerm"
  },
  "end2": {
    "guid": "77481037-2874-9bdc-9b9e-76bb94ee71aa",
    "typeName": "AtlasGlossaryTerm"
  },
  "label": "r:AtlasGlossarySynonym",
  "status": "ACTIVE",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "createTime": 1553840134724,
  "updateTime": 1553840134724,
  "version": 0
}

Definitions

Name	Description
AtlasErrorResponse	An error response from the service
AtlasObjectId	Reference to an object-instance of a type - like entity.
AtlasRelationship	Atlas relationship instance.
StatusAtlasRelationship	Status for atlas relationship

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.

StatusAtlasRelationship

Status for atlas relationship

Name	Type	Description
ACTIVE	string	active
DELETED	string	deleted

Share via