GetEcosystem (files)

Note

GetEcosystem (containers) returns the URI for the WOPI server’s Ecosystem endpoint, given a container ID.

GET /wopi/files/(file_id)/ecosystem_pointer

The GetEcosystem operation returns the URI for the WOPI server’s Ecosystem endpoint, given a file ID.

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.

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

Note

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.

Response

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

Url

A string URI for the WOPI server’s Ecosystem endpoint, with an access token appended. A GET request to this URL will invoke the CheckEcosystem operation.

Caution

This property includes an access token, and thus has important security implications. See Preventing ‘token trading’ for more details.