Devices - Create Or Update

Referensi

Layanan:: Azure Data Manager for Agriculture

Versi API:: 2023-11-01-preview

Membuat entitas perangkat.

PATCH {endpoint}/sensor-partners/{sensorPartnerId}/devices/{deviceId}?api-version=2023-11-01-preview

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
deviceId	path	True	string	Id sumber daya perangkat.
endpoint	path	True	string uri	Nama host namespace layanan, misalnya admaInstanceName.farmbeats.azure.net
sensorPartnerId	path	True	string	Id mitra sensor.
api-version	query	True	string	Versi API yang diminta

Header Permintaan

Media Types: "application/merge-patch+json"

Nama	Diperlukan	Jenis	Deskripsi
Authorization	True	string	Harap berikan token pembawa yang valid untuk panggilan API resmi. Perhatikan bahwa Anda mungkin perlu menghapus cache browser jika Anda mencoba panggilan yang tidak diautentikasi sebelumnya.

Isi Permintaan

Media Types: "application/merge-patch+json"

Nama	Jenis	Deskripsi
description	string	Deskripsi tekstual dari sumber daya.
deviceDataModelId	string	Id model data perangkat terkait.
hardwareId	string	HardwareId perangkat.
integrationId	string	Id integrasi untuk perangkat.
location	Location	Kelas model lokasi.
name	string	Nama untuk mengidentifikasi sumber daya.
parentDeviceId	string	Id perangkat induk untuk perangkat ini.
properties		Kumpulan pasangan nilai kunci milik sumber daya. Setiap pasangan tidak boleh memiliki kunci yang lebih besar dari 50 karakter dan tidak boleh memiliki nilai yang lebih besar dari 150 karakter. Catatan: Maksimum 25 pasangan nilai kunci dapat disediakan untuk sumber daya dan hanya nilai string, angka, dan tanggalwaktu (yyyy-MM-ddTHH:mm:ssZ) yang didukung.
reportingIntervalInSeconds	integer	Interval di mana perangkat mengirim data dalam hitungan detik.
status	string	Status sumber daya.
type	string	Jenis perangkat.

Respons

Nama	Jenis	Deskripsi
200 OK	Device	Berhasil
201 Created	Device	Dibuat
Other Status Codes	ErrorResponse	Kesalahan Header x-ms-error-code: string

Nama

Jenis

Deskripsi

200 OK

Device

Berhasil

201 Created

Device

Dibuat

Other Status Codes

ErrorResponse

Kesalahan

Header

x-ms-error-code: string

Keamanan

Authorization

Harap berikan token pembawa yang valid untuk panggilan API resmi. Perhatikan bahwa Anda mungkin perlu menghapus cache browser jika Anda mencoba panggilan yang tidak diautentikasi sebelumnya.

Jenis: apiKey
Dalam: header

Contoh

Devices_CreateOrUpdate

Permintaan sampel

HTTP

PATCH {endpoint}/sensor-partners/sp1/devices/d124?api-version=2023-11-01-preview

{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "status": "new device",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Respon sampel

Kode status:: 200

{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "sensorPartnerId": "sp1",
  "id": "d123",
  "status": "new device",
  "createdDateTime": "2022-01-24T06:20:47Z",
  "modifiedDateTime": "2022-01-24T06:21:07Z",
  "eTag": "0401a5cc-0000-0700-0000-61ee45540000",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Kode status:: 201

{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "sensorPartnerId": "sp1",
  "id": "d123",
  "status": "new device",
  "createdDateTime": "2022-01-24T06:20:47Z",
  "modifiedDateTime": "2022-01-24T06:20:47Z",
  "eTag": "0401baca-0000-0700-0000-61ee453f0000",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Definisi

Nama	Deskripsi
Device	Model API Perangkat.
Error	Kesalahan dari layanan Azure AgPlatform.
ErrorResponse	Respons kesalahan dari layanan Azure AgPlatform. Lihat https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses untuk dokumen referensi ErrorResponse.
InnerError	Kesalahan dalam yang berisi daftar kesalahan. Lihat https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object untuk dokumen referensi InnerError.
Location	Kelas model lokasi.

Device

Model API Perangkat.

Nama	Jenis	Deskripsi
createdBy	string	Dibuat oleh id pengguna/penyewa.
createdDateTime	string	Tanggal-waktu ketika sumber daya dibuat, format sampel: yyyy-MM-ddTHH:mm:ssZ.
description	string	Deskripsi tekstual dari sumber daya.
deviceDataModelId	string	Id model data perangkat terkait.
eTag	string	Nilai ETag untuk menerapkan konkurensi optimis.
hardwareId	string	HardwareId perangkat.
id	string	Id sumber daya.
integrationId	string	Id integrasi untuk perangkat.
location	Location	Kelas model lokasi.
modifiedBy	string	Dimodifikasi oleh id pengguna/penyewa.
modifiedDateTime	string	Tanggal-waktu ketika sumber daya terakhir dimodifikasi, format sampel: yyyy-MM-ddTHH:mm:ssZ.
name	string	Nama untuk mengidentifikasi sumber daya.
parentDeviceId	string	Id perangkat induk untuk perangkat ini.
properties		Kumpulan pasangan nilai kunci milik sumber daya. Setiap pasangan tidak boleh memiliki kunci yang lebih besar dari 50 karakter dan tidak boleh memiliki nilai yang lebih besar dari 150 karakter. Catatan: Maksimum 25 pasangan nilai kunci dapat disediakan untuk sumber daya dan hanya nilai string, angka, dan tanggalwaktu (yyyy-MM-ddTHH:mm:ssZ) yang didukung.
reportingIntervalInSeconds	integer	Interval di mana perangkat mengirim data dalam hitungan detik.
sensorPartnerId	string	Id mitra sensor terkait.
status	string	Status sumber daya.
type	string	Jenis perangkat.

Error

Kesalahan dari layanan Azure AgPlatform.

Nama	Jenis	Deskripsi
code	string	Sekumpulan kode kesalahan yang ditentukan server.
details	Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	InnerError	Kesalahan dalam yang berisi daftar kesalahan. Lihat https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object untuk dokumen referensi InnerError.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan dari layanan Azure AgPlatform. Lihat https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses untuk dokumen referensi ErrorResponse.

Nama	Jenis	Deskripsi
error	Error	Kesalahan dari layanan Azure AgPlatform.
traceId	string	Id pelacakan unik.

InnerError

Kesalahan dalam yang berisi daftar kesalahan. Lihat https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object untuk dokumen referensi InnerError.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan tertentu daripada yang disediakan oleh kesalahan yang berisi.
innererror	InnerError	Kesalahan dalam yang berisi daftar kesalahan. Lihat https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object untuk dokumen referensi InnerError.

Location

Kelas model lokasi.

Nama	Jenis	Deskripsi
latitude	number	Garis lintang lokasi.
longitude	number	Garis bujur lokasi.

Bagikan melalui

Devices - Create Or Update

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Keamanan

Authorization

Contoh

Devices_CreateOrUpdate

Permintaan sampel

Respon sampel

Definisi

Device

Error

ErrorResponse

InnerError

Location

Sumber Daya Tambahan: