PUT api/document/rename

Updates the filename of an existing document. Processes this document API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The new filename (excluding the extension)

RenameDocumentCommandDataContract
NameDescriptionTypeAdditional information
DocumentId

The unique identifier of the related document resource.

integer

None.

FileName

The file name value.

string

None.

Id

The unique identifier of this resource.

integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "DocumentId": 1,
  "FileName": "sample string 2",
  "Id": 3
}

Response Information

Resource Description

The response returned after the operation completes.

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

The version value.

Version

None.

Content

The content value.

HttpContent

None.

StatusCode

The status code classification.

HttpStatusCode

None.

ReasonPhrase

The reason phrase value.

string

None.

Headers

The collection of headers.

Collection of Object

None.

RequestMessage

The request message value.

HttpRequestMessage

None.

IsSuccessStatusCode

Indicates whether this item is success status code.

boolean

None.