Removing Users from a Team for Financial Consolidation and Close and Tax Reporting

Removes Oracle Enterprise Performance Management Cloud users listed in a UTF8 formatted CSV file from an existing team in Access Control. The file must be uploaded to the environment before using this API, and the file should be deleted after the API executes. Use the Upload REST API to upload the file.

A primary user is, by default, designated to perform the tasks that are assigned to the team. The file format is as follows:

User Login, primary_user
jdoe, yes
jane.doe@example.com,no

Note: The users are removed only if both these conditions are met:

User login IDs included in the file exist in the identity domain that services the environment
The user is assigned to a pre-defined role in the identity domain

The API is asynchronous and returns the Job ID. Use the job status URI to determine whether the process is complete. The presence of status -1 in the response indicates that the update is in progress. Any non-zero status except -1 indicates failure for the update.

Note that this feature uses a Planning REST API to run a job. Details about Planning REST APIs are described here: Planning REST APIs.

REST Resource

POST /HyperionPlanning/rest/{api_version}/applications/{application}/fcmjobs

Note:

Before using the REST resources, you must understand how to access the REST resources and other important concepts. See Implementation Best Practices for EPM Cloud REST APIs. Using this REST API requires prerequisites. See Prerequisites.

Example URL

https://<SERVICE_NAME>-<TENANT_NAME>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3/applications/FCCS/fcmjobs

Required Roles

Service Administrators

Request

Supported Media Types: application/x-www-form-urlencoded

The following table summarizes the parameters.

Table 12-97 Parameters

Name	Description	Type	Required	Default
`api_version`	The version of the API you are developing with; for the current release, it is v3	Path	Yes	None
`application`	The name of the application, `FCCS`	Path	Yes	None

Example of Request Body

The following table summarizes the parameters of the JSON request.

Table 12-98 Parameters

Name Description

jobName The name of the job, REMOVE_USERS_FROM_TEAM

Name	Description
`jobName`	The name of the job, REMOVE_USERS_FROM_TEAM
`fileName`	The name of the uploaded ANSI or UTF-8 encoded CSV file containing information on the users to be removed, for example, `removeUsersFromTeam.csv`. The file must have been uploaded already using the Upload REST API. The CSV file should not include the account of the user who executes this command. A primary user is, by default, designated to perform the tasks that are assigned to the team. The file format is as follows: `User Login, primary_user jdoe, yes jane.doe@example.com,no`
`teamName`	The name of an existing team in Access Control, such as `Team1`.

fileName

The name of the uploaded ANSI or UTF-8 encoded CSV file containing information on the users to be removed, for example, removeUsersFromTeam.csv.

The file must have been uploaded already using the Upload REST API. The CSV file should not include the account of the user who executes this command.

A primary user is, by default, designated to perform the tasks that are assigned to the team. The file format is as follows:

User Login, primary_user
jdoe, yes
jane.doe@example.com,no

teamName The name of an existing team in Access Control, such as Team1.

Example of Request Body

{
   "jobName":"REMOVE_USERS_FROM_TEAM",
      "parameters":{
      "fileName":"users.csv",
      "teamName":"Team1"
   }
}

Response

Supported Media Types: application/json

Parameters

Table 12-99 Parameters

Name	Description
`jobName`	`REMOVE_USERS_FROM_TEAM`
`jobID`	The ID of the job, such as 100000000114040
`status`	`-1` - In Progress `0` - Success `1` - Failure
`details`	In case of errors, details are published with the error string
`descriptiveStatus`	The status of the job, such as `Completed` or `Error`
`items`	Collection of notification categories
`links`	Detailed information about the link
`href`	Links to the API call
`action`	The HTTP call type
`rel`	Possible value: `self`
`data`	Parameters as key value pairs passed in the request

Example of Response Body

The following is an example of the response body in JSON format.

{
   "jobName":"REMOVE_USERS_FROM_TEAM",
   "jobId":100000000114040,
   "descriptiveStatus":",
   "detail":"In Progress",
   "status":-1,
   "items":null,
   "links":[
      {
         "rel":"self",
         "href":"https://<SERVICE_NAME>-<TENANT_NAME>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3/applications/FCCS/fcmjobs/100000000114040",
         "action":"GET"
      }
   ]
}

Common Functions