Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
GetPropertyValueHistory
Mengambil informasi tentang riwayat nilai properti deret waktu untuk komponen, tipe komponen, entitas, atau ruang kerja.
Anda harus menentukan nilai untuk workspaceId. Untuk kueri spesifik entitas, tentukan nilai untuk componentName dan. entityId Untuk kueri lintas entitas, tentukan nilai untukcomponentTypeId.
Minta Sintaks
POST /workspaces/workspaceId/entity-properties/history HTTP/1.1
Content-type: application/json
{
"componentName": "string",
"componentPath": "string",
"componentTypeId": "string",
"endDateTime": number,
"endTime": "string",
"entityId": "string",
"interpolation": {
"interpolationType": "string",
"intervalInSeconds": number
},
"maxResults": number,
"nextToken": "string",
"orderByTime": "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"
}
}
],
"selectedProperties": [ "string" ],
"startDateTime": number,
"startTime": "string"
}Parameter Permintaan URI
Permintaan menggunakan parameter URI berikut.
- workspaceId
-
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
Permintaan menerima data berikut dalam format JSON.
- componentName
-
Nama komponen.
Tipe: 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.
Tipe: String
Batasan Panjang: Panjang minimum 1. Panjang maksimum 2048.
Pola:
[a-zA-Z_\-0-9/]+Wajib: Tidak
- componentTypeId
-
ID dari tipe komponen.
Tipe: String
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.
Pola:
[a-zA-Z_\.\-0-9:]+Wajib: Tidak
- endDateTime
-
Parameter ini sudah tidak digunakan lagi.
Tanggal dan waktu nilai properti terbaru untuk dikembalikan.
Tipe: Timestamp
Wajib: Tidak
- endTime
-
ISO8601 DateTime dari nilai properti terbaru untuk dikembalikan.
Untuk informasi selengkapnya tentang DateTime format ISO8601, lihat tipe data. PropertyValue
Tipe: String
Batasan Panjang: Panjang minimum 20. Panjang maksimum 35.
Wajib: Tidak
- entityId
-
ID entitas.
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
- interpolation
-
Objek yang menentukan jenis interpolasi dan interval untuk menginterpolasi data.
Tipe: Objek InterpolationParameters
Wajib: Tidak
- maxResults
-
Jumlah maksimum hasil untuk dikembalikan 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
-
String yang menentukan halaman hasil berikutnya.
Tipe: String
Batasan Panjang: Panjang minimum 0. Panjang maksimum 17880.
Pola:
.*Wajib: Tidak
- orderByTime
-
Arah waktu yang digunakan dalam urutan hasil.
Tipe: String
Nilai yang Valid:
ASCENDING | DESCENDINGWajib: Tidak
- propertyFilters
-
Daftar objek yang memfilter permintaan riwayat nilai properti.
Tipe: Array objek PropertyFilter
Anggota Array: Jumlah minimum 1 item. Jumlah maksimum 10 item.
Wajib: Tidak
- selectedProperties
-
Daftar properti yang histori nilainya diambil permintaan.
Tipe: Array string
Anggota Array: Jumlah minimum 1 item. Jumlah maksimum 10 item.
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.
Pola:
.*Wajib: Ya
- startDateTime
-
Parameter ini sudah tidak digunakan lagi.
Tanggal dan waktu nilai properti paling awal untuk dikembalikan.
Tipe: Timestamp
Wajib: Tidak
- startTime
-
ISO8601 DateTime dari nilai properti paling awal untuk dikembalikan.
Untuk informasi selengkapnya tentang DateTime format ISO8601, lihat tipe data. PropertyValue
Tipe: String
Batasan Panjang: Panjang minimum 20. Panjang maksimum 35.
Wajib: Tidak
Sintaksis Respons
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"propertyValues": [
{
"entityPropertyReference": {
"componentName": "string",
"componentPath": "string",
"entityId": "string",
"externalIdProperty": {
"string" : "string"
},
"propertyName": "string"
},
"values": [
{
"time": "string",
"timestamp": number,
"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
Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.
Layanan mengembalikan data berikut dalam format JSON.
- nextToken
-
String yang menentukan halaman hasil berikutnya.
Tipe: String
Batasan Panjang: Panjang minimum 0. Panjang maksimum 17880.
Pola:
.* - propertyValues
-
Sebuah objek yang memetakan string ke definisi properti dalam tipe komponen. Setiap string dalam pemetaan harus unik untuk objek ini.
Tipe: Array objek PropertyValueHistory
Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Jenis 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
-
Kesalahan tak terduga telah terjadi.
Kode Status HTTP: 500
- ResourceNotFoundException
-
Sumber daya tidak ditemukan.
Kode Status HTTP: 404
- ThrottlingException
-
Tarifnya melebihi batas.
Kode Status HTTP: 429
- ValidationException
-
Gagal
Kode Status HTTP: 400
Lihat Juga
Untuk informasi selengkapnya tentang menggunakan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini:
