Validate Model
Automates the calculation process for validating a model.
This is an asynchronous call, so use the job status URI to determine whether the operation is complete.
Any validation failures are written to file with file name provided in the parameters, and can be accessed from Inbox/Outbox Explorer.
This API is version v3.
Required Roles
Service Administrators
REST Resource
POST /HyperionPlanning/rest/v3/applications/{AppName}/jobs/
Note:
Before using the REST resources, you must understand how to access the REST resources and other important concepts. See Implementation Best Practices for EPM Cloud REST APIs. Using this REST API requires prerequisites. See Prerequisites.
Request
Supported Media Types: application/json
The following table summarizes the client request parameters specific to this job.
Table 23-14 Parameters
Name | Description | Type | Required | Default |
---|---|---|---|---|
jobType |
Validate Model |
Payload | Yes | None |
jobName |
Name of the job Example: |
Payload | Yes | None |
modelName |
Name of the model to validate Example: |
Payload | Yes | None |
fileName |
Name of the output file to which all the validations (if any) will be written Example:
|
Payload | Yes | None |
ruleStatus |
Exclude rules based on their status:
|
Payload | Yes | All |
Sample Payload
{
"jobType":"Validate Model",
"jobName":"Validate Model",
"parameters":{
"modelName":"10 Actuals Allocation Process",
"fileName":"DISABLED_results4.txt"
"ruleStatus":"DISABLED"
}
}
Response
Supported Media Types: application/json
Table 23-15 Parameters
Name | Description |
---|---|
jobId |
ID of the job that is created |
jobName |
Name of the job |
details |
In case of errors, details are published with the error string |
status |
See Migration Status Codes. |
links |
Detailed information about the link |
href |
Links to the API call |
action |
HTTP call type |
rel |
Can be self and/or Job-details .
If set to Job Status , you can use the
href to get the status of the job.
|
data |
Parameters as key value pairs passed in the request |
Examples of Response Body
The following examples show the contents of the response body in JSON format:
Example 1: Job is in Progress
{
"jobId": 26,
"jobName": "Validate Model",
"status": -1,
"descriptiveStatus": "Processing",
"details": null,
"links": [
{
"href": "http://<BASE-URL>/HyperionPlanning/rest/v3/applications/BksML40/jobs/26",
"action": "GET",
"rel": "self",
},
{
"href": "http://<BASE-URL>/HyperionPlanning/rest/v3/applications/BksML40/jobs/26/details",
",
"action": "GET",
"rel": "job-details "
}
]
}
Example 2: Job Status with No Errors
{
"jobId": 26,
"jobName": "validate Model",
"status": 0,
"descriptiveStatus": "Success",
"details": null
"links": [
{
"rel": "self"
"href": "http://<BASE-URL>/HyperionPlanning/rest/v3/applications/jobs/26",
"action": "GET",
},
{
"rel": "job-details"
"href": "http://<BASE-URL>/HyperionPlanning/rest/v3/applications/jobs/26/details",
"action": "GET",
}
]
}