Import Metadata

Imports metadata from a file in the Planning repository into the application using the import metadata settings specified in a Planning job of type import metadata.

You can also override some of the parameters of the job definition while executing this job from a REST API.

For Planning, Financial Consolidation and Close, and Tax Reporting, you can specify an error file that captures the metadata records that are not imported for each dimension. If an error file is specified, a separate error file is created for each dimension. The error files are then zipped together and the zip file is stored in the Outbox where you can download the file using Inbox/Outbox Explorer or tools like EPM Automate or REST APIs, for example, with the Download API.

Using this REST API requires prerequisites, such as understanding how to use jobs. See Prerequisites. Be sure that you understand how to use jobs as described in Managing Jobs.


Supported Media Types: application/json


The following table summarizes the client request parameters specific to this job. For additional parameters that are common to all jobs, see Execute a Job.

Table 5-15 Import Metadata

Name Description Required Default
jobType Import Metadata or IMPORT_METADATA (both parameters are supported) Yes None

The name of a job of type import metadata exactly as it is already defined in the Planning application.

Example: importAccount

Yes None

Optionally, you can specify the name of the ZIP file from which metadata is to be imported. The contents of the ZIP file that you specify take precedence over the file names defined in the job. The ZIP file may contain one or more CSV files.

The file names containing metadata for dimensions should match the import file names defined in the job or end with _DIMENSIONNAME.csv; for example, metadata_Entity.csv, metadata_HSP_SmartLists.csv, and metadata_Exchange Rates.csv.

Only metadata for the dimensions for which metadata import is set up in the job is imported. Metadata for other dimensions, if contained in the ZIP file, is ignored.

Example: {}

No The import file name defined in the job definition.

You can override the option to perform a refresh cube action defined in the job.

Allowed values are either true or false.

No "Refresh Database if Import Metadata is successful" parameter of the job definition.
errorFile Optionally, create a separate error file for each dimension. The error files are then zipped together in a file with the name of this parameter. The ZIP file is stored in the Outbox where it can be downloaded, for example, with the Download API.

This API overrides any existing error file with the same name.


No No error files are created.

For a sample URL, see Sample URL and Payload in Execute a Job.

Sample Payload

Example: Executes the job ImportMetaDataJob and overrides only the importZipFileName parameter.

    "jobType": "IMPORT_METADATA",
    "jobName": "ImportMetaDataJob",
    "parameters": {
        "importZipFileName": ""

Example: Executes the job ImportMetaDataJob and overrides the errorFile parameter with a value If there are error records found during the Import Metadata operation for one or more dimensions, a ZIP file called is created in the repository that contains one error CSV file for each failed dimension. The generated error file can be downloaded from the Outbox from the job status page or using the Download REST API or EPM Automate downloadfile command.

    "jobType": "IMPORT_METADATA",
    "jobName": "ImportMetaDataJob",
    "parameters": {