...
- Entity with unique name
- contains properties
- filterable (logical and between properties), pagable(size: 10, 20, 50, 100), sortable (multiple properties,ascending, descending, default)
- properties have unique names per entity (not translated - will be translated through seperate service if neccessary)
- CRUD (Create, Read, Update, Delete)-functionalities
- auth required, token based (has to be optimized - maybe independent from odl)
- export function
- additional result information:
- page number (1..n, if requested page>n page=n)
- page size (number of current filtered elements)
- result size (number of all elements for filter)
- payload: JSON (no '-' for properties, entities)
- yang spec !
- Language
- Localization
- change events via websocket (needs subscription for this entity)
- Term "Mountpoint" code consolidation
- Server: The terms "mountpoint", "mountpoint-id" (different writings) and "node-name" will be consolidated and replaced by the single term "node-id" in the code and in the database types.
- ODLUX Apps: There are different names used for the same id. Should be consolidated to "Nodename"
- Filter specification according to UX-Framework Tablefilter
Further points&questions:
...
CREATE, READ, UPDATE, DELETE
Filter-Object: (See UX-Framework Tablefilter)
Each answer contains "output" to specify the request related to the table behind:
Code Block | |
---|---|
js | { "input"output": { "filterpagination":[{ "property":"<property-name>", "filtervaluesize":"<filter-string>" }], "sortorder":[{ "property":"<property-name", 20, <-- Number of requested objects "sortorderpage":"ascending|descending" } ], "pagination":{ 1, <-- Page delivered back "size":20, "page":1 } } }total": 3 <-- Total number of Objects in overall list }, { <-- List of objects on this page. Number of objects are the really available one's on this page. Could be less requested. |
Request Entity-Example:
Code Block |
---|
POST /restconf/operations/data-provider:read-faultcurrent-list { "input":{ "filter":[], "sortorder":[], "pagination":{ "size":20, "page":1 } } } Response: { "output": { "pagination":{ "size":20, "page":1, "total": 3 }, "data": [ { "id": "Sim2230/LP-MWPS-TTP-RADIO/rslIsExceeded", "node-id": "Sim2230", "counter": "2", "timestamp": "2017-01-01T01:00:00.0Z", "object-id": "LP-MWPS-TTP-RADIO", "problem": "rslIsExceeded", "severity": "Critical", "type": "ProblemNotificationXml" }, { "id": "Sim2231/LP-MWPS-TTP-RADIO/rslIsExceeded", "node-id": "Sim2231", "counter": "3", "timestamp": "2017-01-01T02:00:00.0Z", "object-id": "LP-MWPS-TTP-RADIO", "problem": "rslIsExceeded", "severity": "Critical", "type": "ProblemNotificationXml" }, { "id": "Sim2230/LP-MWPS-TTP-RADIO/signalLost", "node-id": "Sim2230", "counter": "4", "timestamp": "2017-01-01T03:00:00.0Z", "object-id": "LP-MWPS-TTP-RADIO", "problem": "signalLost", "severity": "Major", "type": "ProblemNotificationXml" } ] } } |
...