Export Metadata

Use this REST API to export metadata into a file using the settings specified in a Planning job of type export metadata. The file containing the exported metadata is stored in the Planning repository.

You can also override some of the parameters of the job definition while executing this job from a REST 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.

Required Roles

Service Administrator

Request

Supported Media Types: application/json

Parameters

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 8-16 Export Metadata

Name	Description	Required	Default
jobType	Export Metadata or EXPORT_METADATA (both parameters are supported)	Yes	None
jobName	The name of a job of type export metadata exactly as it is already defined in the Planning application. Example: dailyAccountExport	Yes	None
exportZipFileName	Optionally, you can specify a file name for the exported metadata. Metadata is exported as a ZIP file only. The value must use JSON syntax. Example: {exportZipFileName:Accountexport.zip}	No	The file name for the exported metadata will be the same as Job Name

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

Example Payload

Example: Executes the export metadata job "ExportMetadataDaily" and overrides the exportZipFileName parameter.

{
    "jobType": "EXPORT_METADATA",
    "jobName": "ExportMetadataDaily",
    "parameters": {
        "exportZipFileName": "dailyMetaData.zip"
    }
}