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

Relationship - Create

  • Ссылка
Служба:
Purview
Версия API:
2023-09-01

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

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

Параметры URI

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

string (uri)

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

Имя Тип Описание
attributes

Атрибуты структуры.
createTime

integer (int64)

Время создания записи.
createdBy

string

Пользователь, создавший запись.
end1

AtlasObjectId

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

AtlasObjectId

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

string

GUID связи.
homeId

string

Идентификатор домашней связи.
label

string

Метка связи.
lastModifiedTS

string

ETag для элемента управления параллелизмом.
provenanceType

integer (int32)

Используется для записи происхождения экземпляра сущности или связи
status

StatusAtlasRelationship

Перечисление состояния связи.
typeName

string

Имя типа.
updateTime

integer (int64)

Время обновления записи.
updatedBy

string

Пользователь, который обновил запись.
version

integer (int64)

Версия связи.

Ответы

Имя Тип Описание
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

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

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

Object

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

Имя Тип Описание
errorCode

string

Код ошибки.
errorMessage

string

Сообщение об ошибке.
requestId

string (uuid)

Идентификатор запроса.

AtlasObjectId

Object

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

Имя Тип Описание
guid

string

GUID объекта.
typeName

string

Имя типа.
uniqueAttributes

Уникальные атрибуты объекта.

AtlasRelationship

Object

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

Имя Тип Описание
attributes

Атрибуты структуры.
createTime

integer (int64)

Время создания записи.
createdBy

string

Пользователь, создавший запись.
end1

AtlasObjectId

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

AtlasObjectId

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

string

GUID связи.
homeId

string

Идентификатор домашней связи.
label

string

Метка связи.
lastModifiedTS

string

ETag для элемента управления параллелизмом.
provenanceType

integer (int32)

Используется для записи происхождения экземпляра сущности или связи
status

StatusAtlasRelationship

Перечисление состояния связи.
typeName

string

Имя типа.
updateTime

integer (int64)

Время обновления записи.
updatedBy

string

Пользователь, который обновил запись.
version

integer (int64)

Версия связи.

StatusAtlasRelationship

Перечисление

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

Значение Описание
ACTIVE

активный
DELETED

deleted