Gives access to the device frame definitions stored on the primary M&C. Device frame definitions may be listed, read or written with this call.
Supported HTTP methods: GET, POST, HEAD, OPTIONS
GET /api/v1/dframes
Returns a list of all available device frame definitions. The list is read from the primary M&C.
Parameters: none.
Expected Payload: none.
Replied Payload: Returns an ItemList containing the names of all available device frame definitions.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, returns an ItemList containing the names of all available device frame definitions. |
| 400 | the primary M&C is offline, the list cannot be read. In this case a ApiError document is returned, describing details of the error. |
| 401 | not logged in. In this case a ApiError document is returned, describing details of the error. |
GET /api/v1/dframes/{name}
Returns a DeviceFrameDefinition document describing the requested frame. The frame definition is read from the primary M&C.
Parameters:
| Parameter | Description |
|---|---|
| name | The name of the frame definition to load. Please note, that frame names are case sensitive, the name must match exactly to be loaded. |
Expected Payload: none.
Replied Payload: Returns a DeviceFrameDefinition document describing the requested frame.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, returns a DeviceFrameDefinition document describing the requested frame. |
| 400 | the primary M&C is offline, the frame definition cannot be read. In this case a ApiError document is returned, describing details of the error. |
| 401 | not logged in. In this case a ApiError document is returned, describing details of the error. |
| 404 | no frame definition with the given name exists. In this case a ApiError document is returned, describing details of the error. |
POST /api/v1/dframes/{name}
Stores a DeviceFrameDefinition at the primary M&C. If the frame definition already exists, it gets overwritten.
Parameters:
| Parameter | Description |
|---|---|
| name | The name of the frame to store. DeviceFrame definition names may consist of the characters A-Z, a-z, 0-9 and the hyphen character. |
Expected Payload: The DeviceFrameDefinition to store.
Replied Payload: Echoes back the written DeviceFrameDefinition.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, echoes back the written DeviceFrameDefinition. |
| 400 | the primary M&C is offline, the frame definition cannot be written. In this case a ApiError document is returned, describing details of the error. |
| 401 | not logged in. In this case a ApiError document is returned, describing details of the error. |
DELETE /api/v1/dframe/{name}
Deletes a DeviceFrameDefinition at the primary M&C.
Parameters:
| Parameter | Description |
|---|---|
| name | The name of the frame definition do delete. DeviceFrame definition names may consist of the characters A-Z, a-z, 0-9 and the hyphen character. |
Expected Payload: none.
Replied Payload: none.
Return Codes:
| Code | Description |
|---|---|
| 204 | OK, the device frame has been deleted. |
| 400 | the primary M&C is offline, the frame definition cannot be deleted. In this case a ApiError document is returned, describing details of the error. |
| 401 | not logged in. In this case a ApiError document is returned, describing details of the error. |
| 404 | not found. No device frame of this name exists. In this case a ApiError document is returned, describing details of the error. |