Documentation of OpenOLAT REST API

The goal of the REST API is to provide an easy way to exchange URLs. It is also used to integrate with other systems such as student administration, external course administration and/or external learning group administration.

Concepts

Representational State Transfer or REST is a style of architecture to be primarily used with the HTTP protocol, but not exclusively. In the case of HTTP, it utilizes all its features: URIs to describe resources, HTTP Methods as "verbs" to manipulate resources (GET to retrieve resources, PUT to create new ones, POST to modify them, DELETE...), HTTP Headers and Media Types for content negotiation...

In OpenOLAT, JAX-RS 2.1 (JSR-370) is used as a backend for the implementation of our REST API. JSR-370 is a standard from J2EE. We use the implementation from: Apache CXF.

Usage

The OpenOLAT REST API has been developed with remote management applications in mind. It does not implement all features available in the web UI and many of the requests are limited to administrative users such as admin, user- or group managers and authors.

While theoretically possible, it is not meant as an API to implement alternative UI clients for end users. Keep this in mind when using the API.

Security

The security is based on a two level mechanism, as it is in OpenOLAT.

  1. The first level is a servlet filter which collects all requests to the REST API. This filter determines whether the URI is open to everyone (/api, /ping, /auth...) or if it needs an authentication. The authentication itself is delegated to a web service.
  2. The second level happens in all entry points of the REST API. Every method checks if the user (if a user must be authenticated) has enough privileges to operate on the desired resource.

To maintain a valid authentication over several requests, the filter proposes two methods:

  1. Reuse the session cookie on every request. The advantage of this method is that OpenOLAT doesn't need to create a session on every request.
  2. If you cannot use the session cookie, the filter always adds an HTTP Header (X-OLAT-TOKEN) to the response. Send this token with the next request to maintain your privileges.

Best practice usage

If the REST API is used to implement specific features in the OpenOLAT web user interface such as using the course database, the OpenOLAT web session cookie can be reused (method 1). The user is already authenticated in the browser

If the REST API is used by an external (server based) application, best-practice is to use basic authentication to authenticate the user and enable session cookies in the http client of the remote application.

If none of the above is possible, use method 2 using the X-OLAT-TOKEN. Note that a user can have only one X-OLAT-TOKEN at any time. If your remote application has several (concurrent) workers, basic authentication should be used.

If you are building a remote portal and want to implement some kind of home-brew single-sign-on process, method 2 can be used to generate the X-OLAT-TOKEN for every user as a server request. The Token can then be added to each link in the portal to login the user based on the token (?X-OLAT-TOKEN=xyz). When clicking the link, OpenOLAT will identify the user based on the token and create a valid user session. Security wise there are better options to achieve the same. We recommend using oAuth instead which is supported by OpenOLAT as well.

Configuration

The Spring integration of Apache CXF allows to configure the REST API with annotations and use the IOC features of Spring directly in our end points.

OpenOLAT uses the standard JAXB provider to produce XML from java objects, as well as the JSON provider from Jackson, which reuses the same JAXB annotations.

Very important! All configuration settings must be done before the servlet of Apache CXF starts.

Example

Here is a little example on how to create a user and add it to a learning group:

  1. Create a user
    PUT http://www.frentix.com/olat/restapi/users
    HTTP Header: Content-Type application/json
    Response: 200
  2. Get the list of groups
    GET http://www.frentix.com/olat/restapi/groups
    HTTP Header: Accept application/json
    Response: 200
  3. Choose a group from the response
  4. Add the user to the group
    PUT http://www.frentix.com/olat/restapi/groups/{groupId}/users/{identityKey}
    Response: 200

Documentation

This documentation is based on the WADL format. The XML file is automatically generated by Jersey (Jersey) on runtime. For documentation purposes, this file is the base of a four step Maven process to produce a human readable HTML file.

  1. Generate a XSD schema from all the Java classes used by JAXB for mapping
  2. Generate Javadoc with a custom doclet for WADL
  3. Generate WADL with the output of the two preceding steps
  4. Produce the final HTML documentation with XSLT

To add java classes annoted with JAXB, you must update the pom file in the OpenOLAT directory under the artifact maven-jaxb-schemagen-plugin.

To add resources, you must add the packages to the following plugins configurations: maven-javadoc-plugin and maven-wadl-plugin. Be aware that the first uses commas to seperates the packages and the second semicolons. Both recursively search all resources under the packages.

Examples for the documentation can only be generated for XML. This is a limitation of the maven plugin.

Contents of resources

Resources

/curriculum/types

The security check is done by the curriculums web service. Initial date: 16 mai 2018<br>

Methods

GET

Return the curriculum element types used in the whole OpenOLAT instance.

available response representations:

available response representations:

PUT

Creates and persists a new curriculum element type entity.

acceptable request representations:

available response representations:

available response representations:

available response representations:

POST

Updates a new curriculum element type entity.

acceptable request representations:

available response representations:

available response representations:

available response representations:

/curriculum/types/{curriculumElementTypeKey}

resource-wide template parameters
parameter value description

curriculumElementTypeKey

long

The curriculum element type primary key

Methods

POST

Updates a new curriculum element type entity.

acceptable request representations:

available response representations:

available response representations:

available response representations:

GET

Get a specific curriculum element type.

available response representations:

available response representations:

/curriculum/types/{curriculumElementTypeKey}/allowedSubTypes

resource-wide template parameters
parameter value description

curriculumElementTypeKey

long

The curriculum element type primary key

Methods

GET

Get the allowed sub-types of a specified curriculum element type.

available response representations:

available response representations:

available response representations:

/curriculum/types/{curriculumElementTypeKey}/allowedSubTypes/{subTypeKey}

resource-wide template parameters
parameter value description

subTypeKey

long

The sub type to remove

curriculumElementTypeKey

long

The type

Methods

PUT

Add a sub-type to a specified curriculum element type.

available response representations:

available response representations:

available response representations:

DELETE

Remove a sub-type to a specified curriculum element type.

available response representations:

available response representations:

available response representations:

/auth

Methods

/auth/{username}?password&x-olat-token

resource-wide template parameters
parameter value description

username

string

Methods

GET

request query parameters
parameter value description

password

string

x-olat-token

string

available response representations:

/auth/version

Methods

GET

available response representations:

/docpool

Initial date: 5 Oct 2017<br>

Methods

/docpool/module/configuration

Methods

GET

Return the configuration of the taxonomy module.

available response representations:

available response representations:

/docpool/{taxonomyKey}

Initial date: 5 Oct 2017<br>

resource-wide template parameters
parameter value description

taxonomyKey

long

Methods

GET

Return the taxonomy object specified by the key in path.

available response representations:

available response representations:

/docpool/{taxonomyKey}/types/{typeKey}/allowedSubTypes/{subTypeKey}

resource-wide template parameters
parameter value description

taxonomyKey

long

typeKey

long

subTypeKey

long

Methods

PUT

Add a sub-type to a specified taxonomy level's type.

available response representations:

available response representations:

available response representations:

DELETE

Remove a sub-type to a specified taxonomy level's type.

available response representations:

available response representations:

available response representations:

/docpool/{taxonomyKey}/levels/{taxonomyLevelKey}

resource-wide template parameters
parameter value description

taxonomyKey

long

taxonomyLevelKey

string

Methods

DELETE

Delete the taxonomy level definitively.

available response representations:

available response representations:

available response representations:

available response representations:

/docpool/{taxonomyKey}/levels

resource-wide template parameters
parameter value description

taxonomyKey

long

Methods

GET

Return the flatted levels of a taxonomy.

available response representations:

available response representations:

PUT

Create or update a taxonomy level. The method changes to tree structure, a null parent key will make the level a root one, a new parent key will move the level.

acceptable request representations:

available response representations:

available response representations:

available response representations:

/docpool/{taxonomyKey}/levels/{taxonomyLevelKey}/competences

resource-wide template parameters
parameter value description

taxonomyKey

long

taxonomyLevelKey

long

Methods

GET

Return the competences of users on the taxonomy level specified in the key in path.

available response representations:

available response representations:

PUT

Add a competence on a specific level of a taxonomy tree.

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

/docpool/{taxonomyKey}/competences/{identityKey}

resource-wide template parameters
parameter value description

taxonomyKey

long

identityKey

long

Methods

GET

Return the competences of a specific user in the taxonomy tree.

available response representations:

available response representations:

/docpool/{taxonomyKey}/levels/{taxonomyLevelKey}/competences/{identityKey}

resource-wide template parameters
parameter value description

taxonomyKey

long

taxonomyLevelKey

long

identityKey

long

Methods

GET

Return the competences of a specific user on the taxonomy level specified in the key in path.

available response representations:

available response representations:

/docpool/{taxonomyKey}/levels/{taxonomyLevelKey}/competences/{competenceKey}

resource-wide template parameters
parameter value description

taxonomyKey

long

taxonomyLevelKey

long

competenceKey

long

Methods

DELETE

Remove a competence.

available response representations:

available response representations:

available response representations:

/docpool/{taxonomyKey}/types

resource-wide template parameters
parameter value description

taxonomyKey

long

Methods

GET

Get the configurations for taxonomy levels for the whole taxonomy.

available response representations:

available response representations:

available response representations:

PUT

Create or Update a taxonomy level's type.

acceptable request representations:

available response representations:

available response representations:

available response representations:

/docpool/{taxonomyKey}/types/{typeKey}

resource-wide template parameters
parameter value description

taxonomyKey

long

typeKey

long

Methods

GET

Get a taxonomy level's type.

available response representations:

available response representations:

