Resources

Resources may support a varying range of operations: retrieve, search, create, modify, move and delete.

Pagination has not yet been implemented. When it is, there will be <Link> entries in the response headers. The format of the JSON response in the body will not change.

Requests to resource endpoints must carry a valid token. Section Installation and configuration describes how to obtain one. Sending no or an invalid token leads to the server responding with HTTP status 401.

The token must be in the Authorization header with a value Bearer <token>. E.g.:

"Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...."

When objects are loaded that are called by the UDM Rest API, the expected properties of the corresponding UCS@school object are checked and errors are logged. The output of the complete object as well as the stack trace are written to ucs-school-validation.log.

Contents:

• Resource Roles
  • Roles resource representation
  • Roles list and search
  • Roles retrieve
• Resource Schools
  • Schools resource representation
  • Schools udm_properties
  • Schools list and search
  • Schools exist
  • Schools retrieve
  • Schools create
  • Schools modify and move
  • Schools delete
• Resource Users
  • Users resource representation
  • Users list and search
  • Users retrieve
  • Users create
  • Users modify and move
  • Users delete
• Resource Classes
  • Resource representation
  • udm_properties for resource classes
  • List / Search
  • Retrieve
  • Modify
  • Create
  • Delete
• Resource Workgroups
  • Workgroups resource representation
  • udm_properties
  • Workgroups list and search
  • Workgroups retrieve
  • Workgroups modify
  • Workgroups create
  • Workgroups delete