Open a file
GET /api/2.0/files/file/{fileId}/openedit
Request
Returns the initialization configuration of a file to open it in the editor.
Headers
- Accept
enum of string
Can be one of:
application/json
,text/json
,text/plain
.
Path
- fileId
integer
int32required
Query
- version
integer
int32 - view
boolean
- editorType
one of
- .
enum of string
[Desktop - Desktop, Mobile - Mobile, Embedded - Embedded]
Can be one of:
Desktop
,Mobile
,Embedded
.- .
enum of integer
[0 - Desktop, 1 - Mobile, 2 - Embedded]
Can be one of:
0
,1
,2
.
- edit
boolean
Examples
GET /api/2.0/files/file/6812/openedit?version=1234&view=true&edit=true HTTP/1.1
Accept: application/json
Host: example.com
curl --request GET \
--url 'https://example.com/api/2.0/files/file/6812/openedit?version=1234&view=true&edit=true' \
--header 'Accept: application/json'
Responses
200
Configuration parameters
- document
object
- fileType
string
- info
object
- favorite
boolean
- folder
string
- owner
string
- sharingSettings
array of unknown
- type
one of
- .
enum of string
[Desktop - Desktop, Mobile - Mobile, Embedded - Embedded]
Can be one of:
Desktop
,Mobile
,Embedded
.- .
enum of integer
[0 - Desktop, 1 - Mobile, 2 - Embedded]
Can be one of:
0
,1
,2
.
- uploaded
string
- isLinkedForMe
boolean
- key
string
- permissions
object
- changeHistory
boolean
- comment
boolean
- chat
boolean
- download
boolean
- edit
boolean
- fillForms
boolean
- modifyFilter
boolean
- protect
boolean
- print
boolean
- rename
boolean
- review
boolean
- copy
boolean
- sharedLinkParam
string
- sharedLinkKey
string
- referenceData
object
- fileKey
string
- instanceId
string
- title
string
- url
string
uri
- documentType
string
- editorConfig
object
- callbackUrl
string
uri - coEditing
object
- change
boolean
- fast
boolean
- mode
enum of integer
int32 Can be one of:
0
,1
.
- createUrl
string
- customization
object
- about
boolean
- customer
object
- address
string
- logo
string
- logoDark
string
- mail
string
- name
string
- www
string
- anonymous
object
- request
boolean
- feedback
object
- url
string
- visible
boolean
- forcesave
boolean
- goback
object
- url
string
- logo
object
- image
string
- imageDark
string
- imageEmbedded
string
- url
string
- visible
boolean
- mentionShare
boolean
- reviewDisplay
string
- submitForm
boolean
- embedded
object
- embedUrl
string
- saveUrl
string
- shareLinkParam
string
- shareUrl
string
- toolbarDocked
string
- encryptionKeys
object
- cryptoEngineId
string
- privateKeyEnc
string
- publicKey
string
- lang
string
- mode
string
- modeWrite
boolean
- plugins
object
- pluginsData
array of unknown
- recent
array of unknown
- templates
array of unknown
- user
object
- id
string
- name
string
- image
string
- editorType
one of
- .
enum of string
[Desktop - Desktop, Mobile - Mobile, Embedded - Embedded]
Can be one of:
Desktop
,Mobile
,Embedded
.- .
enum of integer
[0 - Desktop, 1 - Mobile, 2 - Embedded]
Can be one of:
0
,1
,2
.
- editorUrl
string
uri - token
string
- type
string
- file
object
- title
string
- access
one of
- .
enum of string
[None - None, ReadWrite - Read and write, Read - Read, Restrict - Restrict, Varies - Varies, Review - Review, Comment - Comment, FillForms - Fill forms, CustomFilter - Custom filter, RoomAdmin - Room admin, Editing - Editing, PowerUser - Power user]
Can be one of:
None
,ReadWrite
,Read
,Restrict
,Varies
,Review
,Comment
,FillForms
,CustomFilter
,RoomAdmin
,Editing
,PowerUser
.- .
enum of integer
[0 - None, 1 - Read and write, 2 - Read, 3 - Restrict, 4 - Varies, 5 - Review, 6 - Comment, 7 - Fill forms, 8 - Custom filter, 9 - Room admin, 10 - Editing, 11 - Power user]
Can be one of:
0
,1
,2
,3
,4
,5
,6
,7
,8
,9
,10
,11
.
- shared
boolean
- created
object
- utcTime
string
date-time - timeZoneOffset
string
date-span
- createdBy
object
- id
string
uuid - displayName
string
- title
string
- avatar
string
- avatarOriginal
string
- avatarMax
string
- avatarMedium
string
- avatarSmall
string
- profileUrl
string
- hasAvatar
boolean
- isAnonim
boolean
- updated
object
- utcTime
string
date-time - timeZoneOffset
string
date-span
- autoDelete
object
- utcTime
string
date-time - timeZoneOffset
string
date-span
- rootFolderType
one of
- .
enum of string
[DEFAULT - Default, COMMON - Coomon, BUNCH - Bunch, TRASH - Trash, USER - User, SHARE - Share, Projects - Projects, Favorites - Favourites, Recent - Recent, Templates - Templates, Privacy - Privacy, VirtualRooms - Virtual rooms, FillingFormsRoom - Filling forms room, EditingRoom - Editing room, CustomRoom - Custom room, Archive - Archive, ThirdpartyBackup - Thirdparty backup, PublicRoom - Public room, ReadyFormFolder - Ready form folder, InProcessFormFolder - In process form folder, FormFillingFolderDone - Form filling folder done, FormFillingFolderInProgress - Form filling folder in progress]
Can be one of:
DEFAULT
,COMMON
,BUNCH
,TRASH
,USER
,SHARE
,Projects
,Favorites
,Recent
,Templates
,Privacy
,VirtualRooms
,FillingFormsRoom
,EditingRoom
,CustomRoom
,Archive
,ThirdpartyBackup
,PublicRoom
,ReadyFormFolder
,InProcessFormFolder
,FormFillingFolderDone
,FormFillingFolderInProgress
.- .
enum of integer
[0 - Default, 1 - Coomon, 2 - Bunch, 3 - Trash, 5 - User, 6 - Share, 8 - Projects, 10 - Favourites, 11 - Recent, 12 - Templates, 13 - Privacy, 14 - Virtual rooms, 15 - Filling forms room, 16 - Editing room, 19 - Custom room, 20 - Archive, 21 - Thirdparty backup, 22 - Public room, 25 - Ready form folder, 26 - In process form folder, 27 - Form filling folder done, 28 - Form filling folder in progress]
Can be one of:
0
,1
,2
,3
,5
,6
,8
,10
,11
,12
,13
,14
,15
,16
,19
,20
,21
,22
,25
,26
,27
,28
.
- parentRoomType
one of
- .
enum of string
[DEFAULT - Default, COMMON - Coomon, BUNCH - Bunch, TRASH - Trash, USER - User, SHARE - Share, Projects - Projects, Favorites - Favourites, Recent - Recent, Templates - Templates, Privacy - Privacy, VirtualRooms - Virtual rooms, FillingFormsRoom - Filling forms room, EditingRoom - Editing room, CustomRoom - Custom room, Archive - Archive, ThirdpartyBackup - Thirdparty backup, PublicRoom - Public room, ReadyFormFolder - Ready form folder, InProcessFormFolder - In process form folder, FormFillingFolderDone - Form filling folder done, FormFillingFolderInProgress - Form filling folder in progress]
Can be one of:
DEFAULT
,COMMON
,BUNCH
,TRASH
,USER
,SHARE
,Projects
,Favorites
,Recent
,Templates
,Privacy
,VirtualRooms
,FillingFormsRoom
,EditingRoom
,CustomRoom
,Archive
,ThirdpartyBackup
,PublicRoom
,ReadyFormFolder
,InProcessFormFolder
,FormFillingFolderDone
,FormFillingFolderInProgress
.- .
enum of integer
[0 - Default, 1 - Coomon, 2 - Bunch, 3 - Trash, 5 - User, 6 - Share, 8 - Projects, 10 - Favourites, 11 - Recent, 12 - Templates, 13 - Privacy, 14 - Virtual rooms, 15 - Filling forms room, 16 - Editing room, 19 - Custom room, 20 - Archive, 21 - Thirdparty backup, 22 - Public room, 25 - Ready form folder, 26 - In process form folder, 27 - Form filling folder done, 28 - Form filling folder in progress]
Can be one of:
0
,1
,2
,3
,5
,6
,8
,10
,11
,12
,13
,14
,15
,16
,19
,20
,21
,22
,25
,26
,27
,28
.
- updatedBy
object
- id
string
uuid - displayName
string
- title
string
- avatar
string
- avatarOriginal
string
- avatarMax
string
- avatarMedium
string
- avatarSmall
string
- profileUrl
string
- hasAvatar
boolean
- isAnonim
boolean
- providerItem
boolean
- providerKey
string
- providerId
integer
int32 - order
string
- id
integer
int32 - rootFolderId
integer
int32 - originId
integer
int32 - originRoomId
integer
int32 - originTitle
string
- originRoomTitle
string
- canShare
boolean
- security
object
- Read
boolean
- Comment
boolean
- FillForms
boolean
- Review
boolean
- Create
boolean
- Edit
boolean
- Delete
boolean
- CustomFilter
boolean
- EditRoom
boolean
- Rename
boolean
- ReadHistory
boolean
- Lock
boolean
- EditHistory
boolean
- CopyTo
boolean
- Copy
boolean
- MoveTo
boolean
- Move
boolean
- Pin
boolean
- Mute
boolean
- EditAccess
boolean
- Duplicate
boolean
- SubmitToFormGallery
boolean
- Download
boolean
- Convert
boolean
- CopySharedLink
boolean
- ReadLinks
boolean
- Reconnect
boolean
- CreateRoomFrom
boolean
- EditForm
boolean
- CopyLink
boolean
- Embed
boolean
- folderId
integer
int32 - version
integer
int32 - versionGroup
integer
int32 - contentLength
string
- pureContentLength
integer
int64 - fileStatus
one of
- .
enum of string
[None - None, IsEditing - Is editing, IsNew - Is new, IsConverting - Is converting, IsOriginal - Is original, IsEditingAlone - Is editing alone, IsFavorite - Is favorite, IsTemplate - Is template, IsFillFormDraft - Is fill form draft]
Can be one of:
None
,IsEditing
,IsNew
,IsConverting
,IsOriginal
,IsEditingAlone
,IsFavorite
,IsTemplate
,IsFillFormDraft
.- .
enum of integer
[0 - None, 1 - Is editing, 2 - Is new, 4 - Is converting, 8 - Is original, 16 - Is editing alone, 32 - Is favorite, 64 - Is template, 128 - Is fill form draft]
Can be one of:
0
,1
,2
,4
,8
,16
,32
,64
,128
.
- mute
boolean
- viewUrl
string
uri - webUrl
string
uri - fileType
one of
- .
enum of string
[Unknown - Unknown, Archive - Archive, Video - Video, Audio - Audio, Image - Image, Spreadsheet - Spreadsheet, Presentation - Presentation, Document - Document, Pdf - Pdf]
Can be one of:
Unknown
,Archive
,Video
,Audio
,Image
,Spreadsheet
,Presentation
,Document
,Pdf
.- .
enum of integer
[0 - Unknown, 1 - Archive, 2 - Video, 3 - Audio, 4 - Image, 5 - Spreadsheet, 6 - Presentation, 7 - Document, 10 - Pdf]
Can be one of:
0
,1
,2
,3
,4
,5
,6
,7
,10
.
- fileExst
string
- comment
string
- encrypted
boolean
- thumbnailUrl
string
uri - thumbnailStatus
one of
- .
enum of string
[Waiting - Waiting, Created - Created, Error - Error, NotRequired - Not required, Creating - Creating]
Can be one of:
Waiting
,Created
,Error
,NotRequired
,Creating
.- .
enum of integer
[0 - Waiting, 1 - Created, 2 - Error, 3 - Not required, 4 - Creating]
Can be one of:
0
,1
,2
,3
,4
.
- locked
boolean
- lockedBy
string
- denyDownload
boolean
- hasDraft
boolean
- isForm
boolean
- startFilling
boolean
- inProcessFolderId
integer
int32 - inProcessFolderTitle
string
- draftLocation
object
- folderId
integer
int32 - folderTitle
string
- fileId
integer
int32 - fileTitle
string
- denySharing
boolean
- viewAccessibility
object
- ImageView
boolean
- MediaView
boolean
- WebView
boolean
- WebEdit
boolean
- WebReview
boolean
- WebCustomFilterEditing
boolean
- WebRestrictedEditing
boolean
- WebComment
boolean
- CoAuhtoring
boolean
- CanConvert
boolean
- MustConvert
boolean
- availableExternalRights
object
- requestToken
string
- lastOpened
object
- utcTime
string
date-time - timeZoneOffset
string
date-span
- fileEntryType
enum of integer
int32 Can be one of:
1
,2
.
- errorMessage
string
- startFilling
boolean
- fillingSessionId
string