Rename a File |
Changes the name of an existing file to a different name.
|
Note: For more information about this command, including descriptions of any path and request parameters, request body schema, response codes and schemas, and payload examples, refer to the online API reference for this command at the following web page: |
URI
https://bartendercloud.com/api/librarian/files/{fileId}/rename
|
Note: The bartendercloud.com domain that is referenced in the URI and in the code example that follows must be replaced with the contents of the DataCenterURI claim that is extracted from your access token. For more information, refer to Extracting the DataCenterURI Claim. |
Path Parameters
fileId
Type: String
Specifies the ID of the file. Required.
Query Parameters
None.
Example
- C#
Request body: See FileRenameRequest.
Response: A FileChange object is returned that provides details about the file.
// Assume that fileId is the ID of the file to rename.
var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", $"Bearer {accessToken}");
var renameRequest = new FileRenameRequest() {
Name = "SQL Script2",
Comment = "Renaming SQL Script file to SQL Script2"
};
HttpRequestMessage request = new HttpRequestMessage(new HttpMethod("PATCH"), new Uri($"https://bartendercloud.com/api/librarian/files/{fileId}/rename"))
{
Content = new StringContent(JsonConvert.SerializeObject(renameRequest), Encoding.UTF8, "application/json")
};
HttpResponseMessage msg = await client.SendAsync(request);
if (msg.IsSuccessStatusCode)
{
return JsonConvert.DeserializeObject<FileChange>(await msg.Content.ReadAsStringAsync());
}