Versions Compared

Old Version 13

changes.mady.by.user Bruce Hoff

Saved on

compared with

New Version Current

changes.mady.by.user Bruce Hoff

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

keydescription
displayNameThe display name is used as the main header for the Controller HTML. By convention, each display name should have 'ServiceServices' as a suffix.
path

Each REST method has a Resource URL that is composed of three parts host, path, method:

http://<host>/<path>/<method>

  • host - is always 'repo-prod.sagebase.org'
  • path - can vary from service to service and is used for version and grouping.  Currently, there are three paths in use: 'repo/v1', 'auth/v1', and 'file/v1'
  • method - name of the REST method.

In the following example 'path' = 'repo/v1':

https://repo-prod.sagebase.org/repo/v1/accessApproval

...

Most REST calls require authentication of the caller.  When authentication is requirerequired, the 'userId' parameter is included in the method signature (see: line 20 above).  The caller does not provide the 'userId' directly, instead the Authentication filter processes the user's sessionToken or method signature and fills in the 'userId' parameter on the caller's behalf.  Therefore, we do not document the 'userId' parameter directly.  Instead, if the 'userId' parameter is part of the method signature, the method will be marked as 'Authentication Required'.  If the 'userId' parameter is not part of the method signature then the method will be marked as 'Authentication False'.

...