Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
GetPropertyValue
Mendapat nilai properti untuk komponen, tipe komponen, entitas, atau ruang kerja.
Anda harus menentukan nilai untuk salah satucomponentName,componentTypeId,entityId, atauworkspaceId.
Minta Sintaks
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
Permintaan menggunakan parameter URI berikut.
- workspaceId
-
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
Permintaan menerima data berikut dalam format JSON.
- componentName
-
Nama komponen yang nilai propertinya dikembalikan oleh operasi.
Jenis: String
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.
Pola:
[a-zA-Z_\-0-9]+Wajib: Tidak
- componentPath
-
String ini menentukan jalur ke komponen komposit, mulai dari komponen tingkat atas.
Jenis: String
Batasan Panjang: Panjang minimum 1. Panjang maksimum 2048.
Pola:
[a-zA-Z_\-0-9/]+Wajib: Tidak
- componentTypeId
-
ID dari jenis komponen yang nilai propertinya dikembalikan oleh operasi.
Jenis: String
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.
Pola:
[a-zA-Z_\.\-0-9:]+Wajib: Tidak
- entityId
-
ID entitas yang nilai propertinya dikembalikan oleh operasi.
Jenis: 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
-
Jumlah maksimum hasil untuk kembali pada satu waktu. Default-nya adalah 25.
Rentang yang Valid: Nilai minimum 1. Nilai maksimum 250.
Tipe: Bilangan Bulat
Rentang yang Valid: Nilai minimum 0. Nilai maksimum 200.
Wajib: Tidak
- nextToken
-
String yang menentukan halaman berikutnya dari hasil.
Jenis: String
Batasan Panjang: Panjang minimum 0. Panjang maksimum 17880.
Pola:
.*Wajib: Tidak
- propertyGroupName
-
Nama grup properti.
Jenis: String
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.
Pola:
[a-zA-Z_\-0-9]+Wajib: Tidak
- selectedProperties
-
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
-
Kondisi tabular.
Tipe: Objek TabularConditions
Wajib: Tidak
Sintaksis Respons
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
Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.
Layanan mengembalikan data berikut dalam format JSON.
- nextToken
-
String yang menentukan halaman berikutnya dari hasil.
Jenis: String
Batasan Panjang: Panjang minimum 0. Panjang maksimum 17880.
Pola:
.* - propertyValues
-
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 objek
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 256.
Pola Kunci:
[a-zA-Z_\-0-9]+ - tabularPropertyValues
-
Tabel nilai properti.
Jenis: Array array string ke peta DataValue objek
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 256.
Pola Kunci:
[a-zA-Z_\-0-9]+
Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.
- 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
-
Failed
Kode Status HTTP: 400
Lihat Juga
Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini:
