3.3.5.1.2.2 Response Body
The response body is JavaScript Object Notation (JSON) (as specified in [RFC4627]) with the following parameters:
JSON:
-
{ "AADUserObjectId":{"type":"string","default":"","optional":true}, "AccessTokenExpiry":{"type":"long","default":0,"optional":true}, "AllowAddActivitiesUserBatching":{"type":"bool","default":false,"optional":true}, "AllowAdditionalMicrosoftServices":{"type":"bool","default":false,"optional":true}, "AllowEarlyFeatures":{"type":"bool","default":false,"optional":true}, "AllowErrorReportPrompt":{"type":"bool","default":false,"optional":true}, "AllowExternalMarketplace":{"type":"bool","default":false,"optional":true}, "AppCatalogUrl":{"type":"string","default":"","optional":true}, "AppliedPolicyId":{"type":"string","default":"","optional":true}, "BaseFileName":{"type":"string","default":"","optional":false}, "BreadcrumbBrandName":{"type":"string","default":"","optional":true}, "BreadcrumbBrandUrl":{"type":"string","default":"","optional":true}, "BreadcrumbDocName":{"type":"string","default":"","optional":true}, "BreadcrumbDocUrl":{"type":"string","default":"","optional":true}, "BreadcrumbFolderName":{"type":"string","default":"","optional":true}, "BreadcrumbFolderUrl":{"type":"string","default":"","optional":true}, "ClientUrl":{"type":"string","default":"","optional":true}, "CloseButtonClosesWindow":{"type":"bool","default":false,"optional":true}, "ClosePostMessage":{"type":"bool","default":false,"optional":true}, "CloseUrl":{"type":"string","default":"","optional":true}, "DirectInvokeDAVUrl":{"type":"string","default":"","optional":true}, "DisableBrowserCachingOfUserContent":{"type":"bool","default":false,"optional":true}, "DisablePrint":{"type":"bool","default":false,"optional":true}, "DisableTranslation":{"type":"bool","default":false,"optional":true}, "DownloadUrl":{"type":"string","default":"","optional":true}, "EditAndReplyUrl":{"type":"string","default":"","optional":true}, "EditingCannotSave":{"type":"bool","default":false,"optional":true}, "EditModePostMessage":{"type":"bool","default":false,"optional":true}, "EditNotificationPostMessage":{"type":"bool","default":false,"optional":true}, "EmbeddingPageOrigin":{"type":"string","default":"","optional":true}, "EmbeddingPageSessionInfo":{"type":"string","default":"","optional":true}, "EnabledApplicationFeatures":{"type":"string[]","default":[],"optional":true}, "FileEmbedCommandPostMessage":{"type":"bool","default":false,"optional":true}, "FileEmbedCommandUrl":{"type":"string","default":"","optional":true}, "FileExtension":{"type":"string","default":"","optional":true}, "FileNameMaxLength":{"type":"integer","default":250,"optional":true}, "FileSharingPostMessage":{"type":"bool","default":false,"optional":true}, "FileSharingUrl":{"type":"string","default":"","optional":true}, "FileUrl":{"type":"string","default":"","optional":true}, "FileVersionPostMessage":{"type":"bool","default":false,"optional":true}, "FileVersionUrl":{"type":"string","default":"","optional":true}, "HostAuthenticationId":{"type":"string","default":"","optional":true}, "HostAuthenticationIdType":{"type":"string","default":"","optional":true}, "HostDivSyndicationViewUrl":{"type":"string","default":"","optional":true}, "HostEditUrl":{"type":"string","default":"","optional":true}, "HostEmbeddedEditUrl":{"type":"string","default":"","optional":true}, "HostEmbeddedViewUrl":{"type":"string","default":"","optional":true}, "HostName":{"type":"string","default":"","optional":true}, "HostNotes":{"type":"string","default":"","optional":true}, "HostRestUrl"{"type":"string","default":"","optional":true}, "HostViewUrl":{"type":"string","default":"","optional":true}, "InsertImagePostMessage":{"type":"bool","default":false,"optional":true}, "IrmPolicyDescription":{"type":"string","default":"","optional":true}, "IrmPolicyTitle":{"type":"string","default":"","optional":true}, "IsAnonymousUser":{"type":"bool","default":false,"optional":true}, "IsEduUser":{"type":"bool","default":false,"optional":true}, "IsYammerEnabled":{"type":"bool","default":false,"optional":true}, "LastModifiedTime":{"type":"string","default":"","optional":true}, "LicenseCheckForEditIsEnabled":{"type":"bool","default":false,"optional":true}, "LicensedOrganization":{"type":"string","default":"","optional":true}, "OfficeCollaborationServiceEndpointUrl":{"type":"string","default":"","optional":false}, "OpenInClientCommandUrl":{"type":"string","default":"","optional":false}, "OpenInClientPostMessage":{"type":"bool","default":false,"optional":false}, "OwnerId":{"type":"string","default":"","optional":false}, "PermissionsPostMessage":{"type":"bool","default":false,"optional":true}, "PolicyCheckPostMessage":{"type":"bool","default":false,"optional":true}, "PostMessageOrigin":{"type":"string","default":"","optional":true}, "PresenceProvider":{"type":"string","default":"","optional":true}, "PresenceUserId":{"type":"string","default":"","optional":true}, "PrivacyUrl":{"type":"string","default":"","optional":true}, "ProtectedFile":{"type":"bool","default":false,"optional":true}, "ProtectInClient":{"type":"bool","default":false,"optional":true}, "ReadOnly":{"type":"bool","default":false,"optional":true}, "ReportAbusePostMessage":{"type":"bool","default":false,"optional":true}, "ReportAbuseUrl":{"type":"string","default":"","optional":true}, "RestrictedWebViewOnly":{"type":"bool","default":false,"optional":true}, "SafeLinksStatus":{"type":"string","default":"","optional":true}, "SHA256":{"type":"string","default":"","optional":true}, "SignInUrl":{"type":"string","default":"","optional":true}, "SignoutUrl":{"type":"string","default":"","optional":true}, "Size":{"type":"integer","default":-1,"optional":false}, "SupportedShareUrlTypes":{"type":"string[]","default":[],"optional":true}, "SupportsAddActivities":{"type":"bool","default":false,"optional":true}, "SupportsCheckPolicy":{"type":"bool","default":false,"optional":true}, "SupportsCheckUserAccess":{"type":"bool","default":false,"optional":true}, "SupportsCoauth":{"type":"bool","default":false,"optional":true}, "SupportsCobalt":{"type":"bool","default":false,"optional":true}, "SupportsContactsResolution":{"type":"bool","default":false,"optional":true}, "SupportsContainers":{"type":"bool","default":false,"optional":true}, "SupportsDeleteFile":{"type":"bool","default":false,"optional":true}, "SupportsEcosystem":{"type":"bool","default":false,"optional":true}, "SupportsExtendedLockLength":{"type":"bool","default":false,"optional":true}, "SupportsFileCreation":{"type":"bool","default":false,"optional":true}, "SupportsFileUserValue":{"type":"bool","default":false,"optional":true}, "SupportsFolders":{"type":"bool","default":false,"optional":true}, "SupportsGetActivities":{"type":"bool","default":false,"optional":true}, "SupportsGetLock":{"type":"bool","default":false,"optional":true}, "SupportsGrantUserAccess":{"type":"bool","default":false,"optional":true}, "SupportsLocks":{"type":"bool","default":false,"optional":true}, "SupportsPolicies":{"type":"bool","default":false,"optional":true}, "SupportsRename":{"type":"bool","default":false,"optional":true}, "SupportsReviewing":{"type":"bool","default":false,"optional":true}, "SupportsScenarioLinks":{"type":"bool","default":false,"optional":true}, "SupportsSecureStore":{"type":"bool","default":false,"optional":true}, "SupportsUpdate":{"type":"bool","default":false,"optional":true}, "SupportsUserInfo":{"type":"bool","default":false,"optional":true}, "TenantId"{"type":"string","default":"","optional":true}, "TermsOfUseUrl":{"type":"string","default":"","optional":true}, "TimeZone"{"type":"string","default":"","optional":true}, "UniqueContentId":{"type":"string","default":"","optional":true}, "UserCanAttend":{"type":"bool","default":false,"optional":true}, "UserCanNotWriteRelative":{"type":"bool","default":false,"optional":true}, "UserCanPresent":{"type":"bool","default":false,"optional":true}, "UserCanRename":{"type":"bool","default":false,"optional":true}, "UserCanReview":{"type":"bool","default":false,"optional":true}, "UserCanWrite":{"type":"bool","default":false,"optional":true}, "UserFriendlyName":{"type":"string","default":"","optional":true}, "UserId":{"type":"string","default":"","optional":true}, "UserInfo":{"type":"string","default":"","optional":true}, "UserPrincipalName":{"type":"string","default":"","optional":false}, "Version":{"type":"string","default":"","optional":false}, "WebEditingDisabled":{"type":"bool","default":false,"optional":true}, "WorkflowPostMessage":{"type":"bool","default":"","optional":true}, "WorkflowType":{"type":"string[]","default":[],"optional":true}, "WorkflowUrl":{"type":"string","default":"","optional":true}, }
AADUserObjectId: A string value that uniquely identifies an Azure Active Directory (Azure AD) user.<2>
AccessTokenExpiry: A long value which is the timestamp of when the access token expires.<3>
AllowAddActivitiesUserBatching: A Boolean value. True indicates user's activities are allowed to be batched with other users' activities in an AddActivities operation (section 3.3.5.1.1).<4>
AllowAdditionalMicrosoftServices: A Boolean value that indicates the WOPI client allows connections to external Microsoft services to provide additional functionality.<5> If this value is false, then the WOPI client MUST NOT allow such connections.
AllowEarlyFeatures: A Boolean value. True Indicates the server supports allowing the user to be exposed to early features.<6>
AllowErrorReportPrompt: A Boolean value. True indicates that the server allows us to prompt the user for additional information if they hit a failure.<7>
AllowExternalMarketplace: A Boolean value that indicates the WOPI client allows connections to external services referenced in the file (for example, a marketplace of embeddable JavaScript apps). If this value is false, then the WOPI client MUST NOT allow such connections.
AppCatalogUrl: A string value that is the base URL used to create calls to retrieve a catalog of applications.<8>
AppliedPolicyId: A string value which is the identifier of the policy applied on the file.<9>
BaseFileName: The name of the file without the path. Used for display in user interface (UI), and determining the extension of the file.
BreadcrumbBrandName: A string that the WOPI client displays to the user that indicates the brand name of the WOPI server.
BreadcrumbBrandUrl: A URI to a web page that the WOPI client navigates to when the user clicks on UI that displays BreadcrumbBrandName.
BreadcrumbDocName: A string that the WOPI client displays to the user that indicates the name of the file.
BreadcrumbDocUrl: A string value which MAY specifies a URI to a web page that the WOPI client navigates to when the user clicks on UI that displays BreadcrumbDocName.<10>
BreadcrumbFolderName: A string that the WOPI client displays to the user that indicates the name of the folder that contains the file.
BreadcrumbFolderUrl: A URI to a web page that the WOPI client navigates to when the user clicks on UI that displays BreadcrumbFolderName.
ClientUrl: A user-accessible URI directly to the file intended for opening the file through a client. Can be a DAV URL ([RFC5323]), but MAY be any URL that can be handled by a client that can open a file of the given type.
CloseButtonClosesWindow: A Boolean value that indicates that the WOPI client SHOULD close the browser window containing the output of the WOPI client when the user calls the close UI.
ClosePostMessage: A Boolean value that indicates that the WOPI client SHOULD notify the WOPI server in the event that the user closes the rendering or editing client currently using this file.<11>
CloseURL: A URI to a web page that the implementer deems useful to a user in the event that the user closes the rendering or editing client currently using this file.
DirectInvokeDAVUrl: A string value that indicates the URL used when document could not be opened in client.<12>
DisableBrowserCachingOfUserContent: A Boolean value that indicates that the WOPI client MUST disable caching of file contents in the browser cache.
DisablePrint: A Boolean value that indicates that the WOPI client MUST disable any print functionality under its control.
DisableTranslation: A Boolean value that indicates that the WOPI client MUST NOT permit the use of machine translation functionality that is exposed by the WOPI client.
DownloadUrl: A user-accessible URI to the file intended to allow the user to download a copy of the file.<13>
EditAndReplyUrl: A URI to a web page that provides an editing experience for the file, utilizing the WOPI client.
EditingCannotSave: A Boolean value. True indicates that this server will allow editing files but not save them.<14>
EditModePostMessage: A Boolean value that indicates that the WOPI client SHOULD notify the WOPI server in the event that the user attempts to edit the file.
EditNotificationPostMessage: A Boolean value that indicates that the WOPI client SHOULD notify the WOPI server in the event that the user attempts to edit the file.<15>
EmbeddingPageOrigin: A string value that provides the origin for the embedding page. <16>
EmbeddingPageSessionInfo: A string value that provides the session information for the embedding page. This is used during the handshake between WOPI client and the embedding page. <17>
EnabledApplicationFeatures: An array of strings which is the list of features supported by a given server.<18>
FileEmbedCommandPostMessage: A Boolean value. True indicates the WOPI client will notify the WOPI server in the event that the user attempts to embed file. <19>
FileEmbedCommandUrl: A string value that is the URL to the server’s unique file embedding UI experience. <20>
FileExtension: A string specifying the file extension of the file. This value MUST begin with a ".".<21>
FileNameMaxLength: An integer indicating the maximum length for file names, including the file extension, supported by the WOPI server.
FileSharingUrl: A URI to a location that allows the user to share the file.
FileSharingPostMessage: A Boolean value that indicates that the WOPI client SHOULD notify the WOPI server in the event that the user attempts to share the file.<22>
FileUrl: A URI to the file location that the WOPI client uses to get the file. If this is provided, a WOPI client MUST use this URI to get the file instead of HTTP://server/<...>/wopi*/files/<id>/contents (see section 3.3.5.3).
FileVersionPostMessage: A Boolean value. True indicates that the WOPI client will notify the WOPI server in the event that the user attempts to navigate to a previous file version.<23>
FileVersionUrl: A string value which is the URL that WOPI client navigate to a previous file version. <24>
HostAuthenticationId: A string that is used by the WOPI server to uniquely identify the user.
HostAuthenticationIdType: A string value that indicates the type of authentication used by the server. <25>
HostDivSyndicationViewUrl: A string value which is the URL to the server's div syndication embedded viewer for this item. <26>
HostEditUrl: A URI to a web page that provides an editing experience for the file, utilizing the WOPI client.
HostEmbeddedEditUrl: A URI to a web page that provides access to an editing experience for the file that can be embedded in another HTML page. For example, a page that provides an HTML snippet that can be inserted into the HTML of a blog.
HostEmbeddedViewUrl: A URI to a web page that provides access to a viewing experience for the file that can be embedded in another HTML page. For example, a page that provides an HTML snippet that can be inserted into the HTML of a blog.
HostName: A string that is the name provided by the WOPI server used to identify it for logging and other informational purposes.
HostNotes: A string that is used by the WOPI server to pass arbitrary information to the WOPI client. The WOPI client MAY ignore this string if it does not recognize the contents. A WOPI server MUST NOT require that a WOPI client understand the contents of this string to operate.
HostRestUrl: A URI that is the base URI for REST operations for the file.
HostViewUrl: A URI to a web page that provides a viewing experience for the file utilizing the WOPI client.
InsertImagePostMessage: A Boolean value. True indicates the server supports an image picker to insert online pictures from their servers. <27>
IrmPolicyDescription: A string that the WOPI client SHOULD display to the user indicating the Information Rights Management (IRM) policy for the file. This value SHOULD be combined with IrmPolicyTitle.
IrmPolicyTitle: A string that the WOPI client SHOULD display to the user indicating the IRM policy for the file. This value SHOULD be combined with IrmPolicyDescription.
IsAnonymousUser: A Boolean value. True indicates the user is anonymous. <28>
IsEduUser: A Boolean value. True indicates that the current user is a user from an educational organization. <29>
IsYammerEnabled: A Boolean value. True indicates the Yammer discussion panel is enabled in this context. <30>
LastModifiedTime: A string value indicates the last time the file was modified. <31>
LicenseCheckInEditIsEnabled: A Boolean value that indicates that the WOPI client SHOULD take measures to ensure the user is properly licensed prior to allowing editing of the file.
LicensedOrganization: A string value indicates whether license verification is by bypassed. Hosts can ask WOPI client to bypass license verification for users of specific organizations. <32>
OfficeCollaborationServiceEndpointUrl: A string value which is the URL for the Office Collaboration Service, if exists. <33>
OpenInClientCommandUrl: A string value which is the URL that WOPI client navigate to a server-controlled opening in client. <34>
OpenInClientPostMessage: A Boolean value. True indicates that the WOPI client will notify the WOPI server in the event that the user attempts to navigate to a server-controlled opening in client.<35>
OwnerId: A string that SHOULD uniquely identify the owner of the file.
PermissionsPostMessage: A Boolean value. True indicates that the WOPI client will notify the WOPI server in the event that the user attempts to share and check user permissions. <36>
PolicyCheckPostMessage: A Boolean value. True indicates that the WOPI client will notify the WOPI server in the event that the user attempts to policy check. <37>
PostMessageOrigin: A string that the WOPI client MUST use as the targetOrigin parameter when sending messages as specified in [W3C-HTML5WEBMSG].<38>
PresenceProvider: A string that identifies the provider of information that a WOPI client uses to discover information about the user’s online status (for example, whether a user is available via instant messenger). A WOPI client requires knowledge of specific presence providers to be able to take advantage of this value.
PresenceUserId: A string that identifies the user in the context of the PresenceProvider.
PrivacyUrl: A URI to a webpage that explains the privacy policy of the WOPI server.
ProtectedFile: A Boolean value. True indicates server give us a decrypted stream of a protected encrypted file. <39>
ProtectInClient: A Boolean value that indicates that the WOPI client SHOULD take measures to prevent copying and printing of the file. This is intended to help enforce IRM in WOPI clients.
ReadOnly: Indicates that, for this user, the file cannot be changed.
ReportAbusePostMessage: A Boolean value, True indicates that the WOPI client will notify the WOPI server in the event that the user attempts to report abuse. <40>
ReportAbuseUrl: A string value which is the URL to notify server for reporting abuse. <41>
RestrictedWebViewOnly: A Boolean value that indicates that the WOPI client MUST NOT allow the user to download the file or open the file in a separate application.
SafeLinksStatus: A string value indicates user's tenant is provisioned for SafeLinks protection. <42>
SHA256: If it is present and not empty, it is a 256 bit SHA-2-encoded [FIPS180-2] hash of the file contents.<43>
SignInUrl: A URI that will sign the current user into the WOPI server supported authentication system.
SignoutUrl: A URI that will sign the current user out of the WOPI server supported authentication system.
Size: The size of the file expressed in bytes.
SupportedShareUrlTypes: An array of strings indicating the share URL types supported by the WOPI server. Possible values are ReadOnly and ReadWrite.<44> The values can be passed in the X-WOPI-UrlType request header to signify which Share URL type to return for the GetShareUrl operation (section 3.3.5.1.12).
SupportsAddActivities: A Boolean value. True indicates the server supports the AddActivities operation (section 3.3.5.1.1). <45>
SupportsCheckPolicy: A Boolean value. True if server supports the CheckPolicy operation (section 3.3.5.1.3). <46>
SupportsCheckUserAccess: A Boolean value. True indicates the server supports the CheckUserAccess operation (section 3.3.5.1.4). <47>
SupportsCoauth: A Boolean value that indicates that the WOPI server supports multiple users making changes to this file simultaneously.<48>
SupportsCobalt: A Boolean value that indicates that the WOPI server supports ExecuteCellStorageRequest (see section 3.3.5.1.7) and ExecuteCellStorageRelativeRequest (see section 3.3.5.1.6) operations for this file.
SupportsContactsResolution: A Boolean value. True indicates the server supports getting contacts information. <49>
SupportsContainers: A Boolean value. True indicates the server supports persisting the containers namespace. <50>
SupportsDeleteFile: A Boolean value. True indicates the server supports the DeleteFile operation (section 3.3.5.1.5). <51>
SupportsEcosystem: A Boolean value. True indicates the server supports persisting the ecosystem namespace. <52>
SupportsExtendedLockLength: A Boolean value that indicates that the WOPI server supports lock IDs up to 1024 ASCII characters in length.<53>
SupportsFileCreation: A Boolean value that indicates that the WOPI server supports creating new files using the WOPI client.<54>
SupportsFileUserValue: A Boolean value. True indicates the server supports GetFileUserValue (section 3.3.5.1.9) and SetFileUserValue (section 3.3.5.1.21) operatons.<55>
SupportsFolders: A Boolean value that indicates that the WOPI server supports EnumerateChildren (see section 3.3.5.4.1) and DeleteFile (see section 3.3.5.1.5) operations for this file.
SupportsGetActivities: A Boolean value. True indicates the server supports the GetActivities operation (section 3.3.5.1.8). <56>
SupportsGetLock: A Boolean value that indicates that the WOPI server supports GetLock (see section 3.3.5.1.10).<57>
SupportsGrantUserAccess: A Boolean value. True indicates the server supports the GrantUserAccess operation (section 3.3.5.1.13). <58>
SupportsLocks: A Boolean value that indicates that the WOPI server supports Lock (see section 3.3.5.1.14), Unlock (see section 3.3.5.1.22), RefreshLock (see section 3.3.5.1.18), and UnlockAndRelock (see section 3.3.5.1.23) operations for this file.
SupportsPolicies: A Boolean value. True indicates the server supports Policies. <59>
SupportsRename: A Boolean value that indicates that the WOPI server supports RenameFile (see section 3.3.5.1.19).<60>
SupportsReviewing: A Boolean value. True indicates the server supports the review permission. <61>
SupportsScenarioLinks: A Boolean value that indicates that the WOPI server supports scenarios where users can operate on files in limited ways via restricted URLs.
SupportsSecureStore: A Boolean value that indicates that the WOPI server supports calls to a secure data store utilizing credentials stored in the file.
SupportsUpdate: A Boolean value that indicates that the WOPI server supports PutFile (see section 3.3.5.3.2) and PutRelativeFile (see section 3.3.5.1.15) operations for this file.
SupportsUserInfo: A Boolean value that indicates that the WOPI server supports PutUserInfo (see section 3.3.5.1.16).<62>
TenantId: A string that is used by the WOPI server to uniquely identify the tenant .
TermsOfUseUrl: A URI to a webpage that explains the terms of use policy of the WOPI server.
TimeZone: A string that is used to pass time zone information to a WOPI client in the format chosen by the WOPI server.
UniqueContentId: A string that uniquely represents the file contents.<63> This value MUST change when the file content changes. This value MUST also be equivalent for all files with equivalent contents.
UserCanAttend: A Boolean value that indicates that the user has permission to view a broadcast of this file. A broadcast is file activity that involves one or more presenters controlling the view of the file for a set of attendees. For example, a slideshow can be broadcast by a presenter to many attendees.
UserCanNotWriteRelative: A Boolean value that indicates the user does not have sufficient permissions to create new files on the WOPI server.
UserCanPresent: A Boolean value that indicates that the user has permission to broadcast this file to a set of users who have permission to broadcast or view a broadcast of this file. A broadcast is file activity that involves one or more presenters controlling the view of the file for a set of attendees. For example, a slideshow can be broadcast by a presenter to many attendees.
UserCanRename: A Boolean value that indicates the user has permissions to rename the file.<64>
UserCanReview: A Boolean value. True indicates the user has permissions to review the file. <65>
UserCanWrite: A Boolean value that indicates that the user has permissions to alter the file.
UserFriendlyName: A string that is the name of the user. If blank, the WOPI client MAY be configured to use a placeholder string in some scenarios, or to show no name at all.
UserId: A string that is used by the WOPI server to uniquely identify the user.
UserInfo: A string that the WOPI client SHOULD use to verify the user’s licensing status. The WOPI client MAY ignore this string if it does not recognize the contents.
UserPrincipalName: A string value which is the user principal name. <66>
Version: A string representing the current version of the file based on the WOPI server’s file versioning schema. This value MUST change when the file content changes, and version values MUST never repeat for a given file.
WebEditingDisabled: A Boolean value that indicates that the WOPI client MUST NOT allow the user to use the WOPI client’s editing functionality to operate on the file. This does not mean that the user doesn’t have rights to edit the file.
WorkflowPostMessage: A Boolean value that indicates that the WOPI client SHOULD notify the WOPI server in the event that the user attempts to trigger a workflow on the file.<67>
WorkflowType: An array of strings representing the workflow types that are available for the file.<68>
WorkflowUrl: A string representing the current version of the file based on the WOPI server’s file versioning schema. This value MUST change when the file content changes, and version values MUST never repeat for a given file.<69>