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

Description

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

Parameters

Name	Description	Type	Example
fileId sent in url	File ID	number	1234
version sent in body	File version	number	1234
doc sent in body	Shared token	string	some text
view sent in body	Specifies if a document will be opened for viewing only or not	Bool value	true

Example

GET api/2.0/files/file/1234/openedit
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "version": 1234,
  "doc": "some text",
  "view": true
}

Returns

Configuration parameters

Example Response

application/json

{
  "status": 0,
  "response": {
    "DocumentType": "some text",
    "EditorUrl": "some text",
    "Token": "some text",
    "Type": "some text",
    "File": {
      "FolderId": 1234,
      "Version": 1234,
      "VersionGroup": 1234,
      "ContentLength": "some text",
      "Mute": true,
      "ViewUrl": "some text",
      "WebUrl": "some text",
      "FileExst": "some text",
      "Comment": "some text",
      "ThumbnailUrl": "some text",
      "LockedBy": "some text",
      "DenyDownload": true,
      "DenySharing": true
    },
    "ErrorMessage": "some text"
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <DocumentType>some text</DocumentType>
    <EditorUrl>some text</EditorUrl>
    <Token>some text</Token>
    <Type>some text</Type>
    <File>
      <FolderId>1234</FolderId>
      <Version>1234</Version>
      <VersionGroup>1234</VersionGroup>
      <ContentLength>some text</ContentLength>
      <Mute>True</Mute>
      <ViewUrl>some text</ViewUrl>
      <WebUrl>some text</WebUrl>
      <FileExst>some text</FileExst>
      <Comment>some text</Comment>
      <ThumbnailUrl>some text</ThumbnailUrl>
      <LockedBy>some text</LockedBy>
      <DenyDownload>True</DenyDownload>
      <DenySharing>True</DenySharing>
    </File>
    <ErrorMessage>some text</ErrorMessage>
  </response>
</result>