Update Task Status for Event Monitoring

This API is used to update the task status to "completed" based on an event monitoring integration type. For information on setting up integration type for Event Monitoring, see Creating Custom Event Monitoring Integrations in Administering Financial Consolidation and Close.

REST Resource

POST /HyperionPlanning/rest/cmapi/{api_version}/updateTasksForEventMonitoring

Required Roles

Service Administrator

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request.

Table 19-5 Parameters

Name	Description	Type	Required	Default Value
api_version	Version of the API you are developing with	Path	Yes	v1
eventName	Event name as specified in the custom event monitoring integration type.	JSON (String)	Yes	None
integrationName	Integration Code of the custom event monitoring integration type.	JSON (String)	Yes	None
integrationConnectionName	Connection name which the event monitoring integration belongs to.	JSON (String)	Yes	None
parameters	Parameter values as per the custom event monitoring integration type. The format is: [ {"name" :"param1", "value":"value1" , {"name" :"param2", "value":"value2" }]	JSON	Yes	None
message	A message needs to be added while closing the task. This information is displayed on the task dialog.	JSON (String)	No	None
logLocation	Any location which needs to be added which refers to a log. This information is displayed on the task dialog.	JSON (String)	No	None
reportLocations	One or more URLs to add while closing the task. The format is: ["Example_URL1", "Example_URL2"] This information will be displayed on the Task dialog box.	JSON (List of Strings)	No	None

Example URL

https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/cmapi/v1/updateTasksForEventMonitoring

Payload

Example 1

If the custom event monitoring integration has the following properties:

• Integration Connection Name: customAppConn
• Integration Code: customPeriodClose
• Event Name: custom.CloseProcess.period.close
• Parameter Code: periodName and ledgerID

And the task is set up with following parameters:

• periodName: FY18
• ledgerID: 123

The following payload should be sent to close the task:

{
       "eventName" : "custom.CloseProcess.period.close",
       "integrationName" : "customPeriodClose",
       "integrationConnectionName" : "customAppConn",
    "parameters": [{
        "name": "periodName",
        "value": "FY18"
    }, {
        "name": "ledgerID",
        "value": "123"
    }]
}

Note:

The API expects integration code to be passed for the parameter integrationName.

Example 2

{
    "eventName": "custom.CloseProcess.period.close",
    "integrationName": "customPeriodClose",
    "integrationConnectionName": "customAppConn",
    "parameters": [
        {
            "name": "periodName",
            "value": "FY18"
        },
        {
            "name": "ledgerID",
            "value": "123"
        }
    ],
    "message": "Close period",
    "logLocation": "/logs/closeperiod.txt",
    "reportLocations": [
        "http://oracle.com/reportLocation.html"
    ]
}

Response

Supported Media Types: application/json

Example of a Successful Response

Http status code: 200

{
    "type": "RC",
    "items": null,
    "error": null,
    "link": null,
    "status": null,
    "details": "2 task(s) updated.",
    "links": [
        {
            "rel": "self",
            "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/cmapi/v1/updateTasksForEventMonitoring",
            "action": "POST"
        }
    ]
}

Example of an Error Response

Http status: 500