Get Planning Unit History and Annotations

You can use REST APIs to return a merged list of history and annotations for the planning unit that the requesting user owns for the specified Scenario, Version, and PM Member.

If both annotSeq and logSeq are < 0, parent level nodes are returned. If annotSeq or logSeq is provided, the replies to that annotation or history are returned respectively.

If both annotSeq and logSeq are < 0, parent level nodes are returned. If annotSeq or logSeq is provided, the replies to that annotation or history are returned respectively.

Required Roles

Service Administrator

REST Resource

POST /HyperionPlanning/rest/{api_version}/applications/{application}/planningunits/{puIdentifier}/historyandannotations?q={annotSeq=-1,logSeq=-1}&offset=10&limit=10

Request

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

Parameters:

The following table summarizes the client request.

Table 8-58 Parameters

Name	Description	Type	Required	Default
api_version	Version of the API you are developing with	Path	Yes	None
application	The name of the application	Path	Yes	None
scenario	Scenario for the application; required	Path	Yes	None
version	Version for the application; required	Path	Yes	None
pmMember	Entity; secondary member	Path	Yes	None
offset	Indicates the actual index from which the records are returned; 0 based.	Query	No	1
limit	Controls how many items to return; defaults to 25 if not specified.	Query	No	25

Example URL and Payload

https://<BASE-URL>/HyperionPlanning/rest/v3/applications/PS4app1/planningunits/Forecast::"BU Version_1"::Marketing::/historyandannotations?q={annotSeq:-1,logSeq:-1}

Filter can include name, type, and values to filter on. For example: filter={name:"SubStatus",type:3,values:[0,4]}

Response

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

Parameters:

Table 8-59 Parameters

Name	Description
comment	Comment entered by the planning unit owner when performing an action
hasHistory	True if the planning unit has history
logSeq	Sequence of the action performed on the planning unit
staticImage	Whether a static image exists for this note
authorImagePath	The path to the user image for the user who performed the action
commentTitle	The author name and the action the author performed
commentDate	The date when the action was performed or the annotation was added
commentSubTitle	Processing state of the planning unit when the action was performed
parentAnntSeq	Sequence of the annotation or the parent annotation added to the planning unit
isChildNode	true if this is a reply to an annotation

Example of Response Body

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

{
    "items": [{
        "comment": "Enough justification provided, Approving it.<p></p>",
        "hasHistory": false,
        "logSeq": -1,
        "staticImage": true,
        "authorImagePath": "/Images/GhostUser.png",
        "commentTitle": "admin",
        "commentDate": "8/22/14 3:41 PM",
        "commentSubTitle": "",
        "parentAnntSeq": 1,
        "isChildNode": false,
        "links": [{
            "rel": "annotation-replies",
            "href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/PS4app1/planningunits/%22Forecast%22::%22BU%20Version_1%22::%22Marketing%22::/historyandannotations?q=%7B%22annotSeq%22:1,%22logSeq%22:-1%7D",
            "action": "GET"
        }]
    }, {
        "comment": "",
        "hasHistory": true,
        "logSeq": 2,
        "staticImage": true,
        "authorImagePath": "/Images/GhostUser.png",
        "commentTitle": "Originate by admin",
        "commentDate": "4/22/14 12:26 PM",
        "commentSubTitle": "Under Review",
        "parentAnntSeq": -1,
        "isChildNode": false,
        "type": "HP",
        "links": [{
            "rel": "annotation-replies",
            "href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/PS4app1/planningunits/%22Forecast%22::%22BU%20Version_1%22::%22Marketing%22::/historyandannotations?q=%7B%22annotSeq%22:-1,%22logSeq%22:2%7D",
            "action": "GET"
        }]
    }, {
        "comment": "",
        "hasHistory": true,
        "logSeq": 1,
        "staticImage": true,
        "authorImagePath": "/Images/GhostUser.png",
        "commentTitle": "Originate by admin",
        "commentDate": "4/22/14 12:26 PM",
        "commentSubTitle": "Under Review",
        "parentAnntSeq": -1,
        "isChildNode": false,
        "type": "HP",
        "links": [{
            "rel": "annotation-replies",
            "href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/PS4app1/planningunits/%22Forecast%22::%22BU%20Version_1%22::%22Marketing%22::/historyandannotations?q=%7B%22annotSeq%22:-1,%22logSeq%22:1%7D",
            "action": "GET"
        }]
    }],
"type": "HP",
"links": [{
        "rel": "self",
        "href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/PS4app1/planningunits/%22Forecast%22::%22BU%20Version_1%22::%22Marketing%22::%22%22/historyandannotations?q=%7B%22annotSeq%22:-1,%22logSeq%22:-1%7D",
        "action": "GET"
    }],
        "type": "HP",

}