Update Validation Status of Enterprise Journals for Financial Consolidation and Close

Updates the journal validation status. Once journal content has been read, you can invoke this API to update the status to "ValidationInProgress". After completion of validation, the status must be updated as either "Valid" or "Failed". Error items are read only if validation status is "Failed".

REST Resource

POST  /HyperionPlanning/rest/ej/{api_version}/ejjournals/{identifier}/validationstatus

Required Roles

Service Administrator

Example of Request URL

POST https://<SERVICE_NAME>-
<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/ej/v1/ejjournals/100000000008821/validationstatus

Supported Media Types: application/json

Table 21-14 Parameters

Name	Description	Type	Required	Default
api_version	Version of the API you are developing with, for example, v1	Path	Yes	None
instanceId	Identifier for the journal for which you want to update the validation status.	Path	Yes	None
status	Validation status to be updated for the journal Note: Only "ValidationInProgress", "Failed" and "Valid" are supported for status value.	String	Yes	None
message	Validation message to be set to the journal	String	No	None
errorItems	List of errors if any Note: Errors are updated only if status is "Failed".	Array	No	None
errorCode	Identifier for the individual error	String	No	None
errorMessage	Detailed message of the error	String	No	None
entryId	Journal entry identifier, for which error has occurred	String	No	None

Example of Validation in Progress:

{
	"status": "ValidationInProgress",
	"message":"Validation initiated"
}

Example of an Error:

{
	"status": "Failed",
	"message":"Validation failed"
	"errorItems": [
		{
			"errorCode": "EF04",
			"errorMessage": "The account combination is invalid.",
			"entryId": "Journal Ent 1"
		},
		{
			"errorCode ": "EU07",
			"errorMessage ": "Accounting period is not open for the ledger.",
			"entryId ": "Journal Ent 2"
		}
	]
}

Example of Response Body:

{
      "items": [
                       "Journal validation status updated successfully."
                ],
      "links": [
                       {
                            "rel": "self",
                            "href": "https://<SERVICE_NAME>-
<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/ej/v1/ejjournals/100000000006929/validationstatus",
                            "action": "POST"
                        }
                ]
}