POST /work-requests/{id}/comments
1 min
POST
https://api.cmp.optimizely.com/v3/work-requests/{id}/comments
Path Parameters
- idstringrequiredExampleDescription
Body Parameters
- bodyCommentWithReplyCreateRequestrequiredDescription
- valuestringrequiredExampleDescriptionMin Length1
- attachmentsAttachmentRequest[]Description
- keystringrequiredExampleDescriptionMin Length1Max Length100
- namestringrequiredExampleDescriptionMin Length1
- parent_comment_idstringExampleDescription
Responses
201
- WorkRequestCommentResponse
- idstringrequiredExampleDescription
- valuestringrequiredExampleDescription
- is_resolvedbooleanrequiredDescription
- parent_comment_idstringrequiredExampleDescription
- comment_bystringrequiredExampleDescription
- created_atstring<date-time>requiredExampleDescriptionFormatdate-time
- modified_atstring<date-time>requiredExampleDescriptionFormatdate-time
- attachmentsAttachmentResponse[]requiredDescription
- idstringrequiredExampleDescription
- namestringrequiredExampleDescription
- urlstringrequiredExampleDescription
- linksobjectrequiredDescription
- work_requeststringrequiredExampleDescription
- comment_bystringrequiredExampleDescription
400
- ErrorExample
{ "message": "Unsupported arguments: a,b,c" }Description- messagestringrequiredExampleDescription
- errorsmap<string, string>Description
401
- ErrorExample
{ "message": "Unauthorized" }Description- messagestringrequiredExampleDescription
- errorsmap<string, string>Description
403
- ErrorExample
{ "message": "You do not have the permission to perform this operation" }Description- messagestringrequiredExampleDescription
- errorsmap<string, string>Description
404
- ErrorExample
{ "message": "Resource not found" }Description- messagestringrequiredExampleDescription
- errorsmap<string, string>Description
curl
curl --request POST \
--url https://api.cmp.optimizely.com/v3/work-requests/{id}/comments \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data-raw '{
"value": "Comment mentioning @[Organization User](https://api.cmp.optimizely.com/v3/users/5fe38aeb574b52a62a089238)",
"attachments": [
{
"key": "ce8995aea58b11ea8cd90242ac120005",
"name": "sample_image.png"
}
]
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"value": "Comment mentioning @[Organization User](https://api.cmp.optimizely.com/v3/users/5fe38aeb574b52a62a089238)",
"attachments": [
{
"key": "ce8995aea58b11ea8cd90242ac120005",
"name": "sample_image.png"
}
]
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.cmp.optimizely.com/v3/work-requests/{id}/comments", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.cmp.optimizely.com/v3/work-requests/{id}/comments")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
"value": "Comment mentioning @[Organization User](https://api.cmp.optimizely.com/v3/users/5fe38aeb574b52a62a089238)",
"attachments": [
{
"key": "ce8995aea58b11ea8cd90242ac120005",
"name": "sample_image.png"
}
]
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.cmp.optimizely.com/v3/work-requests/{id}/comments"
payload = json.dumps({
"value": "Comment mentioning @[Organization User](https://api.cmp.optimizely.com/v3/users/5fe38aeb574b52a62a089238)",
"attachments": [
{
"key": "ce8995aea58b11ea8cd90242ac120005",
"name": "sample_image.png"
}
]
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
201
// Created comment for the work request
{
"id": "5fe38c39574b52a62a089239",
"value": "Well done!",
"is_resolved": false,
"parent_comment_id": "5fe38c39574b52a62a089238",
"comment_by": "62a8455e29fed3045d9c7a8b",
"created_at": "2020-10-06T13:15:30Z",
"modified_at": "2020-10-06T14:15:30Z",
"attachments": [
{
"id": "5a7f910511b0a72230ce6631",
"name": "sample_image.png",
"url": "https://files.cmp.optimizely.com/download/2115bfe4450c11ebaae8000c291b51d4"
}
],
"links": {
"work_request": "https://api.cmp.optimizely.com/v3/work-requests/da80cfd7bbf84959a8a981acbad996b3",
"comment_by": "https://api.cmp.optimizely.com/v3/users/62a8455e29fed3045d9c7a8b"
}
}400
// Client error
{
"message": "Not found",
"errors": ""
}401
// Authorization error
{
"message": "Not found",
"errors": ""
}403
// Permission error
{
"message": "Not found",
"errors": ""
}404
// Not found error
{
"message": "Not found",
"errors": ""
}