GET /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments
1 min
GET
https://api.cmp.optimizely.com/v3/tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments
Path Parameters
- task_idstringrequiredExampleDescription
- step_idstringrequiredExampleDescription
- sub_step_idstringrequiredExampleDescription
Responses
200
- object
- dataTaskSubStepCommentResponse[]requiredDescription
- idstringrequiredExampleDescription
- valuestringrequiredExampleDescription
- is_resolvedbooleanrequiredDescription
- created_atstring<date-time>requiredExampleDescriptionFormatdate-time
- modified_atstring<date-time>requiredExampleDescriptionFormatdate-time
- attachmentsAttachmentResponse[]requiredDescription
- idstringrequiredExampleDescription
- namestringrequiredExampleDescription
- urlstringrequiredExampleDescription
- linksobjectDescription
- selfstringrequiredExampleDescription
- comment_bystringrequiredExampleDescription
- taskstringrequiredExampleDescription
- sub_stepstringrequiredExampleDescription
- paginationobjectrequired
- Pagination
- nextstringrequiredExampleDescription
- previousstringrequiredDescription
- object
- nextstringExample
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 GET \
--url https://api.cmp.optimizely.com/v3/tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.cmp.optimizely.com/v3/tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_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/tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.cmp.optimizely.com/v3/tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// List of fetched task substep comments
{
"data": [
{
"id": "5fe38c39574b52a62a089239",
"value": "Well done!",
"is_resolved": false,
"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": {
"self": "https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/steps/6d7f910551b00a722e0418830cee5564/sub-steps/9c7f910551b00a722e0418830cee2564",
"comment_by": "https://api.cmp.optimizely.com/v3/users/5fe38eea574b52a62a08923a",
"task": "https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534",
"sub_step": "https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/steps/6d7f910551b00a722e0418830cee5564/sub-steps/9c7f910551b00a722e0418830cee2564"
}
}
],
"pagination": {}
}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": ""
}