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

# ListProperties
<a name="API_ListProperties"></a>

API ini mencantumkan properti komponen.

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

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

{
   "componentName": "string",
   "componentPath": "string",
   "entityId": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

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

Permintaan menggunakan parameter URI berikut.

 ** [workspaceId](#API_ListProperties_RequestSyntax) **   <a name="tm-ListProperties-request-uri-workspaceId"></a>
ID ruang kerja.  
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_ListProperties_RequestBody"></a>

Permintaan menerima data berikut dalam format JSON.

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

 ** [componentPath](#API_ListProperties_RequestSyntax) **   <a name="tm-ListProperties-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

 ** [entityId](#API_ListProperties_RequestSyntax) **   <a name="tm-ListProperties-request-entityId"></a>
ID untuk entitas yang metadatanya (komponen/properti) 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: Ya

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

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

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

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

{
   "nextToken": "string",
   "propertySummaries": [ 
      { 
         "areAllPropertyValuesReturned": boolean,
         "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,
            "isFinal": boolean,
            "isImported": boolean,
            "isInherited": boolean,
            "isRequiredInEntity": boolean,
            "isStoredExternally": boolean,
            "isTimeSeries": boolean
         },
         "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"
         }
      }
   ]
}
```

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

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

 ** [propertySummaries](#API_ListProperties_ResponseSyntax) **   <a name="tm-ListProperties-response-propertySummaries"></a>
Daftar objek yang berisi informasi tentang properti.  
Tipe: Array objek [PropertySummary](API_PropertySummary.md)

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

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

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

 ** 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_ListProperties_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/ListProperties) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iottwinmaker-2021-11-29/ListProperties) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iottwinmaker-2021-11-29/ListProperties) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iottwinmaker-2021-11-29/ListProperties) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iottwinmaker-2021-11-29/ListProperties) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iottwinmaker-2021-11-29/ListProperties) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iottwinmaker-2021-11-29/ListProperties) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iottwinmaker-2021-11-29/ListProperties) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/iottwinmaker-2021-11-29/ListProperties) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iottwinmaker-2021-11-29/ListProperties)