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. For details on administration mode, see Scheduling Jobs.

Using this REST API requires prerequisites, such as understanding how to use jobs. See Prerequisites. Be sure that you understand how to use jobs as described in Managing Jobs.

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request parameters specific to this job. For additional parameters that are common 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

For a sample URL, see Sample URL and Payload in Execute a Job.

Sample Payload

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

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