Oracle® Retail Job Orchestration and Scheduler Cloud Service Implementation Guide Oracle® Retail Job Orchestration and Scheduler Cloud Service Implementation Guide Release 19.1.000 F31814-01 |
|
Previous |
Next |
The System Setting service is a RESTful service available in all JOS components (Job Admin, Process Flow and Scheduler) that provides endpoints to manage the system option parameters and the credentials to be used by the JOS. The system options are stored in the BDI_SYSTEM_OPTIONS table.
Table D-1 REST Resource Descriptions
REST Resource | HTTP Method | Description |
---|---|---|
/system-setting/system-options |
GET |
Gets all system options from BDI_SYSTEM_OPTIONS table |
/system-setting/system-options |
PUT |
Creates a system option in BDI_SYSTEM_OPTIONS table. Only admin user is allowed to perform this operation |
/system-setting/system-options |
POST |
Updates a system option in BDI_SYSTEM_OPTIONS table. Only admin user is allowed to perform this operation. |
/system-setting/system-options/{key} |
DELETE |
Deletes a system option from BDI_SYSETM_OPTIONS table. Only admin user is allowed to perform this operation. |
/system-setting/system-options/{key} |
GET |
Gets a system option from BDI_SYSTEM_OPTIONS table |
/system-setting/system-logs |
GET |
Gets system logs |
/system-setting/system-seed-data |
GET |
Get system seed data file |
/system-setting/system-seed-data/reset-after-bounce |
POST |
Resets system seed data after bounce |
/system-setting/system-seed-data/reset-now |
POST |
Resets system seed data now |
/system-setting/system-credentials |
GET |
Gets system credentials. Only admin user is allowed to perform this operation. |
/system-setting/system-credentials |
PUT |
Gets system credentials. Only admin user is allowed to perform this operation. |
/system-setting/system-credentials |
POST |
Gets system credentials. Only admin user is allowed to perform this operation. |
/system-setting/system-options/system-credentials |
PUT |
Creates system options and corresponding credentials |
/system-setting/system-options/system-credentials |
POST |
Updates system options and corresponding credentials |
/system-setting/system-options/system-credentials/{key} |
DELETE |
Deletes system options and corresponding credentials |
/system-setting/system-logs |
POST |
Updates system log level |
/system-setting/reset-cache |
POST |
Resets system option cache |
/system-setting/system-credentials/{key} |
DELETE |
Deletes system credentials. Only admin user is allowed to perform this operation. |
Here are examples of curl commands to list/create/update/delete system options for the Process Flow. These commands can be run for Job Admin and Scheduler as well. Create/update/delete commands can only be run by an administrator.
This command creates the reimappJobAdminBaseUrlUserAlias system option in the Process Flow.
curl --user userId:password -i -X PUT -H "Content-Type:application/json" http://server:port/bdi-process-flow/resources/system-setting/system-options
-d '{"key":"reimappJobAdminBaseUrlUserAlias" , "value":" GET_FROM_WALLET:GET_FROM_WALLET "}'
This command updates the reimappJobAdminBaseUrl system option in the Process Flow.
curl --user userId:password -i -X POST -H "Content-Type:application/json" http://server:port/bdi-process-flow/resources/system-setting/system-options
-d '{"key":"reimappJobAdminBaseUrl" , "value":"http://server:port/reim-batch-job-admin"}'
This command deletes the reimappJobAdminBaseUrl system option from the Process Flow.
curl --user userId:password -i -X DELETE -H "Content-Type:application/json" http://server:port/bdi-process-flow/resources/system-setting/system-options
-d '{"key":"reimappJobAdminBaseUrl"}'
Here are examples of curl commands to list/create/update/delete credentials for the Process Flow. These commands can be run for Job Admin and Scheduler as well. Create/update/delete commands can only be run by an administrator.
This command creates a credential in the Process Flow.
curl --user userId:password -i -X PUT -H "Content-Type:application/json" http://server:port/bdi-process-flow/resources/system-setting/system-credentials -d '{"userAlias":" reimappJobAdminBaseUrlUserAlias", "userName":"reimjobadmin" , "userPassword":"xyzxyz"}'
This command updates a credential in the Process Flow.
curl --user userId:password -i -X POST -H "Content-Type:application/json" http://server:port/bdi-process-flow/resources/system-setting/system-credentials -d '{"userAlias":" reimappJobAdminBaseUrlUserAlias", "userName":"reimjobadmin" , "userPassword":"wwwqqqq"}'