Compartir a través de

Twins - DigitalTwins SendComponentTelemetry

  • Reference
Service:
Reference
API Version:
2023-10-31

Sends telemetry on behalf of a component in a digital twin. Status codes:

  • 204 No Content
  • 400 Bad Request
    • InvalidArgument - The digital twin id, message id, or component path is invalid.
    • ValidationFailed - The telemetry content is invalid.
  • 404 Not Found
    • DigitalTwinNotFound - The digital twin was not found.
    • ComponentNotFound - The component path was not found.
POST https://digitaltwins-hostname/digitaltwins/{id}/components/{componentPath}/telemetry?api-version=2023-10-31

URI Parameters

Name In Required Type Description
componentPath
 path True

string

The name of the DTDL component.
id
 path True

string

The id of the digital twin. The id is unique within the service and case sensitive.
api-version
 query True

string

The requested API version.

Request Header

Name Required Type Description
Message-Id True

string

A unique message identifier (in the scope of the digital twin id) that is commonly used for de-duplicating messages.
Telemetry-Source-Time

string

An RFC 3339 timestamp that identifies the time the telemetry was measured.
traceparent

string

Identifies the request in a distributed tracing system.
tracestate

string

Provides vendor-specific trace identification information and is a companion to traceparent.

Request Body

Name Type Description
telemetry

object

The telemetry measurements to send from the digital twin's component.

Responses

Name Type Description
204 No Content

Success
Other Status Codes

ErrorResponse

Default response.

Headers

x-ms-error-code: string

Security

oauth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0

Examples

Send telemetry in a component

Sample request

POST https://digitaltwins-hostname/digitaltwins/myTwinId/components/myComponent/telemetry?api-version=2023-10-31



{
  "temperature": 1
}

Sample response

Status code:
204

Definitions

Name Description
Error

Error definition.
ErrorResponse

Error response.
InnerError

A more specific error description than was provided by the containing error.

Error

Error definition.

Name Type Description
code

string

Service specific error code which serves as the substatus for the HTTP error code.
details

Error[]

Internal error details.
innererror

InnerError

An object containing more specific information than the current object about the error.
message

string

A human-readable representation of the error.

ErrorResponse

Error response.

Name Type Description
error

Error

The error details.

InnerError

A more specific error description than was provided by the containing error.

Name Type Description
code

string

A more specific error code than was provided by the containing error.
innererror

InnerError

An object containing more specific information than the current object about the error.