UpdateEntity - AWS IoT TwinMaker
Minta SintaksParameter Permintaan URIIsi PermintaanSintaksis ResponsElemen ResponsKesalahanLihat Juga

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

UpdateEntity

Memperbarui entitas.

Minta Sintaks

PUT /workspaces/workspaceId/entities/entityId HTTP/1.1
Content-type: application/json

{
   "componentUpdates": { 
      "string" : { 
         "componentTypeId": "string",
         "description": "string",
         "propertyGroupUpdates": { 
            "string" : { 
               "groupType": "string",
               "propertyNames": [ "string" ],
               "updateType": "string"
            }
         },
         "propertyUpdates": { 
            "string" : { 
               "definition": { 
                  "configuration": { 
                     "string" : "string" 
                  },
                  "dataType": { 
                     "allowedValues": [ 
                        { 
                           "booleanValue": boolean,
                           "doubleValue": number,
                           "expression": "string",
                           "integerValue": number,
                           "listValue": [ 
                              "DataValue"
                           ],
                           "longValue": number,
                           "mapValue": { 
                              "string" : "DataValue"
                           },
                           "relationshipValue": { 
                              "targetComponentName": "string",
                              "targetEntityId": "string"
                           },
                           "stringValue": "string"
                        }
                     ],
                     "nestedType": "DataType",
                     "relationship": { 
                        "relationshipType": "string",
                        "targetComponentTypeId": "string"
                     },
                     "type": "string",
                     "unitOfMeasure": "string"
                  },
                  "defaultValue": { 
                     "booleanValue": boolean,
                     "doubleValue": number,
                     "expression": "string",
                     "integerValue": number,
                     "listValue": [ 
                        "DataValue"
                     ],
                     "longValue": number,
                     "mapValue": { 
                        "string" : "DataValue"
                     },
                     "relationshipValue": { 
                        "targetComponentName": "string",
                        "targetEntityId": "string"
                     },
                     "stringValue": "string"
                  },
                  "displayName": "string",
                  "isExternalId": boolean,
                  "isRequiredInEntity": boolean,
                  "isStoredExternally": boolean,
                  "isTimeSeries": boolean
               },
               "updateType": "string",
               "value": { 
                  "booleanValue": boolean,
                  "doubleValue": number,
                  "expression": "string",
                  "integerValue": number,
                  "listValue": [ 
                     "DataValue"
                  ],
                  "longValue": number,
                  "mapValue": { 
                     "string" : "DataValue"
                  },
                  "relationshipValue": { 
                     "targetComponentName": "string",
                     "targetEntityId": "string"
                  },
                  "stringValue": "string"
               }
            }
         },
         "updateType": "string"
      }
   },
   "compositeComponentUpdates": { 
      "string" : { 
         "description": "string",
         "propertyGroupUpdates": { 
            "string" : { 
               "groupType": "string",
               "propertyNames": [ "string" ],
               "updateType": "string"
            }
         },
         "propertyUpdates": { 
            "string" : { 
               "definition": { 
                  "configuration": { 
                     "string" : "string" 
                  },
                  "dataType": { 
                     "allowedValues": [ 
                        { 
                           "booleanValue": boolean,
                           "doubleValue": number,
                           "expression": "string",
                           "integerValue": number,
                           "listValue": [ 
                              "DataValue"
                           ],
                           "longValue": number,
                           "mapValue": { 
                              "string" : "DataValue"
                           },
                           "relationshipValue": { 
                              "targetComponentName": "string",
                              "targetEntityId": "string"
                           },
                           "stringValue": "string"
                        }
                     ],
                     "nestedType": "DataType",
                     "relationship": { 
                        "relationshipType": "string",
                        "targetComponentTypeId": "string"
                     },
                     "type": "string",
                     "unitOfMeasure": "string"
                  },
                  "defaultValue": { 
                     "booleanValue": boolean,
                     "doubleValue": number,
                     "expression": "string",
                     "integerValue": number,
                     "listValue": [ 
                        "DataValue"
                     ],
                     "longValue": number,
                     "mapValue": { 
                        "string" : "DataValue"
                     },
                     "relationshipValue": { 
                        "targetComponentName": "string",
                        "targetEntityId": "string"
                     },
                     "stringValue": "string"
                  },
                  "displayName": "string",
                  "isExternalId": boolean,
                  "isRequiredInEntity": boolean,
                  "isStoredExternally": boolean,
                  "isTimeSeries": boolean
               },
               "updateType": "string",
               "value": { 
                  "booleanValue": boolean,
                  "doubleValue": number,
                  "expression": "string",
                  "integerValue": number,
                  "listValue": [ 
                     "DataValue"
                  ],
                  "longValue": number,
                  "mapValue": { 
                     "string" : "DataValue"
                  },
                  "relationshipValue": { 
                     "targetComponentName": "string",
                     "targetEntityId": "string"
                  },
                  "stringValue": "string"
               }
            }
         },
         "updateType": "string"
      }
   },
   "description": "string",
   "entityName": "string",
   "parentEntityUpdate": { 
      "parentEntityId": "string",
      "updateType": "string"
   }
}

