GET api/2.0/files/file/{fileId}/openedit

Returns the initialization configuration of a file to open it in the editor.

GET api/2.0/files/file/%22some+text%22/openedit?version=1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

Configuration

application/json

{
  "status": 0,
  "response": {
    "document": {
      "fileType": "fileType",
      "key": "key",
      "permissions": {
        "changeHistory": true,
        "comment": true,
        "download": true,
        "edit": true,
        "fillForms": true,
        "print": true,
        "modifyFilter": true,
        "rename": true,
        "review": true
      },
      "Title": "title",
      "url": "url"
    },
    "documentType": "documentType",
    "editorConfig": {
      "actionLink": {
        "action": {
          "Type": "type",
          "Data": "data"
        }
      },
      "templates": [
        {
          "image": "image",
          "title": "title",
          "url": "url"
        }
      ],
      "callbackUrl": "callbackUrl",
      "createUrl": "createUrl",
      "plugins": {
        "PluginsData": [
          "pluginsData"
        ]
      },
      "customization": {
        "about": true,
        "customer": {
          "logo": "logo",
          "mail": "mail",
          "name": "name"
        },
        "feedback": {
          "url": "url",
          "visible": true
        }
      },
      "embedded": {
        "embedUrl": "embedUrl",
        "saveUrl": "saveUrl",
        "shareUrl": "shareUrl",
        "toolbarDocked": "top"
      },
      "encryptionKeys": {
        "cryptoEngineId": "{FFF221EB-135B-4118-B17D-FF0A44BBCEF}",
        "privateKeyEnc": "privateKeyEnc",
        "publicKey": "publicKey"
      },
      "fileChoiceUrl": "fileChoiceUrl",
      "lang": "lang",
      "mode": "mode",
      "saveAsUrl": "saveAsUrl",
      "recent": [
        {
          "folder": "folder",
          "title": "title",
          "url": "url"
        }
      ],
      "sharingSettingsUrl": "sharingSettingsUrl",
      "user": {
        "id": "id",
        "name": "name"
      }
    },
    "token": "token",
    "type": "type",
    "error": "ErrorMessage"
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <document>
      <fileType>fileType</fileType>
      <key>key</key>
      <permissions>
        <changeHistory>True</changeHistory>
        <comment>True</comment>
        <download>True</download>
        <edit>True</edit>
        <fillForms>True</fillForms>
        <print>True</print>
        <modifyFilter>True</modifyFilter>
        <rename>True</rename>
        <review>True</review>
      </permissions>
      <Title>title</Title>
      <url>url</url>
    </document>
    <documentType>documentType</documentType>
    <editorConfig>
      <actionLink>
        <action>
          <Type>type</Type>
          <Data>data</Data>
        </action>
      </actionLink>
      <templates>
        <image>image</image>
        <title>title</title>
        <url>url</url>
      </templates>
      <callbackUrl>callbackUrl</callbackUrl>
      <createUrl>createUrl</createUrl>
      <plugins>
        <PluginsData>pluginsData</PluginsData>
      </plugins>
      <customization>
        <about>True</about>
        <customer>
          <logo>logo</logo>
          <mail>mail</mail>
          <name>name</name>
        </customer>
        <feedback>
          <url>url</url>
          <visible>True</visible>
        </feedback>
      </customization>
      <embedded>
        <embedUrl>embedUrl</embedUrl>
        <saveUrl>saveUrl</saveUrl>
        <shareUrl>shareUrl</shareUrl>
        <toolbarDocked>top</toolbarDocked>
      </embedded>
      <encryptionKeys>
        <cryptoEngineId>{FFF221EB-135B-4118-B17D-FF0A44BBCEF}</cryptoEngineId>
        <privateKeyEnc>privateKeyEnc</privateKeyEnc>
        <publicKey>publicKey</publicKey>
      </encryptionKeys>
      <fileChoiceUrl>fileChoiceUrl</fileChoiceUrl>
      <lang>lang</lang>
      <mode>mode</mode>
      <saveAsUrl>saveAsUrl</saveAsUrl>
      <recent>
        <folder>folder</folder>
        <title>title</title>
        <url>url</url>
      </recent>
      <sharingSettingsUrl>sharingSettingsUrl</sharingSettingsUrl>
      <user>
        <id>id</id>
        <name>name</name>
      </user>
    </editorConfig>
    <token>token</token>
    <type>type</type>
    <error>ErrorMessage</error>
  </response>
</result>