Administration Mode

Changes the login level for a Planning application. If you set login level to Administrators, all Interactive Users and Planners will be logged off of the application upon completion of the job.

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request specific to this job. For parameters that are generic to all jobs, see Execute a Job.

Table 5-19 Parameters

Name Description Required Default
jobType Administration Mode Yes None
jobName The job name to be used for this job execution. Example: AppAdminJob No Administration Mode
loginLevel Specify the login level for users using loginLevel. Possible values are Administrators or All Users Yes None

Sample Payload

Example: This request will change the login level of the application to "Administrators" level.

{
    "jobType": "Administration Mode",
    "jobName": "AppAdminJob",
    "parameters": {
        "loginLevel": "Administrators"
    }
}