4.65. Viewer - Read single entries by ID
| Id | 4.65. |
| Description |
As a Viewer,
I must be able to access any site / block / unit / connection / ntp by ID,
So that I can retrieve detailed information on a given database entry. |
| Priority | High |
| Actors | Viewer |
| API Calls |
GET /sites/<site-id> GET /blocks/<block-id> GET /units/<unit-id> GET /equipments/<equipment-id> GET /physical-links/<physical-link-id> |
| Linked Processes | |
| Status | Implemented |
Preconditions
- The User must be authenticated and have the Viewer role.
- The user must have the id of a resource on the system.
Postconditions
- The System returns the data that matches the request.
Main flow
- The User requests a resource by id.
- The system returns the requested resource.
Exceptions
[400 Bad Request] Invalid input:
If mandatory fields are missing or invalid, the system returns an error message.
[404 Not Found] Resource not found:
Error returned if the Server could not find any resource with the given id.
[500 Internal Server Error] System Error
If the system fails to save changes due to an internal error, it displays an appropriate message and logs the error for further investigation.