Export-TopicMap

Top  Previous  Next

Summary

Export-TopicMap [-TopicMapAddress] <Uri> [[-FilePath] <String>] [-ForceOverwrite]

Description

Exports topic map data as an XTM file from a topic map on the Web3 server.

 

Parameters

TopicMapAddress <Uri>
Specifies the web address of the topic map whose jobs are to be returned. This is a positional parameter and needs to be specified as the first parameter. The parameter name can be omitted.
FilePath <String>
Specifies the path to the output file to be written to. This is an optional parameter. If this parameter is specified, the command will block until the export is completed on the server and will then retrieve the exported XTM file and save it to the file specified by this parameter. If the parameter is omitted then the command will create an export job on the server and return without waiting for it to complete - the status of the job can then be monitored with the Get-TopicMapJobs cmdlet.
This is a positional parameter and, if present, must be specified as the second parameter on the command-line. The parameter name can be omitted.
ForceOverwrite
If this parameter is present on the command-line then the file specified by the FilePath parameter will be overwritten if it exists. If this parameter is not present and the file exists, the cmdlet will exit with an error without modifying the existing file.