Parameter Permintaan URI

Permintaan menggunakan parameter URI berikut.

entityId

ID entitas.

Batasan Panjang: Panjang minimum 1. Panjang maksimum 128.

Pola: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+

Wajib: Ya

workspaceId

ID ruang kerja yang berisi entitas.

Batasan Panjang: Panjang minimum 1. Panjang maksimum 128.

Pola: [a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+

Wajib: Ya

Isi Permintaan

Permintaan menerima data berikut dalam format JSON.

componentUpdates

Objek yang memetakan string ke pembaruan komponen dalam permintaan. Setiap string dalam pemetaan harus unik untuk objek ini.

Jenis: String ke peta ComponentUpdateRequest objek

Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 256.

Pola Kunci: [a-zA-Z_\-0-9]+

Wajib: Tidak

compositeComponentUpdates

Ini adalah objek yang memetakan string ke compositeComponent pembaruan dalam permintaan. Setiap kunci peta mewakili componentPath daricompositeComponent.

Jenis: String ke peta CompositeComponentUpdateRequest objek

Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 2048.

Pola Kunci: [a-zA-Z_\-0-9/]+

Wajib: Tidak

description

Deskripsi entitas.

Jenis: String

Batasan Panjang: Panjang minimum sebesar 0. Panjang maksimum 2048.

Pola: .*

Wajib: Tidak

entityName

Nama entitas.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.

Pola: [^\u0000-\u001F\u007F]+

Wajib: Tidak

parentEntityUpdate

Objek yang menjelaskan permintaan pembaruan untuk entitas induk.

Tipe: Objek ParentEntityUpdateRequest

Wajib: Tidak

Sintaksis Respons

HTTP/1.1 200
Content-type: application/json

{
   "state": "string",
   "updateDateTime": number
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

state

Status pembaruan entitas saat ini.

Jenis: String

Nilai yang Valid: CREATING | UPDATING | DELETING | ACTIVE | ERROR

updateDateTime

Tanggal dan waktu ketika entitas terakhir diperbarui.

Tipe: Timestamp

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

AccessDeniedException

Akses ditolak.

Kode Status HTTP: 403

ConflictException

Terjadi konflik.

Kode Status HTTP: 409

InternalServerException

Terjadi kesalahan tak terduga.

Kode Status HTTP: 500

ResourceNotFoundException

Sumber daya tidak ditemukan.

Kode Status HTTP: 404

ServiceQuotaExceededException

Kuota layanan terlampaui.

Kode Status HTTP: 402

ThrottlingException

Tarif melebihi batas.

Kode Status HTTP: 429

ValidationException

Failed

Kode Status HTTP: 400

Lihat Juga

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini: