Device Data Models - Get

Service:

Azure Data Manager for Agriculture

API Version:

2023-11-01-preview

Gets a device data model entity.

GET {endpoint}/sensor-partners/{sensorPartnerId}/device-data-models/{deviceDataModelId}?api-version=2023-11-01-preview

URI Parameters

Name	In	Required	Type	Description
deviceDataModelId	path	True	string	Id of the device data model resource.
endpoint	path	True	string uri	The host name of the namespace, e.g. admaInstanceName.farmbeats.azure.net
sensorPartnerId	path	True	string	Id of the sensor partner.
api-version	query	True	string	The requested API version

Request Header

Name	Required	Type	Description
Authorization	True	string	Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before.

Responses

Name	Type	Description
200 OK	DeviceDataModel	Success
Other Status Codes	ErrorResponse	Error Headers x-ms-error-code: string

Security

Authorization

Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before.

Type: apiKey
In: header

Examples

DeviceDataModels_Get

Sample request

HTTP

GET {endpoint}/sensor-partners/sp1/device-data-models/ddm124?api-version=2023-11-01-preview

Sample response

Status code:

200

{
  "type": "Node",
  "manufacturer": "Manufacturer1",
  "productCode": "smt123",
  "ports": [
    {
      "name": "sm",
      "type": "Analog"
    }
  ],
  "sensorPartnerId": "sp1",
  "id": "ddm124",
  "status": "new",
  "createdDateTime": "2022-01-21T09:52:16Z",
  "modifiedDateTime": "2022-01-21T09:54:08Z",
  "eTag": "7f002a96-0000-0700-0000-61ea82c00000",
  "name": "sm-device-model",
  "description": "new device model for soil moisture measurement devices",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Definitions

Name	Description
DeviceDataModel	DeviceDataModel API model.
Error	An error from the Azure AgPlatform service.
ErrorResponse	An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.
InnerError	Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
Port	Schema for storing port values.

DeviceDataModel

DeviceDataModel API model.

Name	Type	Description
createdBy	string	Created by user/tenant id.
createdDateTime	string	Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.
description	string	Textual description of the resource.
eTag	string	The ETag value to implement optimistic concurrency.
id	string	Id of the resource.
manufacturer	string	Device manufacturer.
modifiedBy	string	Modified by user/tenant id.
modifiedDateTime	string	Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.
name	string	Name to identify resource.
ports	Port[]	List of device ports supported.
productCode	string	Device productCode.
properties		A collection of key value pairs that belongs to the resource. Each pair must not have a key greater than 50 characters and must not have a value greater than 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
sensorPartnerId	string	Id of the associated sensor partner.
status	string	Status of the resource.
type	string	Type of device.

Error

An error from the Azure AgPlatform service.

Name	Type	Description
code	string	Server-defined set of error codes.
details	Error[]	Array of details about specific errors that led to this reported error.
innererror	InnerError	Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
message	string	Human-readable representation of the error.
target	string	Target of the error.

ErrorResponse

An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.

Name	Type	Description
error	Error	An error from the Azure AgPlatform service.
traceId	string	Unique trace Id.

InnerError

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.

Name	Type	Description
code	string	Specific error code than was provided by the containing error.
innererror	InnerError	Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.

Port

Schema for storing port values.

Name	Type	Description
name	string	Name of the port.
type	string	Type of port digital/analog.