available response representations:

/docpool/{taxonomyKey}/types/{typeKey}/allowedSubTypes

resource-wide template parameters
parameter value description

taxonomyKey

long

typeKey

long

Methods

GET

Get the allowed sub-types of a specified taxonomy level's type.

available response representations:

available response representations:

available response representations:

/registration?email

Description:<br> Web service to trigger the registration process <P> Initial Date: 14 juil. 2011 <br>

Methods

PUT

Register with the specified email

request query parameters
parameter value description

email

string

The email address

available response representations:

available response representations:

available response representations:

POST

Register with the specified email

acceptable request representations:

available response representations:

available response representations:

/system

Methods

/system/release

Methods

GET

available response representations:

/system/environment

Methods

GET

available response representations:

/system/indexer

Methods

GET

available response representations:

/system/indexer/status

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

GET

available response representations:

/system/log

Methods

GET

available response representations:

/system/log/version

Methods

GET

available response representations:

/system/log/{date}

resource-wide template parameters
parameter value description

date

string

Methods

GET

available response representations:

/system/monitoring

Methods

/system/monitoring/configuration

Methods

GET

available response representations:

/system/monitoring/status

Methods

GET

available response representations:

/system/monitoring/runtime

Methods

GET

available response representations:

/system/monitoring/runtime/memory

Methods

GET

available response representations:

/system/monitoring/runtime/threads

Methods

GET

available response representations:

/system/monitoring/runtime/classes

Methods

GET

available response representations:

/system/monitoring/database

Methods

GET

available response representations:

/system/monitoring/openolat

Methods

GET

available response representations:

/system/monitoring/openolat/tasks

Methods

GET

available response representations:

/system/monitoring/openolat/users

Methods

GET

available response representations:

/system/monitoring/openolat/repository

Methods

GET

available response representations:

/system/monitoring/openolat/sessions

Methods

GET

available response representations:

/system/monitoring/openolat/indexer

Methods

GET

available response representations:

/system/monitoring/openolat/indexer/status

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

GET

available response representations:

/system/monitoring/memory

Methods

GET

available response representations:

GET

available response representations:

/system/monitoring/memory/pools

Methods

GET

available response representations:

GET

available response representations:

/system/monitoring/memory/samples?from&to&lastSamples

Methods

GET

request query parameters
parameter value description

from

string

to

string

lastSamples

int

available response representations:

/system/monitoring/threads

Methods

GET

available response representations:

GET

available response representations:

/system/monitoring/threads/cpu

Methods

GET

available response representations:

/system/notifications

Methods

/system/notifications/status

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

GET

available response representations:

/api

Methods

/api/doc

Methods

GET

available response representations:

/api/{filename}

resource-wide template parameters
parameter value description

filename

string

Methods

GET

available response representations:

/api/copyright

Methods

GET

available response representations:

GET

available response representations:

/api/doc/{filename}

resource-wide template parameters
parameter value description

filename

string

Methods

GET

available response representations:

/api/version

Methods

GET

available response representations:

/users/{identityKey}/calendars

resource-wide template parameters
parameter value description

identityKey

long

Methods

GET

available response representations:

/users/{identityKey}/calendars/events?start&limit&onlyFuture

resource-wide template parameters
parameter value description

identityKey

long

identityKey

long

Methods

GET

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

onlyFuture

boolean

Default: false

available response representations:

/users/{identityKey}/calendars/{calendarId}

Initial date: 23.12.2015<br>

resource-wide template parameters
parameter value description

identityKey

long

calendarId

string

identityKey

long

Methods

/users/{identityKey}/calendars/{calendarId}/events/{eventId}

resource-wide template parameters
parameter value description

identityKey

long

calendarId

string

identityKey

long

eventId

string

Methods

DELETE

available response representations:

/users/{identityKey}/calendars/{calendarId}/event

resource-wide template parameters
parameter value description

identityKey

long

calendarId

string

identityKey

long

Methods

PUT

acceptable request representations:

available response representations:

POST

acceptable request representations:

available response representations:

/users/{identityKey}/calendars/{calendarId}/events

resource-wide template parameters
parameter value description

identityKey

long

calendarId

string

identityKey

long

Methods

PUT

acceptable request representations:

available response representations:

GET

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

onlyFuture

boolean

Default: false

available response representations:

POST

acceptable request representations:

available response representations:

/organisations

Initial date: 14 mai 2018<br>

Methods

PUT

Creates and persists a new organization entity.

acceptable request representations:

available response representations:

available response representations:

available response representations:

GET

List of organizations flat.

available response representations:

available response representations:

POST

Updates a new organization entity.

acceptable request representations:

available response representations:

available response representations:

available response representations:

/organisations/{organisationKey}/{role}

resource-wide template parameters
parameter value description

role

string

organisationKey

long

Methods

GET

Get all members of the specified organisation with the specified role.

available response representations:

available response representations:

available response representations:

available response representations:

PUT

Add a membership to the specified curriculum element.

request query parameters
parameter value description

inheritanceMode

string

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

/organisations/version

Methods

GET

The version of the User Web Service

available response representations:

/organisations/{organisationKey}/{role}/{identityKey}?inheritanceMode

resource-wide template parameters
parameter value description

role

string

organisationKey

long

identityKey

long

Methods

PUT

Make the specified user a member of the specified organization with the specified role.

request query parameters
parameter value description

inheritanceMode

string

available response representations:

available response representations:

available response representations:

DELETE

Remove the membership of the identity from the specified organization and role.

available response representations:

available response representations:

available response representations:

/organisations/{organisationKey}

resource-wide template parameters
parameter value description

organisationKey

long

Methods

GET

Get a specific organization.

available response representations:

available response representations:

POST

Updates a new organization entity.

acceptable request representations:

available response representations:

available response representations:

available response representations:

/organisations/{organisationKey}/entries

resource-wide template parameters
parameter value description

organisationKey

long

Methods

GET

available response representations:

/organisations/types

Initial date: 14 mai 2018<br>

Methods

GET

List of organizations types.

available response representations:

available response representations:

PUT

Creates and persists a new organization type entity.

acceptable request representations:

available response representations:

available response representations:

available response representations:

POST

Updates a new organization type entity.

acceptable request representations:

available response representations:

available response representations:

available response representations:

/organisations/types/{organisationTypeKey}/allowedSubTypes

resource-wide template parameters
parameter value description

organisationTypeKey

long

The organization type primary key

Methods

GET

Get the allowed sub-types of a specified organization type.

available response representations:

available response representations:

available response representations:

/organisations/types/{organisationTypeKey}/allowedSubTypes/{subTypeKey}

resource-wide template parameters
parameter value description

subTypeKey

long

The sub type to remove

organisationTypeKey

long

The type

Methods

PUT

Add a sub-type to a specified organization type.

available response representations:

available response representations:

available response representations:

DELETE

Remove a sub-type to a specified organization type.

available response representations:

available response representations:

available response representations:

/organisations/types/{organisationTypeKey}

resource-wide template parameters
parameter value description

organisationTypeKey

long

The organization type primary key

Methods

GET

List of organizations types.

available response representations:

available response representations:

POST

Updates a new organization type entity. The primary key is taken from the URL. The organization type object can be "primary key free".

acceptable request representations:

available response representations:

available response representations:

available response representations:

/taxonomy

Initial date: 5 Oct 2017<br>

Methods

/taxonomy/{taxonomyKey}

Initial date: 5 Oct 2017<br>

resource-wide template parameters
parameter value description

taxonomyKey

long

Methods

GET

Return the taxonomy object specified by the key in path.

available response representations:

available response representations:

/taxonomy/{taxonomyKey}/types/{typeKey}/allowedSubTypes/{subTypeKey}

resource-wide template parameters
parameter value description

taxonomyKey

long

typeKey

long

subTypeKey

long

Methods

PUT

Add a sub-type to a specified taxonomy level's type.

available response representations:

available response representations:

available response representations:

DELETE

Remove a sub-type to a specified taxonomy level's type.

available response representations:

available response representations:

available response representations:

/taxonomy/{taxonomyKey}/levels/{taxonomyLevelKey}

resource-wide template parameters
parameter value description

taxonomyKey

long

taxonomyLevelKey

string

Methods

DELETE

Delete the taxonomy level definitively.

available response representations:

available response representations:

available response representations:

available response representations:

/taxonomy/{taxonomyKey}/levels

resource-wide template parameters
parameter value description

taxonomyKey

long

Methods

GET

Return the flatted levels of a taxonomy.

available response representations:

available response representations:

PUT

Create or update a taxonomy level. The method changes to tree structure, a null parent key will make the level a root one, a new parent key will move the level.

acceptable request representations:

available response representations:

available response representations:

available response representations:

/taxonomy/{taxonomyKey}/levels/{taxonomyLevelKey}/competences

resource-wide template parameters
parameter value description

taxonomyKey

long

taxonomyLevelKey

long

Methods

GET

Return the competences of users on the taxonomy level specified in the key in path.

available response representations:

available response representations:

PUT

Add a competence on a specific level of a taxonomy tree.

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

/taxonomy/{taxonomyKey}/competences/{identityKey}

resource-wide template parameters
parameter value description

taxonomyKey

long

identityKey

long

Methods

GET

Return the competences of a specific user in the taxonomy tree.

available response representations:

available response representations:

/taxonomy/{taxonomyKey}/levels/{taxonomyLevelKey}/competences/{identityKey}

resource-wide template parameters
parameter value description

taxonomyKey

long

taxonomyLevelKey

long

identityKey

long

Methods

GET

Return the competences of a specific user on the taxonomy level specified in the key in path.

available response representations:

available response representations:

/taxonomy/{taxonomyKey}/levels/{taxonomyLevelKey}/competences/{competenceKey}

resource-wide template parameters
parameter value description

taxonomyKey

long

taxonomyLevelKey

long

competenceKey

long

Methods

DELETE

Remove a competence.

available response representations:

available response representations:

available response representations:

/taxonomy/{taxonomyKey}/types

resource-wide template parameters
parameter value description

taxonomyKey

long

Methods

GET

Get the configurations for taxonomy levels for the whole taxonomy.

available response representations:

available response representations:

available response representations:

PUT

Create or Update a taxonomy level's type.

acceptable request representations:

available response representations:

available response representations:

available response representations:

/taxonomy/{taxonomyKey}/types/{typeKey}

resource-wide template parameters
parameter value description

taxonomyKey

long

typeKey

long

Methods

GET

Get a taxonomy level's type.

available response representations:

available response representations:

available response representations:

/taxonomy/{taxonomyKey}/types/{typeKey}/allowedSubTypes

resource-wide template parameters
parameter value description

taxonomyKey

long

typeKey

long

Methods

GET

Get the allowed sub-types of a specified taxonomy level's type.

available response representations:

available response representations:

available response representations:

/organisations/types

Initial date: 14 mai 2018<br>

Methods

GET

List of organizations types.

available response representations:

available response representations:

PUT

Creates and persists a new organization type entity.

acceptable request representations:

available response representations:

available response representations:

available response representations:

POST

Updates a new organization type entity.

acceptable request representations:

available response representations:

available response representations:

available response representations:

/organisations/types/{organisationTypeKey}/allowedSubTypes

resource-wide template parameters
parameter value description

organisationTypeKey

long

The organization type primary key

Methods

GET

Get the allowed sub-types of a specified organization type.

available response representations:

available response representations:

available response representations:

/organisations/types/{organisationTypeKey}/allowedSubTypes/{subTypeKey}

resource-wide template parameters
parameter value description

subTypeKey

long

The sub type to remove

organisationTypeKey

long

The type

Methods

PUT

Add a sub-type to a specified organization type.

available response representations:

available response representations:

available response representations:

DELETE

Remove a sub-type to a specified organization type.

available response representations:

available response representations:

available response representations:

/organisations/types/{organisationTypeKey}

resource-wide template parameters
parameter value description

organisationTypeKey

long

The organization type primary key

Methods

GET

List of organizations types.

available response representations:

available response representations:

POST

Updates a new organization type entity. The primary key is taken from the URL. The organization type object can be "primary key free".

acceptable request representations:

available response representations:

available response representations:

available response representations:

/repo/courses/{courseId}/elements/forum

Description:<br> REST API implementation for forum course node <P> Initial Date: 20.12.2010 <br>

resource-wide template parameters
parameter value description

courseId

long

Methods

GET

Retrieves metadata of the published course node

available response representations:

available response representations:

available response representations:

POST

This attaches a Forum Element onto a given course. The element will be inserted underneath the supplied parentNodeId.

acceptable request representations:

available response representations:

available response representations:

available response representations:

PUT

This attaches a Forum Element onto a given course. The element will be inserted underneath the supplied parentNodeId.

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

moderatorExpertRules

string

posterExpertRules

string

readerExpertRules

string

available response representations:

available response representations:

available response representations:

/repo/courses/{courseId}/elements/forum/{nodeId}

resource-wide template parameters
parameter value description

courseId

long

courseId

long

The course resourceable's id

nodeId

string

The node's id

Methods

GET

Retrieves metadata of the published course node

available response representations:

available response representations:

available response representations:

/repo/courses/{courseId}/elements/forum/{nodeId}/thread?title&body&identityName&sticky

resource-wide template parameters
parameter value description

courseId

long

courseId

long

The id of the course.

nodeId

string

The id of the course node.

Methods

PUT

Creates a new thread in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

identityName

string

The author identity name (optional)

sticky

boolean

Creates sticky thread.

available response representations:

available response representations:

available response representations:

/repo/courses/{courseId}/elements/forum/{nodeId}/message?parentMessageId&title&body&identityName

resource-wide template parameters
parameter value description

courseId

long

courseId

long

The id of the course.

nodeId

string

The id of the course node.

Methods

PUT

Creates a new forum message in the forum of the course node

request query parameters
parameter value description

parentMessageId

long

The id of the parent message.

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

identityName

string

The author identity name (optional)

available response representations:

available response representations:

available response representations:

/repo/courses/{courseId}/elements/forum/{nodeId}/forum

Description:<br> Web service to manage a forum. <P> Initial Date: 20 apr. 2010 <br>

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

Methods

GET

Retrieves the forum.

available response representations:

available response representations:

available response representations:

/repo/courses/{courseId}/elements/forum/{nodeId}/forum/threads?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

Methods

GET

Retrieves the threads in the forum

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name,creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

available response representations:

available response representations:

PUT

Creates a new thread in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

available response representations:

available response representations:

POST

Creates a new thread in the forum of the course node

acceptable request representations:

available response representations:

available response representations:

available response representations:

/repo/courses/{courseId}/elements/forum/{nodeId}/forum/posts/{threadKey}?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

threadKey

long

The key of the thread

Methods

GET

Retrieves the messages in the thread

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name, creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

available response representations:

available response representations:

/repo/courses/{courseId}/elements/forum/{nodeId}/forum/posts/{messageKey}

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

messageKey

long

The id of the reply message

Methods

POST

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

available response representations:

available response representations:

PUT

Creates a new reply in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

available response representations:

available response representations:

PUT

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

available response representations:

available response representations:

/repo/courses/{courseId}/elements/forum/{nodeId}/forum/posts/{messageKey}/attachments

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

messageKey

long

The key of the message

Methods

GET

Retrieves the attachments of the message

available response representations:

available response representations:

POST

Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.

available response representations:

available response representations:

POST

Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.

acceptable request representations:

available response representations:

available response representations:

PUT

Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.

acceptable request representations:

available response representations:

available response representations:

/repo/courses/{courseId}/elements/forum/{nodeId}/forum/posts/{messageKey}/attachments/{filename}

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

messageKey

long

The identity key of the user being searched

filename

string

The name of the attachment

Methods

GET

Retrieves the attachment of the message

available response representations:

available response representations:

/repo/entries?start&limit&managed&externalId&externalRef&resourceType

Methods

GET

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

managed

boolean

externalId

string

externalRef

string

resourceType

string

available response representations:

GET

available response representations:

PUT

available response representations:

/repo/entries/search?type&author&name&myentries

Methods

GET

request query parameters
parameter value description

type

string

author

string

Default: *

name

string

Default: *

myentries

boolean

Default: false

available response representations:

/repo/entries/version

Methods

GET

available response representations:

/repo/entries/{repoEntryKey}

resource-wide template parameters
parameter value description

repoEntryKey

string

Methods

DELETE

available response representations:

GET

available response representations:

POST

acceptable request representations:

available response representations:

POST

available response representations:

/repo/entries/{repoEntryKey}/access

resource-wide template parameters
parameter value description

repoEntryKey

string

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

/repo/entries/{repoEntryKey}/curriculum/elements

resource-wide template parameters
parameter value description

repoEntryKey

string

Methods

GET

available response representations:

/repo/entries/{repoEntryKey}/coaches/{identityKey}

resource-wide template parameters
parameter value description

repoEntryKey

string

identityKey

long

Methods

PUT

available response representations:

DELETE

available response representations:

/repo/entries/{repoEntryKey}/coaches

resource-wide template parameters
parameter value description

repoEntryKey

string

Methods

PUT

acceptable request representations:

available response representations:

GET

available response representations:

/repo/entries/{repoEntryKey}/participants

resource-wide template parameters
parameter value description

repoEntryKey

string

Methods

GET

available response representations:

PUT

acceptable request representations:

available response representations:

/repo/entries/{repoEntryKey}/participants/{identityKey}

resource-wide template parameters
parameter value description

repoEntryKey

string

identityKey

long

Methods

PUT

available response representations:

DELETE

available response representations:

/repo/entries/{repoEntryKey}/owners

resource-wide template parameters
parameter value description

repoEntryKey

string

Methods

PUT

acceptable request representations:

available response representations:

GET

available response representations:

/repo/entries/{repoEntryKey}/organisations/{organisationKey}

resource-wide template parameters
parameter value description

repoEntryKey

string

organisationKey

long

Methods

PUT

available response representations:

DELETE

available response representations:

/repo/entries/{repoEntryKey}/file

resource-wide template parameters
parameter value description

repoEntryKey

string

Methods

GET

available response representations:

/repo/entries/{repoEntryKey}/status

resource-wide template parameters
parameter value description

repoEntryKey

string

Methods

POST

acceptable request representations:

available response representations:

/repo/entries/{repoEntryKey}/taxonomy/levels/{taxonomyLevelKey}

resource-wide template parameters
parameter value description

repoEntryKey

string

taxonomyLevelKey

long

Methods

DELETE

available response representations:

PUT

available response representations:

/repo/entries/{repoEntryKey}/organisations

resource-wide template parameters
parameter value description

repoEntryKey

string

Methods

GET

available response representations:

/repo/entries/{repoEntryKey}/taxonomy/levels

resource-wide template parameters
parameter value description

repoEntryKey

string

Methods

GET

available response representations:

/repo/entries/{repoEntryKey}/owners/{identityKey}

resource-wide template parameters
parameter value description

repoEntryKey

