Was this page helpful?

POST:site/export

    Overview

     



    public. Generates export information

    Uri Parameters

    None

    Query Parameters
    Name Type Description
    relto int? Page used for path normalization (default: home page)
    reltopath string? Page used for path normalization. Ignored if relto parameter is defined.
    Return Codes
    Name Value Description
    BadRequest 400 Invalid input parameter or request body
    Ok 200 The request completed successfully

    Message Format

    Input:

    <export> 
      <page path="{text}" recursive="{bool}" exclude="none|files,props,tags,talk|all" />
      <page id="{int}" recursive="{bool}" exclude="none|files,props,tags,talk|all" />  
        ...
      <file id="{int}" exclude="none|props|all" />
    </export>

    Output:

    <export>
      <requests>
        <request method="GET" href="http://host/@api/deki/pages/{id}/contents?reltopath={path}&format=xhtml" dataid="{text1}" >
          <header name="{text}" value="{text}" />
          ...
        </request>
        <request method="GET"  href="http://host/@api/deki/pages/{id}/tags" dataid="{text2}">
          <header name="{text}" value="{text}" />
          ...
        </request>
        <request method="GET"  href="http://host/@api/deki/pages/{id}/properties/{name}" dataid="{text3}">
          <header name="{text}" value="{text}" />
          ...
        </request>
        <request method="GET"  href="http://host/@api/deki/files/{id}" dataid="{text4}">
          <header name="{text}" value="{text}" />
          ...
        </request>
        <request method="GET"  href="http://host/@api/deki/files/{id}/properties" dataid="{text5}">
          <header name="{text}" value="{text}" />
          ...
        </request>
        ...
        <warning reason="{text}" status="{httpstatus}">
          <page path="{text}" recursive="{bool}" exclude="none|files,props|all" />
        </warning>
        ...
      </requests>
      <manifest version="{version}">
        <page dataid="{text1}">
          <title>{text}</title>
          <path>{page path using // to indicate relativity to base export page}</path>
          <language>{text}</language>
          <contents type="{mimetype}"/>
        </page>
        <tags dataid="{text2}">
          <path>{page path using // to indicate relativity to base export page}</path>    
        </tags>
        <property dataid="{text3}">
          <name>{text}</name>
          <path>{page path using // to indicate relativity to base export page}</path>
          <contents type="{mimetype}"/>
        </property> 
        <file dataid="{text4}">
         <filename>{text}</filename>
         <path>{page path using // to indicate relativity to base export page}</path>
         <description>{text}</description>
         <contents type="{mimetype}" />
        </file>
        <property dataid="{text5}">
         <name>{text}</name>
         <filename>{text}</filename>
         <path>{page path using // to indicate relativity to base export page}</path>
         <contents type="{mimetype}"/></property>...  
      </manifest>
    </export>

    Implementation Notes

    The requests section of the returned document describes the HTTP requests to make to perform the actual export.

    There currently exist two tools that will automate the export process for you:

    1. Desktop Connection
    2. mindtouch.import.exe

    Code Samples

    C# Samples

     

    Curl Samples

     

    PHP Samples

     

    Other Code Samples

     

    Was this page helpful?
    Tag page
    You must login to post a comment.

    Copyright © 2011 MindTouch, Inc. Powered by