RenameContainer

POST (/wopi/containers/(container_id)

The RenameContainer operation renames a container.

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 RENAME_CONTAINER. Required.

• X-WOPI-RequestedName – A UTF-7 encoded string that is a container name. Required.

Response Headers

• X-WOPI-InvalidContainerNameError – A string describing the reason the RenameContainer operation could not be completed. This header should only be included when the response code is 400 Bad Request. This string is only used for logging purposes.

Status Codes

• 200 OK – Success

• 400 Bad Request – Specified name is illegal

• 401 Unauthorized – Invalid access token

• 404 Not Found – Resource not found/user unauthorized

• 409 Conflict – Target container already exists

• 500 Internal Server Error – Server error

• 501 Not Implemented – Operation not supported

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 RenameContainer call is JSON containing the following required property:

• Name (string) - The name of the renamed container.