string

identityKey

long

Methods

PUT

available response representations:

DELETE

available response representations:

/repo/entries/{repoEntryKey}/lectureblocks

resource-wide template parameters
parameter value description

repoEntryKey

string

Methods

GET

available response representations:

PUT

acceptable request representations:

available response representations:

/repo/entries/{repoEntryKey}/lectureblocks/configuration

resource-wide template parameters
parameter value description

repoEntryKey

string

Methods

GET

available response representations:

/repo/entries/{repoEntryKey}/lectureblocks/healmoved/{originEntryKey}

resource-wide template parameters
parameter value description

repoEntryKey

string

originEntryKey

long

Methods

POST

available response representations:

/repo/entries/{repoEntryKey}/lectureblocks/sync/calendar

resource-wide template parameters
parameter value description

repoEntryKey

string

Methods

POST

available response representations:

/repo/entries/{repoEntryKey}/lectureblocks/adaptation

resource-wide template parameters
parameter value description

repoEntryKey

string

Methods

GET

available response representations:

/repo/entries/{repoEntryKey}/lectureblocks/{lectureBlockKey}

resource-wide template parameters
parameter value description

repoEntryKey

string

lectureBlockKey

long

Methods

GET

available response representations:

DELETE

available response representations:

/repo/entries/{repoEntryKey}/lectureblocks/{lectureBlockKey}/sync/calendar

resource-wide template parameters
parameter value description

repoEntryKey

string

lectureBlockKey

long

Methods

POST

available response representations:

/repo/entries/{repoEntryKey}/lectureblocks/{lectureBlockKey}/taxonomy/levels/{taxonomyLevelKey}

resource-wide template parameters
parameter value description

repoEntryKey

string

lectureBlockKey

long

taxonomyLevelKey

long

Methods

DELETE

available response representations:

PUT

available response representations:

/repo/entries/{repoEntryKey}/lectureblocks/{lectureBlockKey}/taxonomy/levels

resource-wide template parameters
parameter value description

repoEntryKey

string

lectureBlockKey

long

Methods

GET

available response representations:

/repo/entries/{repoEntryKey}/lectureblocks/{lectureBlockKey}/entry/{repositoryEntryKey}

resource-wide template parameters
parameter value description

repoEntryKey

string

lectureBlockKey

long

repositoryEntryKey

long

Methods

POST

available response representations:

/repo/entries/{repoEntryKey}/lectureblocks/{lectureBlockKey}/teachers/{identityKey}

resource-wide template parameters
parameter value description

repoEntryKey

string

lectureBlockKey

long

identityKey

long

Methods

PUT

available response representations:

DELETE

available response representations:

/repo/entries/{repoEntryKey}/lectureblocks/{lectureBlockKey}/teachers

resource-wide template parameters
parameter value description

repoEntryKey

string

lectureBlockKey

long

Methods

GET

available response representations:

/repo/entries/{repoEntryKey}/lectureblocks/{lectureBlockKey}/participants/repositoryentry

resource-wide template parameters
parameter value description

repoEntryKey

string

lectureBlockKey

long

Methods

PUT

available response representations:

DELETE

available response representations:

/repo/entries/{repoEntryKey}/lectureblocks/{lectureBlockKey}/participants/curriculum

resource-wide template parameters
parameter value description

repoEntryKey

string

lectureBlockKey

long

Methods

PUT

available response representations:

DELETE

available response representations:

/repo/sharedfolder

Methods

/repo/sharedfolder/version

Methods

GET

available response representations:

/repo/sharedfolder/{repoEntryKey}

resource-wide template parameters
parameter value description

repoEntryKey

long

Methods

GET

available response representations:

/repo/sharedfolder/{repoEntryKey}/files

resource-wide template parameters
parameter value description

repoEntryKey

long

Methods

GET

available response representations:

PUT

available response representations:

PUT

acceptable request representations:

available response representations:

POST

available response representations:

POST

acceptable request representations:

available response representations:

/repo/sharedfolder/{repoEntryKey}/files/{path:.*}

resource-wide template parameters
parameter value description

repoEntryKey

long

path

string

Methods

GET

available response representations:

POST

available response representations:

POST

acceptable request representations:

available response representations:

PUT

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

available response representations:

DELETE

available response representations:

/repo/sharedfolder/{repoEntryKey}/files/metadata/{path:.*}

resource-wide template parameters
parameter value description

repoEntryKey

long

path

string

Methods

GET

available response representations:

/repo/sharedfolder/{repoEntryKey}/files/version

resource-wide template parameters
parameter value description

repoEntryKey

long

Methods

GET

available response representations:

/repo/courses/{courseId}/elements/enrollment?parentNodeId&position&shortTitle&longTitle&objectives&visibilityExpertRules&accessExpertRules&groups&cancelEnabled

Description:<br> This handles the enrollment building block. <P> Initial Date: 10 mai 2010 <br>

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

Methods

PUT

This attaches an enrollment element onto a given course, the element will be inserted underneath the supplied parentNodeId

request query parameters
parameter value description

parentNodeId

string

The node's id which will be the parent of this structure

position

int

The node's position relative to its sibling nodes (optional)

shortTitle

string

Default: undefined

The node short title

longTitle

string

Default: undefined

The node long title

objectives

string

Default: undefined

The node learning objectives

visibilityExpertRules

string

The rules to view the node (optional)

accessExpertRules

string

The rules to access the node (optional)

groups

string

A list of learning groups (list of keys)

cancelEnabled

boolean

Default: false

cancel enrollment enabled or not

available response representations:

available response representations:

available response representations:

POST

This attaches an enrollment element onto a given course, the element will be inserted underneath the supplied parentNodeId

acceptable request representations:

available response representations:

available response representations:

available response representations:

/repo/courses/{courseId}/elements/enrollment/{nodeId}/groups

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

nodeId

string

Methods

GET

Retrieves the groups where the enrollment happens

available response representations:

available response representations:

available response representations:

/catalog

Methods

GET

available response representations:

/catalog/{path:.*}/children?start&limit

resource-wide template parameters
parameter value description

path

string

Methods

GET

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

available response representations:

/catalog/{path:.*}/owners/{identityKey}

resource-wide template parameters
parameter value description

path

string

identityKey

long

Methods

GET

available response representations:

PUT

available response representations:

DELETE

available response representations:

/catalog/version

Methods

GET

available response representations:

/catalog/{path:.*}

resource-wide template parameters
parameter value description

path

string

Methods

GET

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

request query parameters
parameter value description

name

string

description

string

type

int

repoEntryKey

long

available response representations:

POST

acceptable request representations:

available response representations:

POST

request query parameters
parameter value description

newParentKey

long

acceptable request representations:

available response representations:

POST

request query parameters
parameter value description

name

string

description

string

newParentKey

long

available response representations:

DELETE

available response representations:

/catalog/{path:.*}/owners

resource-wide template parameters
parameter value description

path

string

Methods

GET

available response representations:

/users

This web service handles functionalities related to <code>User</code>.

Methods

PUT

Creates and persists a new user entity

acceptable request representations:

available response representations:

available response representations:

available response representations:

GET

Search users and return them in a simple form (without user properties). User properties can be added two the query parameters. If the authUsername and the authProvider are set, the search is made only with these two parameters because they are sufficient to return a single user.<br> The search with login and user properties are made default with wild cards. If an exact match is needed, the parameter msut be quoted:<br> users?login="username"<br> Don't forget the right escaping in the URL!<br> You can make a search with the user properties like this:<br> users?telMobile=39847592&login=test <br >/ The lookup is possible for authors, usermanagers and system administrators. Normal users are not allowed to use the lookup service.

request query parameters
parameter value description

login

string

authProvider

string

authUsername

string

statusVisibleLimit

string

available response representations:

available response representations:

/users/{identityKey}

resource-wide template parameters
parameter value description

identityKey

long

The user key identifier of the user being searched

Methods

POST

Update an user

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

DELETE

Delete an user from the system

available response representations:

available response representations:

available response representations:

available response representations:

GET

Retrieves an user given its unique key identifier

request query parameters
parameter value description

withPortrait

boolean

Default: false

If true return the portrait as Base64 (default false)

available response representations:

available response representations:

available response representations:

/users/{identityKey}/status

resource-wide template parameters
parameter value description

identityKey

long

The user key identifier of the user being searched

Methods

GET

Retrieves the status of a user given its unique key identifier

available response representations:

available response representations:

available response representations:

POST

Update the roles of a user given its unique key identifier: <ul> <li>1: Permanent user</li> <li>2: activ</li> <li>101: login denied</li> <li>199: deleted</li> </ul>

acceptable request representations:

available response representations:

available response representations:

available response representations:

/users/{identityKey}/portrait

resource-wide template parameters
parameter value description

identityKey

long

The identity key identifier of the user being searched

Methods

GET

Retrieves the portrait of an user

available response representations:

available response representations:

HEAD

Retrieves the portrait of an user

available response representations:

available response representations:

POST

Upload the portrait of an user

available response representations:

available response representations:

available response representations:

DELETE

Deletes the portrait of an user

available response representations:

available response representations:

/users/{identityKey}/preferences

resource-wide template parameters
parameter value description

identityKey

long

The user key identifier of the user being searched

Methods

GET

Retrieves the preferences of a user given its unique key identifier

available response representations:

available response representations:

available response representations:

POST

Update the preferences of a user given its unique key identifier

acceptable request representations:

available response representations:

available response representations:

available response representations:

/users/{identityKey}/roles

resource-wide template parameters
parameter value description

identityKey

long

The user key identifier of the user being searched

Methods

GET

Retrieves the roles of a user given its unique key identifier

available response representations:

available response representations:

available response representations:

POST

Update the roles of a user given its unique key identifier

acceptable request representations:

available response representations:

available response representations:

available response representations:

/users/managed

Methods

GET

available response representations:

/users/version

Methods

GET

The version of the User Web Service

available response representations:

/users/{identityKey}/portrait/{size}

resource-wide template parameters
parameter value description

size

string

identityKey

long

Methods

HEAD

Retrieves the portrait of an user

available response representations:

available response representations:

/users/{identityKey}/folders

Description:<br> <P> Initial Date: 16 déc. 2011 <br>

resource-wide template parameters
parameter value description

identityKey

long

Methods

GET

Retrieves a list of folders on a user base. All folders of groups where the user is participant/tutor + all folders in course where the user is a participant (owner, tutor or participant)

available response representations:

available response representations:

/users/{identityKey}/folders/course/{courseKey}/{courseNodeId}

resource-wide template parameters
parameter value description

identityKey

long

courseKey

long

courseNodeId

string

Methods

GET

available response representations:

PUT

available response representations:

PUT

acceptable request representations:

available response representations:

POST

available response representations:

POST

acceptable request representations:

available response representations:

/users/{identityKey}/folders/course/{courseKey}/{courseNodeId}/{path:.*}

resource-wide template parameters
parameter value description

identityKey

long

courseKey

long

courseNodeId

string

path

string

Methods

GET

available response representations:

POST

available response representations:

POST

acceptable request representations:

available response representations:

PUT

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

available response representations:

DELETE

available response representations:

/users/{identityKey}/folders/course/{courseKey}/{courseNodeId}/metadata/{path:.*}

resource-wide template parameters
parameter value description

identityKey

long

courseKey

long

courseNodeId

string

path

string

Methods

GET

available response representations:

/users/{identityKey}/folders/course/{courseKey}/{courseNodeId}/version

resource-wide template parameters
parameter value description

identityKey

long

courseKey

long

courseNodeId

string

Methods

GET

available response representations:

/users/{identityKey}/folders/personal

resource-wide template parameters
parameter value description

identityKey

long

Methods

GET

available response representations:

PUT

available response representations:

PUT

acceptable request representations:

available response representations:

POST

available response representations:

POST

acceptable request representations:

available response representations:

/users/{identityKey}/folders/personal/{path:.*}

resource-wide template parameters
parameter value description

identityKey

long

path

string

Methods

GET

available response representations:

POST

available response representations:

POST

acceptable request representations:

available response representations:

PUT

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

available response representations:

DELETE

available response representations:

/users/{identityKey}/folders/personal/metadata/{path:.*}

resource-wide template parameters
parameter value description

identityKey

long

path

string

Methods

GET

available response representations:

/users/{identityKey}/folders/personal/version

resource-wide template parameters
parameter value description

identityKey

long

Methods

GET

available response representations:

/users/{identityKey}/folders/group/{groupKey}

resource-wide template parameters
parameter value description

identityKey

long

groupKey

long

Methods

GET

available response representations:

PUT

available response representations:

PUT

acceptable request representations:

available response representations:

POST

available response representations:

POST

acceptable request representations:

available response representations:

/users/{identityKey}/folders/group/{groupKey}/{path:.*}

resource-wide template parameters
parameter value description

identityKey

long

groupKey

long

path

string

Methods

GET

available response representations:

POST

available response representations:

POST

acceptable request representations:

available response representations:

PUT

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

available response representations:

DELETE

available response representations:

/users/{identityKey}/folders/group/{groupKey}/metadata/{path:.*}

resource-wide template parameters
parameter value description

identityKey

long

groupKey

long

path

string

Methods

GET

available response representations:

/users/{identityKey}/folders/group/{groupKey}/version

resource-wide template parameters
parameter value description

identityKey

long

groupKey

long

Methods

GET

available response representations:

/users/{identityKey}/courses

resource-wide template parameters
parameter value description

identityKey

long

Methods

/users/{identityKey}/courses/my?start&limit

resource-wide template parameters
parameter value description

identityKey

long

Methods

GET

Retrieves the list of "My entries" but limited to courses.

request query parameters
parameter value description

start

int

Default: 0

The first result

limit

int

Default: 25

Max result

available response representations:

available response representations:

/users/{identityKey}/courses/teached?start&limit

resource-wide template parameters
parameter value description

identityKey

long

Methods

GET

Retrieves the list of "My supervised courses" but limited to courses.

request query parameters
parameter value description

start

int

Default: 0

The first result

limit

int

Default: 25

Max result

available response representations:

available response representations:

/users/{identityKey}/courses/favorite?start&limit

resource-wide template parameters
parameter value description

identityKey

long

Methods

GET

Retrieves the list of my favorite courses.

request query parameters
parameter value description

start

int

Default: 0

The first result

limit

int

Default: 25

Max result

available response representations:

available response representations:

/users/{identityKey}/groups?start&limit&externalId&managed

resource-wide template parameters
parameter value description

identityKey

long

Methods

GET

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

externalId

string

managed

boolean

available response representations:

/users/{identityKey}/groups/owner?start&limit&externalId&managed

resource-wide template parameters
parameter value description

identityKey

long

Methods

GET

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

externalId

string

managed

boolean

available response representations:

/users/{identityKey}/groups/participant?start&limit&externalId&managed

resource-wide template parameters
parameter value description

identityKey

long

Methods

GET

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

externalId

string

managed

boolean

available response representations:

/users/{identityKey}/groups/infos?start&limit&externalId&managed

resource-wide template parameters
parameter value description

identityKey

long

Methods

GET

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

externalId

string

managed

boolean

available response representations:

/repo/courses/{courseId}/elements/contact?parentNodeId&position&shortTitle&longTitle&objectives&visibilityExpertRules&accessExpertRules&coaches&participants&groups&areas&to&defaultSubject&defaultBody

Description:<br> This handles the contact building block. <P> Initial Date: 10 mai 2010 <br>

resource-wide template parameters
parameter value description

courseId

long

Methods

PUT

This attaches a contact element onto a given course, the element will be inserted underneath the supplied parentNodeId

request query parameters
parameter value description

parentNodeId

string

The node's id which will be the parent of this structure

position

int

The node's position relative to its sibling nodes (optional)

shortTitle

string

Default: undefined

The node short title

longTitle

string

Default: undefined

The node long title

objectives

string

Default: undefined

The node learning objectives

visibilityExpertRules

string

The rules to view the node (optional)

accessExpertRules

string

The rules to access the node (optional)

coaches

boolean

Default: false

Send to coaches (true/false)

participants

boolean

Default: false

Send to participants (true/false)

groups

string

A list of learning groups (list of keys)

areas

string

A list of learning areas (list of keys)

to

string

The list of e-mail address

defaultSubject

string

The default subject

defaultBody

string

The default body text

available response representations:

available response representations:

available response representations:

POST

This attaches a contact element onto a given course, the element will be inserted underneath the supplied parentNodeId

acceptable request representations:

available response representations:

available response representations:

available response representations:

/repo/wikis

The Wikis Webservice.<br /> OO-112

Methods

GET

get list of repo-entry wikis. Group-Wikis are not listed!

available response representations:

/repo/wikis/{wikiKey}

The Wiki Webservice<br /> allows the export of "normal" wikis ( in contrast to group-wikis) OO-112

resource-wide template parameters
parameter value description

wikiKey

string

part of the REST path, the resourceable-id / repo-entry-key / softkey of the wiki resource.

Methods

GET

will export the specified wiki (which must be a repo-entry-wiki) to a CP and serve as zip-file.<br />

available response representations:

/repo/courses/{courseId}/db/{category}

Description:<br> Access the custom dbs of a course <P> Initial Date: *7 apr. 2010 <br>

Methods

/repo/courses/{courseId}/db/{category}/values/{name}

resource-wide template parameters
parameter value description

name

string

The name of the key value pair

category

string

The name of the database

courseId

long

The course resourceable's id

Methods

GET

Retrieve a value of an authenticated user.

available response representations:

available response representations:

GET

Retrieve a value of an authenticated user.

available response representations:

available response representations:

PUT

Put a new value for an authenticated user.

request query parameters
parameter value description

value

string

The value of the key value pair

available response representations:

POST

Update a value for an authenticated user.

acceptable request representations:

available response representations:

DELETE

Delete a value for an authenticated user.

available response representations:

available response representations:

available response representations:

/repo/courses/{courseId}/db/{category}/values

resource-wide template parameters
parameter value description

category

string

The name of the database

courseId

long

The course resourceable's id

Methods

GET

Retrieve all values of the authenticated user

available response representations:

POST

Update a value for an authenticated user.

acceptable request representations:

available response representations:

PUT

Put a new value for an authenticated user.

acceptable request representations:

available response representations:

/repo/courses/{courseId}/db/{category}/version

Methods

GET

Retrieves the version of the Course DB Web Service.

available response representations:

/repo/courses/{courseId}/db/{category}/values/{name}/delete

resource-wide template parameters
parameter value description

name

string

The name of the key value pair

category

string

The name of the database

courseId

long

The course resourceable's id

Methods

POST

Fallbakc method for the browsers

available response representations:

available response representations:

available response representations:

/repo/courses/{resourceKey}/certificates

Initial date: 17.11.2014<br>

Methods

/repo/courses/{resourceKey}/certificates/{identityKey}

resource-wide template parameters
parameter value description

resourceKey

long

The primary key of the resource of the repository entry of the course.

identityKey

long

The owner of the certificate

Methods

GET

Return the certificate as PDF file.

available response representations:

available response representations:

available response representations:

HEAD

available response representations:

DELETE

available response representations:

PUT

Generate a new certificate.

request query parameters
parameter value description

score

float

The score which appears in the certificate

passed

boolean

The passed/failed which appears in the certificate (true/false)

creationDate

string

The date of the certification

available response representations:

available response representations:

available response representations:

available response representations:

POST

Upload a new certificate.

available response representations:

available response representations:

available response representations:

/repo/courses/{courseId}/elements

Methods

/repo/courses/{courseId}/elements/version

Methods

GET

available response representations:

/repo/courses/{courseId}/elements/structure

resource-wide template parameters
parameter value description

courseId

long

Methods

POST

available response representations:

PUT

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

displayType

string

Default: toc

available response representations:

/repo/courses/{courseId}/elements/singlepage/{nodeId}

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

Methods

POST

available response representations:

/repo/courses/{courseId}/elements/singlepage

resource-wide template parameters
parameter value description

courseId

long

Methods

POST

acceptable request representations:

available response representations:

POST

available response representations:

PUT

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

filename

string

path

string

available response representations:

PUT

available response representations:

/repo/courses/{courseId}/elements/task/{nodeId}

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

Methods

POST

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/task

resource-wide template parameters
parameter value description

courseId

long

Methods

POST

acceptable request representations:

available response representations:

PUT

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

text

string

points

float

available response representations:

/repo/courses/{courseId}/elements/structure/{nodeId}

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

Methods

POST

available response representations:

/repo/courses/{courseId}/elements/test/{nodeId}

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

Methods

POST

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/test

resource-wide template parameters
parameter value description

courseId

long

Methods

POST

acceptable request representations:

available response representations:

PUT

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

testResourceableId

long

available response representations:

/repo/courses/{courseId}/elements/assessment/{nodeId}

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

Methods

POST

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/assessment

resource-wide template parameters
parameter value description

courseId

long

Methods

POST

acceptable request representations:

available response representations:

PUT

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

available response representations:

/repo/courses/{courseId}/elements/wiki/{nodeId}

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

Methods

POST

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/wiki?parentNodeId&position&shortTitle&longTitle&objectives&visibilityExpertRules&accessExpertRules&wikiResourceableId

resource-wide template parameters
parameter value description

courseId

long

Methods

POST

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

wikiResourceableId

long

available response representations:

PUT

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

wikiResourceableId

long

available response representations:

/repo/courses/{courseId}/elements/blog/{nodeId}

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

Methods

POST

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/blog?parentNodeId&position&shortTitle&longTitle&objectives&visibilityExpertRules&accessExpertRules&repoEntry

resource-wide template parameters
parameter value description

courseId

long

Methods

POST

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

repoEntry

long

available response representations:

PUT

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

repoEntry

long

available response representations:

/repo/courses/{courseId}/elements/survey?parentNodeId&position&shortTitle&longTitle&objectives&visibilityExpertRules&accessExpertRules&surveyResourceableId

resource-wide template parameters
parameter value description

courseId

long

Methods

POST

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

surveyResourceableId

long

available response representations:

PUT

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

surveyResourceableId

long

available response representations:

/repo/courses/{courseId}/elements/survey/{nodeId}

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

Methods

POST

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/externalpage/{nodeId}

resource-wide template parameters
parameter value description

parentNodeId

string

courseId

long

Methods

POST

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/externalpage?parentNodeId&position&shortTitle&longTitle&objectives&visibilityExpertRules&accessExpertRules&url

resource-wide template parameters
parameter value description

courseId

long

Methods

POST

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

url

string

available response representations:

PUT

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

url

string

available response representations:

/repo/courses/{courseId}/elements/task/{nodeId}/file

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

Methods

POST

available response representations:

PUT

available response representations:

/repo/courses/{courseId}/elements/task/{nodeId}/configuration?enableAssignment&taskAssignmentType&taskAssignmentText&enableTaskPreview&enableTaskDeselect&onlyOneUserPerTask&enableDropbox&enableDropboxConfirmationMail&dropboxConfirmationText&enableReturnbox&enableScoring&grantScoring&scoreMin&scoreMax&grantPassing&scorePassingThreshold&enableCommentField&commentForUser&commentForCoaches&enableSolution&accessExpertRuleTask&accessExpertRuleDropbox&accessExpertRuleReturnbox&accessExpertRuleScoring&accessExpertRuleSolution

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

Methods

POST

request query parameters
parameter value description

enableAssignment

boolean

taskAssignmentType

string

taskAssignmentText

string

enableTaskPreview

boolean

enableTaskDeselect

boolean

onlyOneUserPerTask

boolean

enableDropbox

boolean

enableDropboxConfirmationMail

boolean

dropboxConfirmationText

string

enableReturnbox

boolean

enableScoring

boolean

grantScoring

boolean

scoreMin

float

scoreMax

float

grantPassing

boolean

scorePassingThreshold

float

enableCommentField

boolean

commentForUser

string

commentForCoaches

string

enableSolution

boolean

accessExpertRuleTask

string

accessExpertRuleDropbox

string

accessExpertRuleReturnbox

string

accessExpertRuleScoring

string

accessExpertRuleSolution

string

available response representations:

PUT

request query parameters
parameter value description

enableAssignment

boolean

taskAssignmentType

string

taskAssignmentText

string

enableTaskPreview

boolean

enableTaskDeselect

boolean

onlyOneUserPerTask

boolean

enableDropbox

boolean

enableDropboxConfirmationMail

boolean

dropboxConfirmationText

string

enableReturnbox

boolean

enableScoring

boolean

grantScoring

boolean

scoreMin

float

scoreMax

float

grantPassing

boolean

scorePassingThreshold

float

enableCommentField

boolean

commentForUser

string

commentForCoaches

string

enableSolution

boolean

accessExpertRuleTask

string

accessExpertRuleDropbox

string

accessExpertRuleReturnbox

string

accessExpertRuleScoring

string

accessExpertRuleSolution

string

available response representations:

GET

available response representations:

/repo/courses/{courseId}/elements/survey/{nodeId}/configuration?allowCancel&allowNavigation&allowSuspend&sequencePresentation&showNavigation&showQuestionTitle&showSectionsOnly

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

Methods

POST

request query parameters
parameter value description

allowCancel

boolean

Default: false

allowNavigation

boolean

Default: false

allowSuspend

boolean

Default: false

sequencePresentation

string

Default: itemPage

showNavigation

boolean

Default: true

showQuestionTitle

boolean

Default: true

showSectionsOnly

boolean

Default: false

available response representations:

PUT

request query parameters
parameter value description

allowCancel

boolean

Default: false

allowNavigation

boolean

Default: false

allowSuspend

boolean

Default: false

sequencePresentation

string

Default: itemPage

showNavigation

boolean

Default: true

showQuestionTitle

boolean

Default: true

showSectionsOnly

boolean

Default: false

available response representations:

GET

available response representations:

/repo/courses/{courseId}/elements/test/{nodeId}/configuration?allowCancel&allowNavigation&allowSuspend&numAttempts&sequencePresentation&showNavigation&showQuestionTitle&showResultsAfterFinish&showResultsDependendOnDate&showResultsOnHomepage&showScoreInfo&showQuestionProgress&showScoreProgress&showSectionsOnly&summaryPresentation&startDate&endDate

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

Methods

POST

request query parameters
parameter value description

allowCancel

boolean

Default: false

allowNavigation

boolean

Default: false

allowSuspend

boolean

Default: false

numAttempts

int

Default: 0

sequencePresentation

string

Default: itemPage

showNavigation

boolean

Default: true

showQuestionTitle

boolean

Default: true

showResultsAfterFinish

boolean

Default: true

showResultsDependendOnDate

boolean

Default: false

showResultsOnHomepage

boolean

Default: false

showScoreInfo

boolean

Default: true

showQuestionProgress

boolean

Default: true

showScoreProgress

boolean

Default: true

showSectionsOnly

boolean

Default: false

summaryPresentation

string

Default: summaryCompact

startDate

long

endDate

long

available response representations:

PUT

request query parameters
parameter value description

allowCancel

boolean

Default: false

allowNavigation

boolean

Default: false

allowSuspend

boolean

Default: false

numAttempts

int

Default: 0

sequencePresentation

string

Default: itemPage

showNavigation

boolean

Default: true

showQuestionTitle

boolean

Default: true

showResultsAfterFinish

boolean

Default: true

showResultsDependendOnDate

boolean

Default: false

showResultsOnHomepage

boolean

Default: false

showScoreInfo

boolean

Default: true

showQuestionProgress

boolean

Default: true

showScoreProgress

boolean

Default: true

showSectionsOnly

boolean

Default: false

summaryPresentation

string

Default: summaryCompact

startDate

long

endDate

long

available response representations:

GET

available response representations:

/repo/courses/{courseId}/elements/{nodeId}

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

Methods

GET

available response representations:

/repo/forums

Description:<br> Web service to manage forums. <P> Initial Date: 26 aug. 2010 <br>

Methods

/repo/forums/version

Methods

GET

The version of the Forum Web Service

available response representations:

/repo/forums/{forumKey}

Description:<br> Web service to manage a forum. <P> Initial Date: 20 apr. 2010 <br>

resource-wide template parameters
parameter value description

forumKey

long

The key of the forum

Methods

GET

Retrieves the forum.

available response representations:

available response representations:

available response representations:

/repo/forums/{forumKey}/threads?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

forumKey

long

The key of the forum

Methods

GET

Retrieves the threads in the forum

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name,creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

available response representations:

available response representations:

PUT

Creates a new thread in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

available response representations:

available response representations:

POST

Creates a new thread in the forum of the course node

acceptable request representations:

available response representations:

available response representations:

available response representations:

/repo/forums/{forumKey}/posts/{threadKey}?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

forumKey

long

The key of the forum

threadKey

long

The key of the thread

Methods

GET

Retrieves the messages in the thread

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name, creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

available response representations:

available response representations:

/repo/forums/{forumKey}/posts/{messageKey}

resource-wide template parameters
parameter value description

forumKey

long

The key of the forum

messageKey

long

The id of the reply message

Methods

POST

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

available response representations:

available response representations:

PUT

Creates a new reply in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

available response representations:

available response representations:

PUT

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

available response representations:

available response representations:

/repo/forums/{forumKey}/posts/{messageKey}/attachments

resource-wide template parameters
parameter value description

forumKey

long

The key of the forum

messageKey

long

The key of the message

Methods

GET

Retrieves the attachments of the message

available response representations:

available response representations:

POST

Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.

available response representations:

available response representations:

POST

Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.

acceptable request representations:

available response representations:

available response representations:

PUT

Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.

acceptable request representations:

available response representations:

available response representations:

/repo/forums/{forumKey}/posts/{messageKey}/attachments/{filename}

resource-wide template parameters
parameter value description

forumKey

long

The key of the forum

messageKey

long

The identity key of the user being searched

filename

string

The name of the attachment

Methods

GET

Retrieves the attachment of the message

available response representations:

available response representations:

/groups?externalId&managed

Methods

GET

request query parameters
parameter value description

externalId

string

managed

boolean

available response representations:

PUT

acceptable request representations:

available response representations:

/groups/{groupKey}/news

resource-wide template parameters
parameter value description

groupKey

long

Methods

DELETE

available response representations:

GET

available response representations:

POST

acceptable request representations:

available response representations:

/groups/{groupKey}/configuration

resource-wide template parameters
parameter value description

groupKey

long

Methods

POST

acceptable request representations:

available response representations:

/groups/{groupKey}/owners/{identityKey}

resource-wide template parameters
parameter value description

identityKey

long

groupKey

long

Methods

PUT

available response representations:

DELETE

available response representations:

/groups/{groupKey}

resource-wide template parameters
parameter value description

groupKey

long

Methods

POST

acceptable request representations:

available response representations:

GET

available response representations:

DELETE

available response representations:

/groups/version

Methods

GET

available response representations:

/groups/{groupKey}/infos

resource-wide template parameters
parameter value description

groupKey

long

Methods

GET

available response representations:

/groups/{groupKey}/owners

resource-wide template parameters
parameter value description

groupKey

long

Methods

GET

available response representations:

/groups/{groupKey}/participants

resource-wide template parameters
parameter value description

groupKey

long

Methods

GET

available response representations:

/groups/{groupKey}/participants/{identityKey}

resource-wide template parameters
parameter value description

identityKey

long

groupKey

long

Methods

PUT

available response representations:

DELETE

available response representations:

/groups/{groupKey}/wiki

The Group Wiki Webservice<br /> allows the export of group wikis

resource-wide template parameters
parameter value description

groupKey

long

Methods

GET

will export the wiki from the current group to a CP and serve as zip-file.<br />

available response representations:

/groups/{groupKey}/folder

resource-wide template parameters
parameter value description

groupKey

long

Methods

GET

available response representations:

PUT

available response representations:

PUT

acceptable request representations:

available response representations:

POST

available response representations:

POST

acceptable request representations:

available response representations:

/groups/{groupKey}/folder/{path:.*}

resource-wide template parameters
parameter value description

groupKey

long

path

string

Methods

GET

available response representations:

POST

available response representations:

POST

acceptable request representations:

available response representations:

PUT

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

available response representations:

DELETE

available response representations:

/groups/{groupKey}/folder/metadata/{path:.*}

resource-wide template parameters
parameter value description

groupKey

long

path

string

Methods

GET

available response representations:

/groups/{groupKey}/folder/version

resource-wide template parameters
parameter value description

groupKey

long

Methods

GET

available response representations:

/groups/{groupKey}/forum

Description:<br> Web service to manage a forum. <P> Initial Date: 20 apr. 2010 <br>

resource-wide template parameters
parameter value description

groupKey

long

Methods

GET

Retrieves the forum.

available response representations:

available response representations:

available response representations:

/groups/{groupKey}/forum/threads?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

groupKey

long

Methods

GET

Retrieves the threads in the forum

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name,creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

available response representations:

available response representations:

PUT

Creates a new thread in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

available response representations:

available response representations:

POST

Creates a new thread in the forum of the course node

acceptable request representations:

available response representations:

available response representations:

available response representations:

/groups/{groupKey}/forum/posts/{threadKey}?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

groupKey

long

threadKey

long

The key of the thread

Methods

GET

Retrieves the messages in the thread

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name, creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

available response representations:

available response representations:

/groups/{groupKey}/forum/posts/{messageKey}

resource-wide template parameters
parameter value description

groupKey

long

messageKey

long

The id of the reply message

Methods

POST

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

available response representations:

available response representations:

PUT

Creates a new reply in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

available response representations:

available response representations:

PUT

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

available response representations:

available response representations:

/groups/{groupKey}/forum/posts/{messageKey}/attachments

resource-wide template parameters
parameter value description

groupKey

long

messageKey

long

The key of the message

Methods

GET

Retrieves the attachments of the message

available response representations:

available response representations:

POST

Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.

available response representations:

available response representations:

POST

Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.

acceptable request representations:

available response representations:

available response representations:

PUT

Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.

acceptable request representations:

available response representations:

available response representations:

/groups/{groupKey}/forum/posts/{messageKey}/attachments/{filename}

resource-wide template parameters
parameter value description

groupKey

long

messageKey

long

The identity key of the user being searched

filename

string

The name of the attachment

Methods

GET

Retrieves the attachment of the message

available response representations:

available response representations:

/notifications?date&type

<h3>Description:</h3> REST API for notifications <p> Initial Date: 25 aug 2010 <br>

Methods

GET

Retrieves the notification of the logged in user.

request query parameters
parameter value description

date

string

The date (optional)

type

string

The type of notifications (User, Forum...) (optional)

available response representations:

available response representations:

/notifications/subscribers

Methods

PUT

acceptable request representations:

available response representations:

/notifications/subscribers/{subscriberKey}

resource-wide template parameters
parameter value description

subscriberKey

long

Methods

DELETE

available response representations:

/notifications/publisher/{ressourceName}/{ressourceId}/{subIdentifier}

resource-wide template parameters
parameter value description

ressourceId

long

subIdentifier

string

ressourceName

string

Methods

GET

Get the publisher by resource name and id + sub identifier.

available response representations:

available response representations:

available response representations:

/notifications/subscribers/{ressourceName}/{ressourceId}/{subIdentifier}

resource-wide template parameters
parameter value description

ressourceId

long

subIdentifier

string

ressourceName

string

Methods

GET

available response representations:

/users/{identityKey}/forums

Description:<br> <P> Initial Date: 6 déc. 2011 <br>

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

Methods

GET

Retrieves a list of forums on a user base. All forums of groups where the user is participant/tutor + all forums in course where the user is a participant (owner, tutor or participant)

available response representations:

available response representations:

/users/{identityKey}/forums/course/{courseKey}/{courseNodeId}

Description:<br> Web service to manage a forum. <P> Initial Date: 20 apr. 2010 <br>

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

courseKey

long

courseNodeId

string

Methods

GET

Retrieves the forum.

available response representations:

available response representations:

available response representations:

/users/{identityKey}/forums/course/{courseKey}/{courseNodeId}/threads?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

courseKey

long

courseNodeId

string

Methods

GET

Retrieves the threads in the forum

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name,creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

available response representations:

available response representations:

PUT

Creates a new thread in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

available response representations:

available response representations:

POST

Creates a new thread in the forum of the course node

acceptable request representations:

available response representations:

available response representations:

available response representations:

/users/{identityKey}/forums/course/{courseKey}/{courseNodeId}/posts/{threadKey}?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

courseKey

long

courseNodeId

string

threadKey

long

The key of the thread

Methods

GET

Retrieves the messages in the thread

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name, creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

available response representations:

available response representations:

/users/{identityKey}/forums/course/{courseKey}/{courseNodeId}/posts/{messageKey}

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

courseKey

long

courseNodeId

string

messageKey

long

The id of the reply message

Methods

POST

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

available response representations:

available response representations:

PUT

Creates a new reply in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

available response representations:

available response representations:

PUT

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

available response representations:

available response representations:

/users/{identityKey}/forums/course/{courseKey}/{courseNodeId}/posts/{messageKey}/attachments

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

courseKey

long

courseNodeId

string

messageKey

long

The key of the message

Methods

GET

Retrieves the attachments of the message

available response representations:

available response representations:

POST

Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.

available response representations:

available response representations:

POST

Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.

acceptable request representations:

available response representations:

available response representations:

PUT

Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.

acceptable request representations:

available response representations:

available response representations:

/users/{identityKey}/forums/course/{courseKey}/{courseNodeId}/posts/{messageKey}/attachments/{filename}

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

courseKey

long

courseNodeId

string

messageKey

long

The identity key of the user being searched

filename

string

The name of the attachment

Methods

GET

Retrieves the attachment of the message

available response representations:

available response representations:

