REST API - Defining a Comment in the Request Body
6 min
when adding or updating a comment, you must specify the comment text in the request body method to submit information using the http post method instead of http patch, you must add the following information to the request header to override the patch method x http method override patch parameters the following parameters must be specified within the comment element description write your comment in this element plain text formatting, html and inline styling are supported if using html, the best practice is to use both \<html> and \<body> tags external style sheets are not supported status identifies the status of the comment for example open or closed status values are configurable you must specify a valid status value you can obtain the status value of a comment via the rest api get artifact request docid\ wkudb4wm9kw7rqoykf hk request examples addcomment example here is an example of a request body in xml format \<?xml version="1 0" ?>\<comment xmlns\ i="http //www w3 org/2001/xmlschema instance" xmlns="http //www blueprintsys com/blueprint/api/v1"> \<description>comment created by api\</description> \<status>open\</status>\</comment> here is an example of a request body in json format { "status" "open", "description" "comment created by api"} updatecomment example here is an example of a request body in xml format \<?xml version="1 0" ?>\<comment xmlns\ i="http //www w3 org/2001/xmlschema instance" xmlns="http //www blueprintsys com/blueprint/api/v1"> \<description>comment created by api\</description> \<status>open\</status>\</comment> here is an example of a request body in json format { "status" "open", "description" "comment created by api"}