LwM2M API REGISTRY
The LwM2M Registry API, developed and maintained by the Open Mobile Alliance Naming Authority (OMNA), is a powerful tool designed to provide structured access to metadata information for LwM2M objects.
This API allows developers, IoT solution providers, and enterprises to efficiently retrieve metadata for all object versions, specific objects, or the latest versions using structured URLs.
FEATURES & BENEFITS
✅ Object Discovery & Retrieval – Search and retrieve metadata for all registered objects, including descriptions, versions, and ownership.
✅ Seamless IoT Integration – Enables automated access to object metadata, improving device lifecycle management.
✅ Comprehensive Metadata – Access details like object descriptions, XML definitions, technical specifications, and unique URNs.
✅ Developer-Friendly Interface – Structured endpoints simplify access, while clear error codes enhance troubleshooting.
The LwM2M API Registry is essential for ensuring up-to-date metadata access, helping developers and organizations streamline IoT device management and integration.
LwM2M API DOCUMENTATION
The LwM2M API Registry V1 provides structured access to metadata information for all registered LwM2M objects. This documentation outlines the available API functions, error handling, and metadata structure to help users retrieve and manage IoT object data efficiently.
HIGHLIGHTS
📌 Basic Functions – Detailed API endpoints for object discovery and retrieval.
📌 Error Handling – Explanation of error codes and request validation rules.
📌 Metadata Structure – A breakdown of key metadata elements, including object descriptions, IDs, links, and specifications.
Use the LwM2M API to automate metadata retrieval, streamline device management, and enhance interoperability within IoT ecosystems.
This table lists the functions available on the OMA LwM2M Registry API version 1. This API provides access to the content on the LwM2M Registry DDF.
BASIC FUNCTION
| Function | URL | Description |
|---|---|---|
| Objects Discovery | lwm2m/v1/Object |
Retrieve a JSON file containing all the metadata information on all the Object Versions. |
lwm2m/v1/Object?ObjectVersion=latest |
Retrieve a JSON file containing all the metadata information with the latest version of the Objects. | |
| Get an Object | lwm2m/v1/Object?ObjectID=12 |
Retrieve a JSON file containing metadata information on Object 12. |
lwm2m/v1/Object?ObjectID=12&ObjectVersion=latest |
Retrieve a JSON file containing metadata information with the latest version of Object 12. | |
lwm2m/v1/Object?ObjectID=12&ObjectVersion=1.0 |
Retrieve a JSON file containing metadata information on Object Version 1.0 of Object 12. |
Note
ERROR CODES
| HTTP Code | Error Description |
|---|---|
| 400 | ObjectID must be included when ObjectVersion is set to "latest". |
| 404 | Specified ObjectID and/or ObjectVersion is not in the Registry. |
METADATA INFORMATION
This is the metadata information that will be available via this API. This information is not the content of the Object but the metadata information that defines or classifies the Object itself in our system.
| Element | Description |
|---|---|
| <Description> | Description of the Object. |
| <Label> | Who has defined the Object: 0 = defined by OMA 1 = defined by external Standards Development Organization 2 = private or individual registration |
| <Name> | Object Name. |
| <ObjectID> | Object ID. |
| <ObjectLink> | URL to the XML file describing the Object. |
| <ObjectLinkVisible> | 0 = if the link to the Object should not be visible, 1 = if the link to the Object should be visible |
| <SpecLink> | URL to the Technical Specifications (TS). |
| <SpecLinkVisible> | 0 = if the link to the TS should not be visible, 1 = if the link to the TS should be visible |
| <URN> | Object unique URN. |
| <Owner> | Name of the organization that has registered the Object. |
| <Ver> | Version of the Object. |
| <VortoLink> | URL to this object in Vorto. |
