Udostępnij za pośrednictwem

Twins - DigitalTwins AddRelationship

  • Odwołanie
Service:
Azure Digital Twins
API Version:
2023-10-31

Dodaje relację między dwoma cyfrowymi reprezentacjami bliźniaczymi. Kody stanu:

  • 200 OK
  • 400 Nieprawidłowe żądanie
    • InvalidArgument — identyfikator cyfrowej reprezentacji bliźniaczej, identyfikator relacji lub ładunek jest nieprawidłowy.
    • InvalidRelationship — relacja jest nieprawidłowa.
    • OperationNotAllowed — relacja nie może nawiązać połączenia z tą samą cyfrową reprezentacją bliźniaczą.
    • ValidationFailed — zawartość relacji jest nieprawidłowa.
  • 404 — Nie znaleziono
    • DigitalTwinNotFound — nie można odnaleźć cyfrowej reprezentacji bliźniaczej.
    • TargetTwinNotFound — nie można odnaleźć celu cyfrowej reprezentacji bliźniaczej relacji.
  • 412 Warunek wstępny nie powiódł się
    • Warunek wstępny — sprawdzanie warunków wstępnych (Jeśli dopasowanie lub Jeśli-Brak-Dopasowanie) nie powiodło się.
PUT https://digitaltwins-hostname/digitaltwins/{id}/relationships/{relationshipId}?api-version=2023-10-31

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
id
 path True

string

Identyfikator cyfrowej reprezentacji bliźniaczej. Identyfikator jest unikatowy w usłudze i uwzględnia wielkość liter.
relationshipId
 path True

string

Identyfikator relacji. Identyfikator jest unikatowy w cyfrowej reprezentacji bliźniaczej i uwzględnia wielkość liter.
api-version
 query True

string

Żądana wersja interfejsu API.

Nagłówek żądania

Nazwa Wymagane Typ Opis
If-None-Match

string

Wykonaj operację tylko wtedy, gdy jednostka jeszcze nie istnieje.
traceparent

string

Identyfikuje żądanie w rozproszonym systemie śledzenia.
tracestate

string

Dostarcza informacje identyfikacyjne śledzenia specyficzne dla dostawcy i jest towarzyszem śledzenia rodziców.

Treść żądania

Nazwa Typ Opis
relationship

object

Dane dla relacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

Relationship

Powodzenie

Headers

ETag: string
Other Status Codes

ErrorResponse

Odpowiedź domyślna.

Headers

x-ms-error-code: string

Zabezpieczenia

oauth2

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

Przykłady

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\""
}

Definicje

Nazwa Opis
Error

Definicja błędu.
ErrorResponse

Odpowiedź na błąd.
InnerError

Bardziej szczegółowy opis błędu niż został podany przez błąd zawierający.

Error

Definicja błędu.

Nazwa Typ Opis
code

string

Kod błędu specyficzny dla usługi, który służy jako stan podrzędny kodu błędu HTTP.
details

Error[]

Szczegóły błędu wewnętrznego.
innererror

InnerError

Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message

string

Czytelna dla człowieka reprezentacja błędu.

ErrorResponse

Odpowiedź na błąd.

Nazwa Typ Opis
error

Error

Szczegóły błędu.

InnerError

Bardziej szczegółowy opis błędu niż został podany przez błąd zawierający.

Nazwa Typ Opis
code

string

Bardziej szczegółowy kod błędu niż został dostarczony przez błąd zawierający.
innererror

InnerError

Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.