PATCH documents rename

patch/api/v1/documents/{id}/rename

Request

Base URL
https://app.onecodex.com
URL
https://app.onecodex.com/api/v1/documents/{id}/rename
Auth
API key in header X-API-Key

Path parameters

idstring required

Request body

filenamestring required

Response

$uristring required

created_atstring date-time required

Timestamp for when the object was created on the One Codex platform, encoded as a RFC 3339 timestamp.

filenamestring required

The document filename (e.g., "report.pdf")

sizeinteger nullable required

The size of the document in bytes.

Example response

{
  "$uri": "/api/v1/documents/0d77065796f8d173",
  "downloaders": [
    {
      "__DOLLAR_REF__": "/api/v1/users/a1b2c3d4e5f67890"
    }
  ],
  "uploader": {
    "__DOLLAR_REF__": "/api/v1/users/a1b2c3d4e5f67890"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.