Update a File Change Comment |
Replaces the contents of an existing file change comment with a new comment.
|
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/filechanges/{fileChangeId}/comment
|
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
fileChangeId
Type: String
Specifies the ID of the file change to update. Required.
Query Parameters
None.
Example
- C#
Request body: See FileChangeCommentRequest.
Response: A FileChange object is returned that provides details about the file.
// Assume that changeId is the ID of the target file change to update.
var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", $"Bearer {accessToken}");
var updateRequest = new FileChangeCommentRequest() {
Comment = "Updated SQL Script comment"
};
HttpRequestMessage request = new HttpRequestMessage(new HttpMethod("PATCH"), new Uri($"https://bartendercloud.com/api/librarian/filechanges/{fileChangeId}/comment"))
{
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());
}