GetShareUrl (files)¶
- Required for
iOS Android
See also
-
POST/wopi/files/(file_id)¶ The GetShareUrl operation returns a Share URL that is suitable for viewing a shared file when launched in a web browser. A host can support multiple Share URL types, as described by the SupportedShareUrlTypes property. The X-WOPI-UrlType request header contains the Share URL type that should be returned.
If the X-WOPI-UrlType header is not present or contains a value that is invalid or not supported by the host, the host should respond with a 501 Not Implemented.
- Parameters
file_id (string) – A string that specifies a file ID of a file managed by host. This string must be URL safe.
- Query Parameters
access_token (string) – An access token that the host will use to determine whether the request is authorized.
- Request Headers
X-WOPI-Override – The string
GET_SHARE_URL. Required.X-WOPI-UrlType – A string indicating what Share URL type to return. Required.
- Status Codes
200 OK – Success
401 Unauthorized – Invalid access token
404 Not Found – Resource not found/user unauthorized
500 Internal Server Error – Server error
501 Not Implemented – Operation not supported
See also
- Standard WOPI request and response headers
In addition to the request/response headers listed here, this operation may also use the Standard WOPI request and response headers.