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

# GetPropertyValue
<a name="API_GetPropertyValue"></a>

Mendapat nilai properti untuk komponen, tipe komponen, entitas, atau ruang kerja.

Anda harus menentukan nilai untuk salah satu`componentName`,`componentTypeId`,`entityId`, atau`workspaceId`.

## Minta Sintaks
<a name="API_GetPropertyValue_RequestSyntax"></a>

```
POST /workspaces/workspaceId/entity-properties/value HTTP/1.1
Content-type: application/json

{
   "componentName": "string",
   "componentPath": "string",
   "componentTypeId": "string",
   "entityId": "string",
   "maxResults": number,
   "nextToken": "string",
   "propertyGroupName": "string",
   "selectedProperties": [ "string" ],
   "tabularConditions": { 
      "orderBy": [ 
         { 
            "order": "string",
            "propertyName": "string"
         }
      ],
      "propertyFilters": [ 
         { 
            "operator": "string",
            "propertyName": "string",
            "value": { 
               "booleanValue": boolean,
               "doubleValue": number,
               "expression": "string",
               "integerValue": number,
               "listValue": [ 
                  "DataValue"
               ],
               "longValue": number,
               "mapValue": { 
                  "string" : "DataValue"
               },
               "relationshipValue": { 
                  "targetComponentName": "string",
                  "targetEntityId": "string"
               },
               "stringValue": "string"
            }
         }
      ]
   }
}
```

## Parameter Permintaan URI
<a name="API_GetPropertyValue_RequestParameters"></a>

