Adding comments using OSLC
Accepted answer
This method adds comments on the Work Item represented by the changerequest :
private void updateComments(List<String> comments, final ChangeRequest changeRequest) throws IOException {
for (final String comment : comments) {
ContentProducer cp = new ContentProducer() {
public void writeTo(OutputStream outstream) throws IOException {
Writer out = new OutputStreamWriter(outstream, HTTP.UTF_8);
out.append("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n");
out.append("<rdf:RDF\n");
out.append("\t\txmlns:rtc_ext=\"http://jazz.net/xmlns/prod/jazz/rtc/ext/1.0/\"\n");
out.append("\t\txmlns:rtc_cm=\"http://jazz.net/xmlns/prod/jazz/rtc/cm/1.0/\"\n");
out.append("\t\txmlns:oslc_cm=\"http://open-services.net/ns/cm#\"\n");
out.append("\t\txmlns:dcterms=\"http://purl.org/dc/terms/\"\n");
out.append("\t\txmlns:oslc_cmx=\"http://open-services.net/ns/cm-x#\"\n");
out.append("\t\txmlns:oslc=\"http://open-services.net/ns/core#\"\n");
out.append("\t\txmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\">\n");
out.append("\t<rdf:Description \n");
out.append("\n\t\trdf:about=\"" + changeRequest.getAbout() + "\">\n");
out.append("\t<dcterms:description><![CDATA[" + comment + "]]> </dcterms:description>");
out.append("\t</rdf:Description>\n");
out.append("</rdf:RDF>\n");
out.flush();
}
};
HttpEntity entity = new EntityTemplate(cp);
HttpPost post = new HttpPost(changeRequest.getDiscussedBy() + "/oslc:comment");
post.addHeader("Accept", "application/rdf+xml");
post.addHeader("Content-type", "application/rdf+xml");
post.addHeader("OSLC-Core-Version", "2.0");
post.setEntity(entity);
// Call the PUT method against the Change Request URI
HttpResponse response = client.getHttpClient().execute(post);
response.getEntity().consumeContent();
}
}
Comments
7 other answers
There is a dedicated section in the RTC OSLC API Wiki. Have a read.
https://jazz.net/wiki/bin/view/Main/WorkItemAPIsForOSLCCM20#Adding_comments
Comments
1 vote
2 votes
showing 5 of 6
show 1 more comments
After many hours, I finally looked at the ccm.log file. The response was saying my account did not have the required group memberships. The ccm.log clarified that my account did have the necessary group memberships, but that the request was blocked because it might have been malicious and said I had to use the JSESSION ID in a CRSF Prevent header. My tool was not retrieving any such JSESSIONID in the header, so I found you could get around the check by specifying User-Agent. HERE is how I got it to work in 7.0.2:
POST:
https://EWMHost:port/ccm/oslc/workitems/12345/rtc_cm:comments/oslc:comment
Headers:
Accept: application/json
Content-Type: application/json
OSLC-Core-Version: 2.0
User-Agent: CustomInterface
Request Body:
{"dcterms:description":"My Comment"}
I've been following the link that Donald Nong provide: https://jazz.net/wiki/bin/view/Main/WorkItemAPIsForOSLCCM20#Adding_comments
But I still get the "404 Bad Request" in following 2 attempts:
1. Use the url from work item I created:
I just appended "/oslc:comment" at the end according to the documentation.
2. Use the url from the documentation:
"https://[servername]/ccm/resource/itemOid/com.ibm.team.workitem.WorkItem/_xoNikpHMEeC_rYSykUtXXA/rtc_cm:comments/oslc:comment"
I'm using C# and create work item POST call worked.
What is the right url to do a POST request to create comments?
Thanks,
Bing
Adding comments through the OSLC interface can be done like this:
/post one single comment to one work item@params {string} discussedByUri: a URI pointing to a work item discussion,can be taken e.g. from a 'oslc:discussedBy' field.@params {string} comment: a string that will be added to the work item comments section@returns {promise} a promise that indicates whether the creation was successful or not*/postComment: function(discussedByUri, comment) {if(typeof discussedByUri === "string" && discussedByUri.endsWith("/rtc_cm:comments") &&typeof comment === "string") {var commentObject = {"dcterms:description": comment};return XHR.oslcJsonPostRequest(discussedByUri + "/oslc:comment", commentObject);}},
oslcJsonPostRequest: function(url, data) {return this.xhr("POST", {url: url,headers: {"OSLC-Core-Version": "2.0","Accept": "application/json","Content-Type": "application/json"},postData: JSON.stringify(data),handleAs: "json"}, false);}
Hi Lucas,
My code sample seems too long for comments, so I had to put it as an answer. Sorry if I'm not using this correctly.
This is the url that I got from oslc:discussedBy: "https://[ServerName]/oslc/workitems/_q8RqoJoQEee2N-g-o1qd6A/rtc_cm:comments"
I also appended "/oslc:comment" at the end. This is my code. It works to create a workitem (json is the properties for the new wokitem), I'm using it for creating comments too but got 404.
HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://[ServerName]/oslc/workitems/_q8RqoJoQEee2N-g-o1qd6A/rtc_cm:comments/oslc:comment" );request.Method = "POST";request.AllowAutoRedirect = true;request.KeepAlive = true;request.Timeout = 480000;request.Credentials = context.Credential;request.Headers.Add(context.AuthHeader);request.Headers.Add("OSLC-Core-Version", "2.0");request.Accept = "application/json";request.ContentType = "application/json";request.CookieContainer = context.Cookie;using (var streamWriter = new StreamWriter(request.GetRequestStream())){streamWriter.Write(json);streamWriter.Flush();}
HttpWebResponse response = (HttpWebResponse)request.GetResponse();
Is possible to set the creation date? I'm setting it, but its not having effect. Comment on work item is being created, but not setting the date I sent:
POST
BODY
{
"dcterms:description": "comment",
"dcterms:created": "2021-02-24T15:36:33.371Z"
}
For those reading here in 2021...I've still 6.0.2 and it works in this way:
for workitem number 2613 it's quite easy
POST
Headers (KEY VALUE):
Content-Type application/json
OSLC-Core-Version 2.0
Accept application/json
BODY of the request:
{"dcterms:description": "a silly comment here"}
RESPONSE: 201 created
Response headers conains Location:
Server: Apache-Coyote/1.1
Strict-Transport-Security: max-age=31536000
Last-Modified: Wed, 18 Aug 2021 20:35:25 GMT
Cache-Control: private, max-age=31536000, must-revalidate
Expires: Sat, 04 Sep 2021 21:15:54 GMT
Vary: Accept, OSLC-Core-Version
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Wed, 18 Aug 2021 20:35:25 GMT
Accept-Ranges: none
Connection: Keep-Alive
