Sort Members
Sorts the dimension members of a business process.
You can sort Entity, Account, Scenario, Version, and user-defined custom dimension members. You cannot sort Period, Years, or Currency dimension members. This feature is only supported for the Planning, Module, and Free Form business processes. For more information, see Sorting Members.
For Planning Module applications, you cannot sort these dimensions:
- Any dense dimension
- The "Plan Element" dimension, even if it is renamed, from Financials
- The "Project Element" dimension, even if it is renamed, from Projects
After sorting members, administrators must perform a cube refresh.
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.
Required Roles
Service Administrator
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 8-28 Parameters
Name | Description | Required | Default |
---|---|---|---|
jobType |
Sort Members | Yes | None |
jobName |
The job name to be used for this job execution. Example: SortEntity | No | Sort Members |
member |
Parent member whose children or descendants are being sorted. | Yes | None |
order |
Order of sorting.
Possible values are:
|
No | ascending |
type |
Sort children or descendants.
Possible values are:
|
No | children |
For a sample URL, see Sample URL and Payload in Execute a Job.
Sample Payload
Example 1: Sorts the child members of the Account dimension in ascending order.
{
"jobType": "Sort Members",
"jobName": "SortAccount",
"parameters":
{
"member":"Account"
}
}
Example 2: Sorts the child members of the Account dimension in descending order.
{
"jobType": "Sort Members",
"jobName": "SortAccountDesc",
"parameters":
{
"member":"Account", "order":"descending"
}
}
Example 3: Sorts the descendants of member account200 in descending order.
{
"jobType": "Sort Members",
"jobName": "SortAccount200Desc",
"parameters":
{
"member":"account200", "order":"descending", "type":"descendants"
}
}