Compartir a través de

GetShareUrl (containers)

  • Artículo

iOS and Android Desktop

Note

GetShareUrl (files) returns a Share URL suitable for viewing a shared file when launched in a web browser.

POST (/wopi/containers/(container_id)

The GetShareUrl operation returns a Share URL that is suitable for viewing a shared container 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

  • container_id (string) – A string that specifies a container ID of a container 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

Note

In addition to the request/response headers listed here, this operation may also use the Standard WOPI request and response headers.

Response

The response to a GetShareUrl call is JSON containing the following required properties:

  • ShareUrl - A URI that points to a webpage that allows the user to access the container. Required.

    Note

    Learn more about Share Url.