Relationship - Create

Ссылка

Служба:: Purview

Версия API:: 2023-09-01

Создание новой связи между сущностями.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string

Текст запроса

Имя	Тип	Описание
attributes		Атрибуты структуры.
createTime	integer	Время создания записи.
createdBy	string	Пользователь, создавший запись.
end1	AtlasObjectId	Ссылка на экземпляр объекта типа , например сущность.
end2	AtlasObjectId	Ссылка на экземпляр объекта типа , например сущность.
guid	string	GUID связи.
homeId	string	Идентификатор домашней страницы связи.
label	string	Метка связи.
lastModifiedTS	string	ETag для управления параллелизмом.
provenanceType	integer	Используется для записи происхождения экземпляра сущности или связи
status	StatusAtlasRelationship	Перечисление состояния связи.
typeName	string	Имя типа.
updateTime	integer	Время обновления записи.
updatedBy	string	Пользователь, который обновил запись.
version	integer	Версия связи.

Ответы

Имя	Тип	Описание
200 OK	AtlasRelationship	Запрос выполнен успешно.
Other Status Codes	AtlasErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://purview.azure.net/.default

Примеры

Relationship_Create

Образец запроса

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
}

Пример ответа

Код состояния:: 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
}

Определения

Имя	Описание
AtlasErrorResponse	Ответ об ошибке от службы
AtlasObjectId	Ссылка на экземпляр объекта типа , например сущность.
AtlasRelationship	Экземпляр связи Atlas.
StatusAtlasRelationship	Состояние связи atlas

AtlasErrorResponse

Ответ об ошибке от службы

Имя	Тип	Описание
errorCode	string	Код ошибки.
errorMessage	string	Сообщение об ошибке.
requestId	string	Идентификатор запроса.

AtlasObjectId

Ссылка на экземпляр объекта типа , например сущность.

Имя	Тип	Описание
guid	string	GUID объекта .
typeName	string	Имя типа.
uniqueAttributes		Уникальные атрибуты объекта .

AtlasRelationship

Экземпляр связи Atlas.

Имя	Тип	Описание
attributes		Атрибуты структуры.
createTime	integer	Время создания записи.
createdBy	string	Пользователь, создавший запись.
end1	AtlasObjectId	Ссылка на экземпляр объекта типа , например сущность.
end2	AtlasObjectId	Ссылка на экземпляр объекта типа , например сущность.
guid	string	GUID связи.
homeId	string	Идентификатор домашней страницы связи.
label	string	Метка связи.
lastModifiedTS	string	ETag для управления параллелизмом.
provenanceType	integer	Используется для записи происхождения экземпляра сущности или связи
status	StatusAtlasRelationship	Перечисление состояния связи.
typeName	string	Имя типа.
updateTime	integer	Время обновления записи.
updatedBy	string	Пользователь, который обновил запись.
version	integer	Версия связи.

StatusAtlasRelationship

Состояние связи atlas

Имя	Тип	Описание
ACTIVE	string	active
DELETED	string	deleted

Поделиться через