Permintaan menggunakan parameter URI berikut.

 ** [workspaceId](#API_GetPropertyValue_RequestSyntax) **   <a name="tm-GetPropertyValue-request-uri-workspaceId"></a>
ID ruang kerja yang nilainya dikembalikan operasi.  
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
<a name="API_GetPropertyValue_RequestBody"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [componentName](#API_GetPropertyValue_RequestSyntax) **   <a name="tm-GetPropertyValue-request-componentName"></a>
Nama komponen yang nilai propertinya dikembalikan oleh operasi.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.  
Pola: `[a-zA-Z_\-0-9]+`   
Wajib: Tidak

 ** [componentPath](#API_GetPropertyValue_RequestSyntax) **   <a name="tm-GetPropertyValue-request-componentPath"></a>
String ini menentukan jalur ke komponen komposit, mulai dari komponen tingkat atas.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 2048.  
Pola: `[a-zA-Z_\-0-9/]+`   
Wajib: Tidak

 ** [componentTypeId](#API_GetPropertyValue_RequestSyntax) **   <a name="tm-GetPropertyValue-request-componentTypeId"></a>
ID dari jenis komponen yang nilai propertinya dikembalikan oleh operasi.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.  
Pola: `[a-zA-Z_\.\-0-9:]+`   
Wajib: Tidak

 ** [entityId](#API_GetPropertyValue_RequestSyntax) **   <a name="tm-GetPropertyValue-request-entityId"></a>
ID entitas yang nilai propertinya dikembalikan oleh operasi.  
Tipe: String  
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: Tidak

 ** [maxResults](#API_GetPropertyValue_RequestSyntax) **   <a name="tm-GetPropertyValue-request-maxResults"></a>
Jumlah maksimum hasil untuk kembali pada satu waktu. Default-nya adalah 25.  
Rentang yang Valid: Nilai minimum 1. Nilai maksimum 250.  
Jenis: Integer  
Rentang yang Valid: Nilai minimum 0. Nilai maksimum 200.  
Wajib: Tidak

 ** [nextToken](#API_GetPropertyValue_RequestSyntax) **   <a name="tm-GetPropertyValue-request-nextToken"></a>
String yang menentukan halaman berikutnya dari hasil.  
Tipe: String  
Batasan Panjang: Panjang minimum 0. Panjang maksimum 17880.  
Pola: `.*`   
Wajib: Tidak

 ** [propertyGroupName](#API_GetPropertyValue_RequestSyntax) **   <a name="tm-GetPropertyValue-request-propertyGroupName"></a>
Nama grup properti.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.  
Pola: `[a-zA-Z_\-0-9]+`   
Wajib: Tidak

 ** [selectedProperties](#API_GetPropertyValue_RequestSyntax) **   <a name="tm-GetPropertyValue-request-selectedProperties"></a>
Properti yang nilainya dikembalikan oleh operasi.  
Tipe: Array string  
Anggota Array: Jumlah minimum 1 item. Jumlah maksimum 10 item.  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.  
Pola: `.*`   
Wajib: Ya

 ** [tabularConditions](#API_GetPropertyValue_RequestSyntax) **   <a name="tm-GetPropertyValue-request-tabularConditions"></a>
Kondisi tabular.  
Tipe: Objek [TabularConditions](API_TabularConditions.md)  
Wajib: Tidak

## Sintaksis Respons
<a name="API_GetPropertyValue_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "propertyValues": { 
      "string" : { 
         "propertyReference": { 
            "componentName": "string",
            "componentPath": "string",
            "entityId": "string",
            "externalIdProperty": { 
               "string" : "string" 
            },
            "propertyName": "string"
         },
         "propertyValue": { 
            "booleanValue": boolean,
            "doubleValue": number,
            "expression": "string",
            "integerValue": number,
            "listValue": [ 
               "DataValue"
            ],
            "longValue": number,
            "mapValue": { 
               "string" : "DataValue"
            },
            "relationshipValue": { 
               "targetComponentName": "string",
               "targetEntityId": "string"
            },
            "stringValue": "string"
         }
      }
   },
   "tabularPropertyValues": [ 
      [ 
         { 
            "string" : { 
               "booleanValue": boolean,
               "doubleValue": number,
               "expression": "string",
               "integerValue": number,
               "listValue": [ 
                  "DataValue"
               ],
               "longValue": number,
               "mapValue": { 
                  "string" : "DataValue"
               },
               "relationshipValue": { 
                  "targetComponentName": "string",
                  "targetEntityId": "string"
               },
               "stringValue": "string"
            }
         }
      ]
   ]
}
```

## Elemen Respons
<a name="API_GetPropertyValue_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [nextToken](#API_GetPropertyValue_ResponseSyntax) **   <a name="tm-GetPropertyValue-response-nextToken"></a>
String yang menentukan halaman berikutnya dari hasil.  
Tipe: String  
Batasan Panjang: Panjang minimum 0. Panjang maksimum 17880.  
Pola: `.*` 

 ** [propertyValues](#API_GetPropertyValue_ResponseSyntax) **   <a name="tm-GetPropertyValue-response-propertyValues"></a>
Objek yang memetakan string ke properti dan nilai properti terbaru dalam respons. Setiap string dalam pemetaan harus unik untuk objek ini.  
Jenis: String ke peta [PropertyLatestValue](API_PropertyLatestValue.md) objek  
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 256.  
Pola Kunci: `[a-zA-Z_\-0-9]+` 

 ** [tabularPropertyValues](#API_GetPropertyValue_ResponseSyntax) **   <a name="tm-GetPropertyValue-response-tabularPropertyValues"></a>
Tabel nilai properti.  
Jenis: Array array string ke peta [DataValue](API_DataValue.md) objek  
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 256.  
Pola Kunci: `[a-zA-Z_\-0-9]+` 

## Kesalahan
<a name="API_GetPropertyValue_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Jenis Kesalahan Umum](CommonErrors.md).

 ** AccessDeniedException **   
Akses ditolak.  
Kode Status HTTP: 403

 ** ConnectorFailureException **   
Konektor gagal.  
Kode Status HTTP: 424

 ** ConnectorTimeoutException **   
Konektor habis waktunya.  
Kode Status HTTP: 424

 ** InternalServerException **   
Terjadi kesalahan tak terduga.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya tidak ditemukan.  
Kode Status HTTP: 404

 ** ThrottlingException **   
Tarif melebihi batas.  
Kode Status HTTP: 429

 ** ValidationException **   
Gagal  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_GetPropertyValue_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/iottwinmaker-2021-11-29/GetPropertyValue) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iottwinmaker-2021-11-29/GetPropertyValue) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iottwinmaker-2021-11-29/GetPropertyValue) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iottwinmaker-2021-11-29/GetPropertyValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iottwinmaker-2021-11-29/GetPropertyValue) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iottwinmaker-2021-11-29/GetPropertyValue) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iottwinmaker-2021-11-29/GetPropertyValue) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iottwinmaker-2021-11-29/GetPropertyValue) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/iottwinmaker-2021-11-29/GetPropertyValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iottwinmaker-2021-11-29/GetPropertyValue)