Share via

Twins - DigitalTwins AddRelationship

  • Ссылка
Service:
Azure Digital Twins
API Version:
2023-10-31

Добавляет связь между двумя цифровыми двойниками. Коды состояния:

  • 200 ОК
  • 400 — недопустимый запрос
    • InvalidArgument — недопустимый идентификатор цифрового двойника, идентификатор связи или полезные данные.
    • InvalidRelationship — недопустимая связь.
    • OperationNotAllowed — связь не может подключиться к тому же цифровому двойнику.
    • ValidationFailed — недопустимое содержимое связи.
  • 404 — не найдено
    • DigitalTwinNotFound — цифровой двойник не найден.
    • TargetTwinNotFound — целевой объект цифрового двойника связи не найден.
  • 412 — Необходимое условие не выполнено
    • Предусловие — проверка предусловия (if-Match или If-None-Match) завершилась сбоем.
PUT https://digitaltwins-hostname/digitaltwins/{id}/relationships/{relationshipId}?api-version=2023-10-31

Параметры URI

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

string

Идентификатор цифрового двойника. Идентификатор уникален в пределах службы и учитывает регистр.
relationshipId
 path True

string

Идентификатор связи. Идентификатор уникален в пределах цифрового двойника и учитывает регистр.
api-version
 query True

string

Запрошенная версия API.

Заголовок запроса

Имя Обязательно Тип Описание
If-None-Match

string

Выполняйте операцию только в том случае, если сущность еще не существует.
traceparent

string

Определяет запрос в распределенной системе трассировки.
tracestate

string

Предоставляет сведения об идентификации трассировки для конкретных поставщиков и является компаньоном для объекта traceparent.

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

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

object

Данные для связи.

Ответы

Имя Тип Описание
200 OK

Relationship

Успешное завершение

Headers

ETag: string
Other Status Codes

ErrorResponse

Ответ по умолчанию.

Headers

x-ms-error-code: string

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

oauth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0

Примеры

Create a relationship
Create a relationship (with properties)

Create a relationship

Sample Request

PUT https://digitaltwins-hostname/digitaltwins/mySourceTwin/relationships/myRelationshipId?api-version=2023-10-31

{
  "$targetId": "myTargetTwin",
  "$relationshipName": "myRelationship"
}

Sample Response

Status code:
200 
{
  "$relationshipId": "myRelationshipId",
  "$sourceId": "mySourceTwin",
  "$targetId": "myTargetTwin",
  "$relationshipName": "myRelationship",
  "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\""
}

Create a relationship (with properties)

Sample Request

PUT https://digitaltwins-hostname/digitaltwins/mySourceTwin/relationships/myRelationshipId?api-version=2023-10-31

{
  "$targetId": "myTargetTwin",
  "$relationshipName": "myRelationship",
  "relationshipProperty1": 1,
  "relationshipProperty2": "some value"
}

Sample Response

Status code:
200 
{
  "$relationshipId": "myRelationshipId",
  "$sourceId": "mySourceTwin",
  "$targetId": "myTargetTwin",
  "$relationshipName": "myRelationship",
  "relationshipProperty1": 1,
  "relationshipProperty2": "some value",
  "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\""
}

Определения

Имя Описание
Error

Определение ошибки.
ErrorResponse

Ответ об ошибке.
InnerError

Более конкретное описание ошибки, чем было предоставлено содержащей ошибкой.

Error

Определение ошибки.

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

string

Код ошибки службы, который служит подсостояние для кода ошибки HTTP.
details

Error[]

Сведения о внутренней ошибке.
innererror

InnerError

Объект, содержащий более конкретные сведения об ошибке, чем текущий объект.
message

string

Удобочитаемое представление ошибки.

ErrorResponse

Ответ об ошибке.

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

Error

Сведения об ошибке.

InnerError

Более конкретное описание ошибки, чем было предоставлено содержащей ошибкой.

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

string

Более конкретный код ошибки, чем был предоставлен содержащей ошибкой.
innererror

InnerError

Объект, содержащий более конкретные сведения об ошибке, чем текущий объект.