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: Must be logged in. API Admin.
This topic includes the following sections:
HTTP Method
PUT
URL
https://{hostname}/content/{contentpath}
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.
Sample 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_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...
Sample request body
nameTo=index_renamed.htm
Request Headers
For general information on request header values, refer to HTTP Request Headers.
Header | Description |
---|---|
Content-Type | application/x-www-form-urlencoded |
Cookie | AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies. |
X-Csrf-Token_{fedmemberID} | The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login. |
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. |
Response
If successful, this operation returns HTTP status code 200. There is no response content.
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.
Response Headers
For general information on response header values, refer to HTTP Response Headers.
Header | Description |
---|---|
Content-Type | None required. |
Response Body
None.
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. You would also get this response for any operation that requires login (almost all) if the login cookie was missing. |
500 | An error occurred processing the call. |
More information about Akana API Platform API error messages.