/users/{identityKey}/forums/group/{groupKey}

Description:<br> Web service to manage a forum. <P> Initial Date: 20 apr. 2010 <br>

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

groupKey

long

Methods

GET

Retrieves the forum.

available response representations:

available response representations:

available response representations:

/users/{identityKey}/forums/group/{groupKey}/threads?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

groupKey

long

Methods

GET

Retrieves the threads in the forum

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name,creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

available response representations:

available response representations:

PUT

Creates a new thread in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

available response representations:

available response representations:

POST

Creates a new thread in the forum of the course node

acceptable request representations:

available response representations:

available response representations:

available response representations:

/users/{identityKey}/forums/group/{groupKey}/posts/{threadKey}?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

groupKey

long

threadKey

long

The key of the thread

Methods

GET

Retrieves the messages in the thread

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name, creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

available response representations:

available response representations:

/users/{identityKey}/forums/group/{groupKey}/posts/{messageKey}

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

groupKey

long

messageKey

long

The id of the reply message

Methods

POST

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

available response representations:

available response representations:

PUT

Creates a new reply in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

available response representations:

available response representations:

PUT

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

available response representations:

available response representations:

/users/{identityKey}/forums/group/{groupKey}/posts/{messageKey}/attachments

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

groupKey

long

messageKey

long

The key of the message

Methods

GET

Retrieves the attachments of the message

available response representations:

available response representations:

POST

Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.

available response representations:

available response representations:

POST

Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.

acceptable request representations:

available response representations:

available response representations:

PUT

Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.

acceptable request representations:

available response representations:

available response representations:

/users/{identityKey}/forums/group/{groupKey}/posts/{messageKey}/attachments/{filename}

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

groupKey

long

messageKey

long

The identity key of the user being searched

filename

string

The name of the attachment

Methods

GET

Retrieves the attachment of the message

available response representations:

available response representations:

/contacts?start&limit

Description:<br> <P> Initial Date: 21 oct. 2011 <br>

Methods

GET

Retrieve the contacts of the logged in identity.

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

available response representations:

/openmeetings

Initial date: 13.11.2012<br>

Methods

/openmeetings/{identityToken}/portrait

resource-wide template parameters
parameter value description

identityToken

string

The identity key of the user being searched

Methods

GET

Retrieves the portrait of an user

available response representations:

available response representations:

/repo/courses/infos?start&limit

Methods

GET

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

available response representations:

/repo/courses/infos/{courseId}

resource-wide template parameters
parameter value description

courseId

long

Methods

GET

available response representations:

/i18n

Methods

/i18n/{package}/{key}?locale

resource-wide template parameters
parameter value description

package

string

key

string

Methods

GET

request query parameters
parameter value description

locale

string

available response representations:

/i18n/version

Methods

GET

available response representations:

/repo/courses/{courseId}/assessments

resource-wide template parameters
parameter value description

courseId

long

Methods

GET

available response representations:

/repo/courses/{courseId}/assessments/version

resource-wide template parameters
parameter value description

courseId

long

Methods

GET

available response representations:

/repo/courses/{courseId}/assessments/users/{identityKey}

resource-wide template parameters
parameter value description

courseId

long

identityKey

long

courseId

long

Methods

GET

available response representations:

/repo/courses/{courseId}/assessments/{nodeId}

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

/repo/courses/{courseId}/assessments/{nodeId}/users/{identityKey}

resource-wide template parameters
parameter value description

courseId

long

identityKey

long

courseId

long

nodeId

long

Methods

GET

available response representations:

/repo/courses/{courseId}/elements/folder

Description:<br> <P> Initial Date: 6 févr. 2012 <br>

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

Methods

GET

Retrieves metadata of the course node

available response representations:

available response representations:

available response representations:

PUT

This attaches a Folder Element onto a given course. The element will be inserted underneath the supplied parentNodeId.

request query parameters
parameter value description

parentNodeId

string

The node's id which will be the parent of this folder

position

int

The node's position relative to its sibling nodes (optional)

shortTitle

string

Default: undefined

The node short title

longTitle

string

Default: undefined

The node long title

objectives

string

Default: undefined

The node learning objectives

visibilityExpertRules

string

The rules to view the node (optional)

downloadExpertRules

string

The rules to download files (optional)

uploadExpertRules

string

The rules to upload files (optional)

available response representations:

available response representations:

available response representations:

POST

This attaches a Folder Element onto a given course. The element will be inserted underneath the supplied parentNodeId.

acceptable request representations:

available response representations:

available response representations:

available response representations:

/repo/courses/{courseId}/elements/folder/{nodeId}

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

The course resourceable's id

nodeId

string

The node's id

Methods

POST

This updates a Folder Element onto a given course.

acceptable request representations:

available response representations:

available response representations:

available response representations:

GET

Retrieves metadata of the course node

available response representations:

available response representations:

available response representations:

/repo/courses/{courseId}/elements/folder/{nodeId}/files

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

nodeId

string

Methods

GET

available response representations:

PUT

available response representations:

PUT

acceptable request representations:

available response representations:

POST

available response representations:

POST

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/folder/{nodeId}/files/{path:.*}

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

nodeId

string

path

string

Methods

GET

available response representations:

POST

available response representations:

POST

acceptable request representations:

available response representations:

PUT

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

available response representations:

DELETE

available response representations:

/repo/courses/{courseId}/elements/folder/{nodeId}/files/metadata/{path:.*}

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

nodeId

string

path

string

Methods

GET

available response representations:

/repo/courses/{courseId}/elements/folder/{nodeId}/files/version

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

nodeId

string

Methods

GET

available response representations:

/users/{username}/auth

This web service handles functionalities related to authentication credentials of users.

resource-wide template parameters
parameter value description

username

string

The username of the user to retrieve authentication

Methods

PUT

Creates and persists an authentication

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

GET

Returns all user authentications

available response representations:

available response representations:

available response representations:

/users/{username}/auth/{authKey}

resource-wide template parameters
parameter value description

username

string

The username of the user to retrieve authentication

authKey

long

The authentication key identifier

username

string

The username of the user

Methods

DELETE

Deletes an authentication from the system

available response representations:

available response representations:

available response representations:

/users/{username}/auth/version

resource-wide template parameters
parameter value description

username

string

The username of the user to retrieve authentication

Methods

GET

The version of the User Authentication Web Service

available response representations:

/users/{username}/auth/password

resource-wide template parameters
parameter value description

username

string

The username of the user to retrieve authentication

username

string

The username of the user to change the password

Methods

POST

Change the password of a user.

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

/repo/courses?start&limit&managed&externalId&externalRef&repositoryEntryKey

Methods

GET

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

managed

boolean

externalId

string

externalRef

string

repositoryEntryKey

string

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

request query parameters
parameter value description

shortTitle

string

title

string

displayName

string

description

string

softKey

string

status

string

allUsers

boolean

guests

boolean

access

int

membersOnly

boolean

externalId

string

externalRef

string

authors

string

location

string

managedFlags

string

sharedFolderSoftKey

string

copyFrom

long

initialAuthor

long

setAuthor

boolean

Default: true

organisationKey

long

available response representations:

POST

request query parameters
parameter value description

ownerUsername

string

available response representations:

/repo/courses/version

Methods

GET

available response representations:

/repo/courses/{courseId}

resource-wide template parameters
parameter value description

courseId

long

Methods

GET

available response representations:

DELETE

available response representations:

/repo/courses/{courseId}/configuration

resource-wide template parameters
parameter value description

courseId

long

courseId

long

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

/repo/courses/{courseId}/resource

resource-wide template parameters
parameter value description

courseId

long

Methods

GET

available response representations:

/repo/courses/{courseId}/publish?locale&access&membersOnly&status&allUsers&guests

resource-wide template parameters
parameter value description

courseId

long

Methods

POST

request query parameters
parameter value description

locale

string

access

int

membersOnly

boolean

status

string

allUsers

boolean

guests

boolean

available response representations:

/repo/courses/{courseId}/tutors/{identityKey}

resource-wide template parameters
parameter value description

courseId

long

identityKey

long

Methods

PUT

available response representations:

DELETE

available response representations:

/repo/courses/{courseId}/tutors

resource-wide template parameters
parameter value description

courseId

long

Methods

GET

available response representations:

PUT

acceptable request representations:

available response representations:

/repo/courses/{courseId}/participants

resource-wide template parameters
parameter value description

courseId

long

Methods

GET

available response representations:

PUT

acceptable request representations:

available response representations:

/repo/courses/{courseId}/participants/{identityKey}

resource-wide template parameters
parameter value description

courseId

long

identityKey

long

Methods

PUT

available response representations:

DELETE

available response representations:

/repo/courses/{courseId}/organisations/{organisationKey}

resource-wide template parameters
parameter value description

courseId

long

organisationKey

long

Methods

PUT

available response representations:

DELETE

available response representations:

/repo/courses/{courseId}/file

resource-wide template parameters
parameter value description

courseId

long

Methods

GET

available response representations:

/repo/courses/{courseId}/status

resource-wide template parameters
parameter value description

courseId

long

Methods

POST

acceptable request representations:

available response representations:

/repo/courses/{courseId}/runstructure

resource-wide template parameters
parameter value description

courseId

long

Methods

GET

available response representations:

/repo/courses/{courseId}/editortreemodel

resource-wide template parameters
parameter value description

courseId

long

Methods

GET

available response representations:

/repo/courses/{courseId}/authors/{identityKey}

resource-wide template parameters
parameter value description

courseId

long

identityKey

long

Methods

GET

available response representations:

PU