REST API - Update Reply Request
10 min
/api/v1/projects/{projectid}/artifacts/{artifactid}/comments/{commentid}/replies/{replyid} description updates the specified reply you can only update a reply if blueprint is configured to allow the updating of published comments and replies url structure \[blueprint uri]/api/v1/projects/{projectid}/artifacts/{artifactid}/comments/{commentid}/replies/{replyid} projectid the id of the project containing the reply you want to update artifactid the id of the artifact containing the reply you want to update commentid the id of the comment associated with the reply you want to update replyid the id of the reply you want to update supported methods patch docid\ rcjvhrlby6de zgkehxui you can override the patch method docid\ rcjvhrlby6de zgkehxui and use the post docid\ hsi lzxs8g rx ydudzkg method instead request body you must specify the new reply information in the body of the request read more about how to update the reply in the request body docid\ lpa pcrkfytrn4xixqmda http status codes 200 ok 201 successfully created 206 partial content 400 bad request this error can occur for a variety of reasons at least one uri or request body parameter is invalid, such as one of the filter docid\ sv9gjverxczcgqdn28j7u , traces, offset or limit parameters a required value has not been provided if you are submitting a post docid\ hsi lzxs8g rx ydudzkg or patch docid\ rcjvhrlby6de zgkehxui request and have not added the x http method override parameter to your request header 401 unauthorized the blueprint token is missing, invalid or expired 403 forbidden the applicable permissions are needed for example, this error can occur when an author or collaborate license is needed for access comment permissions are needed on the artifact edit permissions are needed on the change summary job 404 notfound item is not found in the project for example, this error can occur when artifact not found artifact type not found project not found alm target not found change summary job not found user does not have edit permissions for this artifact, project or alm target 409 conflict reason for failure can be found in the response body additional information may also be found in the log 411 length required if the content length header is missing in the request 413 request entity too large if the provided file size is larger than allowed 415 unsupported media type if the provided media type is not of mime multipart content "form data " 416 request range not satisfiable if offset points to a part of a collection that is not available 500 internal server error 501 not implemented examples xml example request uri https //production blueprintcloud com/api/v1/projects/220870/artifacts/220914/comments/583921/replies/233454 request body \<?xml version="1 0" ?>\<reply xmlns\ i="http //www w3 org/2001/xmlschema instance" xmlns="http //www blueprintsys com/blueprint/api/v1"> \<description>\<html\>\<head\>\</head\>\<body\>\<div\>\<p\>\<span\>\<span\>reply\</span\>\</span\>\</p\>\</div\>\</body\>\</html\>\</description>\</reply> response body \<?xml version="1 0" ?>\<string xmlns="http //schemas microsoft com/2003/10/serialization/">the reply was successfully updated \</string> json example request uri https //production blueprintcloud com/api/v1/projects/220870/artifacts/220914/comments/583921/replies/233454 request body php template { "description" "\<html>\<head>\</head>\<body>\<div>\<p>\<span>\<span>reply\</span>\</span>\</p>\</div>\</body>\</html>"} response body "the reply was successfully updated "