PUT /content/rename

Renames the specified content resource on the platform.

Note: If you rename a resource that's included in the documentation Table of Contents for your API, you'll also need to update the corresponding JSON table of contents file and upload the new JSON file using the POST /content/{path} operation. For more information, see Updating API Documentation Content.

Authorization Roles/Permissions: API Admin.

This topic includes the following sections:

HTTP Method

PUT

Back to top

URL

https://{hostname}/content/{contentpath}

Back to top

Sample Request

The example below shows a request to rename a resource. The current path and name are specified in the URL and the new name is in the request body.

Request URL

https://api.acmepaymentscorp.com/content/api/api18969.acmepaymentscorp/documents/index.htm

Sample request headers

PUT /content/api/api18969.acmepaymentscorp/documents/index.htm HTTP/1.1
Host: {hostname}
Accept: */*
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

nameTo=index_renamed.htm

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Content-Type application/x-www-form-urlencoded
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
nameTo Body string Required The new name that the resource is being renamed to.
path Path string Required The path and current filename for the resource.

Back to top

Response

If successful, this operation returns HTTP status code 200. There is no response content.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Content-Length: 0
Date: Thu, 06 Jun 2013 21:05:57 GMT

Sample response body

None.

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type None required.

Back to top

Response Body

None.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics