Twins - DigitalTwins UpdateRelationship

Service:

Azure Digital Twins

API Version:

2023-10-31

İki dijital ikiz arasındaki ilişkideki özellikleri Güncelleştirmeler. Durum kodları:

• 204 İçerik Yok
• 400 Hatalı İstek
  • InvalidArgument - Dijital ikiz kimliği veya ilişki kimliği geçersiz.
  • InvalidRelationship - İlişki geçersiz.
  • JsonPatchInvalid - Sağlanan JSON Düzeltme Eki geçersiz.
  • ValidationFailed - İlişki içeriği geçersiz.
• 404 Bulunamadı
  • DigitalTwinNotFound - Dijital ikiz bulunamadı.
  • RelationshipNotFound - İlişki bulunamadı.
• 409 Çakışma
  • RelationshipAlreadyExists - İlişki zaten var.
• 412 Önkoşul Başarısız Oldu
  • PreconditionFailed - Önkoşul denetimi (If-Match veya If-None-Match) başarısız oldu.

PATCH https://digitaltwins-hostname/digitaltwins/{id}/relationships/{relationshipId}?api-version=2023-10-31

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
id	path	True	string	Dijital ikizin kimliği. Kimlik, hizmet içinde benzersizdir ve büyük/küçük harfe duyarlıdır.
relationshipId	path	True	string	İlişkinin kimliği. Kimlik, dijital ikiz içinde benzersizdir ve büyük/küçük harfe duyarlıdır.
api-version	query	True	string	İstenen API sürümü.

İstek Başlığı

Media Types: "application/json-patch+json"

Name	Gerekli	Tür	Description
If-Match		string	İşlemi yalnızca varlığın etag'i sağlanan veya * sağlanan etag'lerden biriyle eşleşiyorsa gerçekleştirin.
traceparent		string	Dağıtılmış izleme sistemindeki isteği tanımlar.
tracestate		string	Satıcıya özgü izleme tanımlama bilgilerini sağlar ve izlemeparent için yardımcıdır.

İstek Gövdesi

Media Types: "application/json-patch+json"

Name	Tür	Description
patchDocument	object[]	İlişki özelliklerine yapılan güncelleştirmenin JSON Düzeltme Eki açıklaması.

Yanıtlar

Name	Tür	Description
204 No Content		Başarılı Headers ETag: string
Other Status Codes	ErrorResponse	Varsayılan yanıt. Headers x-ms-error-code: string

Güvenlik

oauth2

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

Örnekler

Update relationship properties

Update relationship properties (multiple updates)

Update relationship properties

Sample Request

HTTP

PATCH https://digitaltwins-hostname/digitaltwins/myTwinId/relationships/myRelationshipId?api-version=2023-10-31

[
  {
    "op": "add",
    "path": "/property",
    "value": 1
  }
]

Sample Response

Status code:

204

Update relationship properties (multiple updates)

Sample Request

HTTP

PATCH https://digitaltwins-hostname/digitaltwins/myTwinId/relationships/myRelationshipId?api-version=2023-10-31

[
  {
    "op": "add",
    "path": "/property1",
    "value": 1
  },
  {
    "op": "remove",
    "path": "/property2"
  },
  {
    "op": "replace",
    "path": "/property3/subProperty1",
    "value": "new value"
  }
]

Sample Response

Status code:

204

Tanımlar

Name	Description
Error	Hata tanımı.
ErrorResponse	Hata yanıtı.
InnerError	İçeren hata tarafından sağlanandan daha belirgin bir hata açıklaması.

Error

Hata tanımı.

Name	Tür	Description
code	string	HTTP hata kodu için alt durum olarak hizmet veren hizmete özgü hata kodu.
details	Error[]	İç hata ayrıntıları.
innererror	InnerError	Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne.
message	string	Hatanın insan tarafından okunabilen bir gösterimi.

ErrorResponse

Hata yanıtı.

Name	Tür	Description
error	Error	Hata ayrıntıları.

InnerError

İçeren hata tarafından sağlanandan daha belirgin bir hata açıklaması.

Name	Tür	Description
code	string	İçeren hata tarafından sağlanandan daha özel bir hata kodu.
innererror	InnerError	Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne.