Skip to content
This repository has been archived by the owner on Dec 12, 2023. It is now read-only.

Concept/implement a REST API for interacting with the clients #1

Open
aellwein opened this issue Mar 31, 2015 · 1 comment
Open

Concept/implement a REST API for interacting with the clients #1

aellwein opened this issue Mar 31, 2015 · 1 comment
Assignees

Comments

@aellwein
Copy link
Owner

In order to enable applications to interact with LwM2M clients connected to myLwM2M server, a REST API would be helpful.

The following proposal describes possible REST resources:

  • GET /clients - get clients (paginated - to avoid too many results, query params possible for filtering)
  • GET /client/{id} - query a client data by an endpoint id
  • POST /client/{id}/read/{object_id}/{instance_id}/{resource_id} - read on object ID,instance,resource, the last two are optional
  • POST /client/{id}/write/{object_id}/{instance_id}/{resource_id} - write on given object/instance/resource, payload must contain the new value
  • POST/client/{id}/writeattributes/{object_id}/{instance_id}/{resource_id} - write attributes/configure observe. Payload contains the attributes.
  • POST /client/{id}/execute/{object_id}/{instance_id}/{resource_id} - execute an operation on object/instance/resource.
    ...
    And so on.

As a content type i would suggest application/json.

@aellwein aellwein self-assigned this Mar 31, 2015
@aellwein
Copy link
Owner Author

aellwein commented Apr 5, 2015

I think Tornado would be a good choice for a internal REST API provider (as it supports many cool and useful features like user authentication). aiohttp would also be a candidate, however, there are some features missing.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant