Adding Users to a Team for Oracle Financial Consolidation and Close Cloud and Oracle Tax Reporting Cloud

Adds Oracle Enterprise Performance Management Cloud users listed in a UTF8 formatted CSV file to 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 added 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.

Before using the REST resources, you must understand how to access the REST resources and other important concepts. See About the REST APIs. Using these REST APIs requires prerequisites. See Prerequisites.

REST Resource

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

Example URL

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

Request

Supported Media Types: application/json

The following table summarizes the parameters.

Table 8-34 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, for example, FCCS or TRCS Path Yes None

Example of Request Body

Response

The following table summarizes the parameters of the JSON request.

Table 8-35 Parameters

Name Description
jobName The name of the job, ADD_USERS_TO_TEAM
jobType The job type, MANAGE_TEAM_MEMBERS
fileName

The name of the uploaded ANSI or UTF-8 encoded CSV file containing information on the users to be added, for example, addUsersToTeam.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, for example, Team1

Example of Request body

{
   "jobName":"ADD_USERS_TO_TEAM",
   "jobType":"MANAGE_TEAM_MEMBERS",
   "parameters":{
      "fileName":"users.csv",
      "teamName":"Team1"
   }
}

Supported Media Types: application/json

Parameters

Table 8-36 Parameters

Name Description
jobName ADD_USERS_TO_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":"ADD_USERS_TO_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"
      }
   ]
}
Additional Sample code

Prerequisites: json.jar

Common Functions: See CSS Common Helper Functions for Java