Restore a Deleted File

Restores a file that was marked as deleted. Files that are restored will appear in typical file queries.

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:

Restore a deleted file

URI

https://bartendercloud.com/api/librarian/files/{fileId}/restore

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 to restore. This command clears the file's "delete" flag. Required.

Query Parameters

None.

Example

Request body: See FileUpdateRequest.

Response: A FileChange object is returned that provides details about the file.

Copy
// Assume that fileId is the ID of the file to restore.
var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", $"Bearer {accessToken}");

var updateRequest = new FileUpdateRequest() {
    Comment = "Clear 'Delete' state on SQL Script file"
};
HttpRequestMessage request = new HttpRequestMessage(new HttpMethod("PATCH"), new Uri($"https://bartendercloud.com/api/librarian/files/{fileId}/restore"))
{
   Content = new StringContent(JsonConvert.SerializeObject(updateRequest), Encoding.UTF8, "application/json")
};

HttpResponseMessage msg = await client.SendAsync(request);
if (msg.IsSuccessStatusCode)
{
   return JsonConvert.DeserializeObject<FileChange>(await msg.Content.ReadAsStringAsync());
}