Hide or Show a File

Hides or shows a file. Hidden files do not appear in query results unless their inclusion is specifically requested.

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:

Hide or show a file

URI

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

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 FileUpdateIsHiddenRequest.

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

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

var updateRequest = new FileUpdateIsHiddenRequest() {
    IsHidden = true,
    Comment = "Hide SQL Script file"
};
HttpRequestMessage request = new HttpRequestMessage(new HttpMethod("PATCH"), new Uri($"https://bartendercloud.com/api/librarian/files/{fileId}/isHidden"))
{
   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());
}