Adding Users to a Team for Financial Consolidation and Close and Tax Reporting
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,noThe 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:
This feature uses a Planning REST API to run a job. Details about Planning REST APIs are described here: Planning REST APIs.Required Roles
Service Administrator, Power User, User, Viewer
Users with Power User, User, and Viewer predefined roles may require additional application roles.
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.
Request
Supported Media Types: application/x-www-form-urlencoded
The following table summarizes the request parameters.
Table 12-99 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
The following table summarizes the parameters of the JSON request.
Table 12-100 Parameters
| Name | Description |
|---|---|
jobName |
The name of the job, ADD_USERS_TO_TEAM |
fileName |
The name of the uploaded ANSI or UTF-8 encoded CSV file containing
information on the users to be added, for example,
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: |
teamName |
The name of an existing team in Access Control, for example,
Team1 |
Example URL and Payload
https://<BASE-URL>/HyperionPlanning/rest/v3/applications/FCCS/fcmjobs{
"jobName":"ADD_USERS_TO_TEAM",
"parameters":{
"fileName":"users.csv",
"teamName":"Team1"
}
}Response
Supported Media Types: application/json
Table 12-101 Parameters
| Name | Description |
|---|---|
jobName |
ADD_USERS_TO_TEAM |
jobID |
The ID of the job, such as 100000000114040 |
status |
|
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://<BASE-URL>/HyperionPlanning/rest/v3/applications/FCCS/fcmjobs/100000000114040",
"action":"GET"
}
]
}