PUT api/File/Rename

Renames a file based on the provided request data.

Request Information

URI Parameters

None.

Body Parameters

The request containing the details for renaming the file.

RenameFileRequest
Name Description Type Additional information
ArchiveGuid

string

None.

DocId

integer

None.

FileId

integer

None.

NewFileName

string

None.

Token

Token

None.

Request Formats

application/json, text/json

Sample:
{
  "ArchiveGuid": "sample string 1",
  "DocId": 2,
  "FileId": 3,
  "NewFileName": "sample string 4",
  "Token": {
    "OrgId": 1,
    "OrgGuid": "sample string 2",
    "UserId": 3,
    "UserGuid": "sample string 4",
    "Username": "sample string 5",
    "UserNumber": "sample string 6",
    "EMail": "sample string 7",
    "CreatedAt": "2026-09-15T11:34:24.1598964+02:00",
    "ValidTo": "2026-09-15T11:34:24.1598964+02:00",
    "Realm": "sample string 10",
    "IsDelegated": true,
    "AccessKey": "sample string 12"
  }
}

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.

Response Information

Resource Description

An indicating the result of the operation. Returns a BadRequest if authentication fails, the access key is invalid, or if the renaming operation fails. Returns Ok with the response data if the operation is successful.

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.