Validate Metadata

This REST API is used to automatically run the Validate Metadata process to ensure an error-free database refresh and consolidation.

For details on this task, see "Validating Metadata" in Administering Financial Consolidation and Close.

Required Roles

Service Administrator

REST Resource

POST /HyperionPlanning/rest/{api_version}/applications/{application_name}/application/validatemetadata?logFileName={logfile_name}

Request

Supported Media Types: application/json

Table 18-19 Parameters

Name	Description	Type	Required	Default
api_version	Version of the API you are working with: v3	Path	Yes	None
application_name	The name of the application Get the application name by using the Get Applications API. See Get Applications.	Path	Yes	None
logFileName	Name of the log file of exported results	Payload	No	None

Response

Supported Media Types: application/json

Table 18-20 Parameters

Name	Description
numWarnings	Number of metadata warnings
numInfo	Number of metadata information messages
outPutFileName	Ouput file name with the extension of .csv
numErrors	Number of metadata error messages
status	The status of the job, such as Completed or Error

Example of Response Body:

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

{ 
"numWarnings": 0,
"numInfo": 0,
"outPutFileName": "ValidateMetadata.csv,
"numErrors": 20,
"status": "Validate Metadata Completed"
}