Export (0) Print
Expand All

3.3.5.1.1.2 Response Body

Office

The response body is JavaScript Object Notation (JSON) (as specified in [RFC4627]) with the following parameters:

JSON:

{
"AllowExternalMarketplace":{"type":"bool","default":false,"optional":true},
"BaseFileName":{"type":"string","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},
"CloseUrl":{"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},
"FileSharingUrl":{"type":"string","default":"","optional":true}, 
"FileUrl":{"type":"string","default":"","optional":true},
"HostAuthenticationId"{"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},
"IrmPolicyDescription":{"type":"string","default":"","optional":true},
"IrmPolicyTitle":{"type":"string","default":"","optional":true},
"OwnerId":{"type":"string","optional":false},
"PresenceProvider"{"type":"string","default":"","optional":true},
"PresenceUserId"{"type":"string","default":"","optional":true},
"PrivacyUrl":{"type":"string","default":"","optional":true},
"ProtectInClient":{"type":"bool","default":false,"optional":true},
"ReadOnly":{"type":"bool","default":false,"optional":true},
"RestrictedWebViewOnly":{"type":"bool","default":false,"optional":true},
"SHA256":{"type":"string","optional":true},
"SignoutUrl":{"type":"string","default":"","optional":true},
"Size":{"type":"int","optional":false},
"SupportsCoauth":{"type":"bool","default":false,"optional":true},
"SupportsCobalt":{"type":"bool","default":false,"optional":true},
"SupportsFolders":{"type":"bool","default":false,"optional":true},
"SupportsLocks":{"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},
"TenantId"{"type":"string","default":"","optional":true},
"TermsOfUseUrl":{"type":"string","default":"","optional":true},
"TimeZone"{"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},
"UserCanWrite":{"type":"bool","default":false,"optional":true},
"UserFriendlyName":{"type":"string","default":"","optional":true},
"UserId":{"type":"string","default":"","optional":true},
"Version":{"type":"string","optional":false}
"WebEditingDisabled":{"type":"bool","default":false,"optional":true},
}

AllowExternalMarketplace: A Boolean value that indicates the WOPI client MAY allow 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.

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 MAY display to the user that indicates the brand name of the WOPI server.

BreadcrumbBrandUrl: A URI to a web page that the WOPI client MAY navigate to when the user clicks on UI that displays BreadcrumbBrandName.

BreadcrumbDocName: A string that the WOPI client MAY display to the user that indicates the name of the file.

BreadcrumbDocUrl: A URI to a web page that the WOPI client MAY navigate to when the user clicks on UI that displays BreadcrumbDocName.

BreadcrumbFolderName: A string that the WOPI client MAY display 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 MAY navigate 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.

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.

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.

FileSharingUrl: A URI to a location that allows the user to share the file.

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).

HostAuthenticationId: A string that is used by the WOPI server to uniquely identify the user.

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.

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.

OwnerId: A string that SHOULD uniquely identify the owner of the file.

PresenceProvider: A string that identifies the provider of information that a WOPI client MAY use 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.

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.

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.

SHA256: If it is present and not empty, it is a 256 bit SHA-2-encoded [FIPS180-2] hash of the file contents.

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.

SupportsCoauth: A Boolean value that indicates that the WOPI server supports multiple users making changes to this file simultaneously. It MUST be false.

SupportsCobalt: A Boolean value that indicates that the WOPI server supports ExecuteCellStorageRequest (see section 3.3.5.1.7) and ExcecuteCellStorageRelativeRequest (see section 3.3.5.1.8) operations for this file.

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.9) operations for this file.

SupportsLocks: A Boolean value that indicates that the WOPI server supports Lock (see section 3.3.5.1.3), Unlock (see section 3.3.5.1.4), RefreshLock (see section 3.3.5.1.5), and UnlockAndRelock (see section 3.3.5.1.6) operations for this file.

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.2) operations for this file.

TenantId: A string that is used by the WOPI server to uniquely identify the user.

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.

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.

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.

Version: The current version of the file based on the server’s file versioning schema. This value MUST change when the file 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.

Show:
© 2014 Microsoft