REST Method Definitions

The following table shows a list of all the public methods exposed by the C# webservice of OPG Android, and the corresponding REST interface implementation.

Note that as the 'authenticationContext' and 'trackingData' parameters are included in all method calls (and hence are also defined in the query section of the URI of all REST methods), they are omitted from the table. Names of method parameters are highlighted in magenta, and sample values of method parameters are highlighted in blue.

Data Layer Method HTTP Method URI Message Body
ValidationResult ObjectOwnerValidate(String objectOwner) GET /Validations/ObjectOwner/XYZON
ValidationResult ObjectNameValidate(String objectName) GET /Validations/ObjectName/ORDER_STATUSES
ValidationResult ObjectTypeValidate(String objectType) GET /Validations/ObjectType/Stored Procedure
ValidationResult RoleToUserMapValidate(String role, String user) GET /Validations/RoleToUserMap/XYZON_READ_ROLE/NEW_USER
String GetDefaultObjectOwner() GET /DefaultObjectOwner
void SetDefaultObjectOwner(String defaultObjectOwner) PUT /DefaultObjectOwner "XYZON"
List<String> GetObjectTypes() GET /ObjectTypes
List<OracleObjectPermissionSet> GetObjects() GET /Objects
void RemoveObjectPermissionSet(String objectName) DELETE /Objects/ORDER_STATUSES
void AddObjectPermissionSet(String objectName, String objectType, String objectOwner, bool addFlag, bool removeFlag, List<RoleToPermissionMap> objectPermissions) POST /Objects {"objectPermissions":[],
"removeFlag":false,
"objectOwner":"XYZON",
"addFlag":true,
"objectType":"Stored Procedure",
"objectName":"SP_ORDERS_SUMMARY"}
void SetAddFlag(String objectName, bool addFlagValue) PUT Objects/ORDER_STATUSES/AddFlag "true"
void SetRemoveFlag(String objectName, bool removeFlagValue) PUT Objects/ORDER_STATUSES/RemoveFlag "true"
List<String> GetRoles() GET /Roles
List<String> GetPermissions(String objectType) GET /Permissions/TABLE?entity=objectType
List<String> GetPermissionsForObject(String objectName, String role) GET /Permissions/ORDER_STATUSES/XYZON_READ_ROLE?entity=object,role
void AddPermission(String objectName, String role, String permission) POST /Permissions {"role":"XYZON_POWER_ROLE",
"objectName":"APPLICATION_STATS",
"permission":"DELETE"}
void RemovePermission(String objectName, String role, String permission) DELETE /Permissions/ORDER_STATUSES/XYZON_READ_ROLE/SELECT
List<RoleToUserMap> GetMasterRoleToUserMapCollection() GET /RoleToUserMappings
void AddRoleToUserMap(String role, String user) POST /RoleToUserMappings {"user":"NEW_USER",
"role":"XYZON_READ_ROLE"}
void RemoveRoleToUserMap(String role, String user) DELETE /RoleToUserMappings/XYZON_READ_ROLE/NEW_USER
List<String> RoleGetReferencingObjects(String role) GET /ReferencingObjects/XYZON_READ_ROLE?entity=role
String CreatePrivilegeScript(String scriptType, bool generateRevokeStatements) GET /PrivilegeScripts/Rollout?generateRevokeStatements=true
String CreateSynonymScript(String scriptType) GET /SynonymScripts/Rollback

Return to the main page.