Module rest

Create a new user.

URL Format:

   /rest/user/

Parameters:

• self (enomalism2.REST.rest) - The method class.
• user_name (String) - The user_name attribute.
• password (String) - The password attribute.
• display_name (String) - The display_name attribute.
• email (String) - The email attribute.
• data (String) - The data attribute.

Returns: Dictionary

A dictionary containing the result of the action.

Decorators:

• @register_extension("user", allowed_methods= ['PUT'])

Raises:

• None - No exceptions are raised by this method.

Return a list of Enomalism users.

URL Format:

   /rest/user/list/

Parameters:

• self (enomalism2.REST.rest) - The method class.

Returns: Dictionary

A dictionary containing a list of users.

Decorators:

• @register_extension("user/list", allowed_methods= ['GET'])

Raises:

• None - No exceptions are raised by this method.

Retrieves or updates a user. If the current user does not have read permission on the usercontrol.rest module, a HTTP exception is raised. Similarily, if the current user is performing a delete action and does not have delete permission, the same exception is raised.

URL Format:

   /rest/user/<UUID>/

Parameters:

• self (enomalism2.REST.rest) - The method class.
• action (String) - The action to perform.

Returns: Dictionary

A dictionary containing the result of the action.

Decorators:

• @register_extension("user/*", allowed_methods= ['POST', 'GET', 'DELETE'])

Create a new group.

URL Format:

   /rest/group/

Parameters:

• self (enomalism2.REST.rest) - The method class.
• display_name (String) - The display_name attribute.
• group_name (String) - The group_name attribute.

Returns: Dictionary

A dictionary containing the result of the action.

Decorators:

• @register_extension("group", allowed_methods= ['PUT'])

Raises:

• None - No exceptions are raised by this method.

Return a list of Enomalism groups. If the current user does not have read permission on the usercontrol.rest module, a HTTP exception is raised.

URL Format:

   /rest/group/list/

Parameters:

• self (enomalism2.REST.rest) - The method class.

Returns: Dictionary

A dictionary containing all Enomalism groups.

Decorators:

• @register_extension("group/list", allowed_methods= ['GET'])

Raises:

• cherrypy.HTTPError - Raised when permission is denied.

Retrieves or updates a group. If the current user does not have read permission on the usercontrol.rest module, a HTTP exception is raised. Similarily, if the current user is performing a delete action and does not have delete permission, the same exception is raised.

URL Format:

   /rest/group/<UUID>/

Parameters:

• self (enomalism2.REST.rest) - The method class.
• action (String) - The action to perform.

Returns: Dictionary

A dictionary containing the result of the action.

Decorators:

• @register_extension("group/*", allowed_methods= ['POST', 'GET', 'DELETE'])

Raises:

• cherrypy.HTTPError - Raised when permission is denied.