Export Metadata

Exports 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.

Request

Supported Media Types: application/json

Parameters

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

Table 5-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 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

Example Payload

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

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