Relative proportional spread

The relative proportional spread method spreads values to the leaves (children) of a consolidation proportional to the leaves of a reference cell.

The reference cell can be located in the cube from which you initiate spreading or in a separate cube. The reference cell must, however, share the same exact consolidations as the cell from which you initiate spreading.

The spread code for relative proportional spread is RP. For more information, see Spreading command codes.

Example

Start with a general proportional spreading command passing in the ReferenceCell as in the following example:

POST: Cellsets('AAAAAAA')/tm1.Update
{
    "BeginOrdinal":0,
    "Value":"RP9999"
    "ReferenceCell@odata.bind":
    [
        "Dimensions('A')/Hierarchies('A')/Elements('E1')",
        "Dimensions('B')/Hierarchies('B')/Elements('E2')",
        "Dimensions('C')/Hierarchies('C')/Elements('E3')"
    ]
}

You must specify the reference cell, and optionally the reference cube, if the cell resides in a different cube on which the relative spread needs to take place. In the REST API, you specify a reference using the @odata.bind notation. For example, the ReferenceCell can be specified as:

"ReferenceCell@odata.bind":
[
    "Dimensions('A')/Hierarchies('A')/Elements('E1')",
    "Dimensions('B')/Hierarchies('B')/Elements('E2')",
    "Dimensions('C')/Hierarchies('C')/Elements('E3')"
]

Or the ReferenceCube can be specified as:

"ReferenceCube@odata.bind": "Cubes('CUBE-NAME')"