Create a comment
curl --request POST \
--url https://api-staging.pixwel.com/api/comments \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"_id": "507f1f77bcf86cd799439011",
"workRequest": "507f1f77bcf86cd799439011",
"user": {
"_id": "507f1f77bcf86cd799439011",
"name": "<string>",
"emailNormal": "user@example.com",
"groups": [
{
"_id": "507f1f77bcf86cd799439011",
"name": "<string>",
"$links": {
"self": "//example.com/path/to/object"
}
}
]
},
"body": "<string>",
"urls": {
"workRequest": "https://example.com/path/to/object"
},
"resolved": true,
"created": 123,
"$links": {
"self": "//example.com/path/to/object",
"workRequest": "//example.com/path/to/object",
"user": "//example.com/path/to/object"
},
"replies": "<unknown>"
}
'import requests
url = "https://api-staging.pixwel.com/api/comments"
payload = {
"_id": "507f1f77bcf86cd799439011",
"workRequest": "507f1f77bcf86cd799439011",
"user": {
"_id": "507f1f77bcf86cd799439011",
"name": "<string>",
"emailNormal": "user@example.com",
"groups": [
{
"_id": "507f1f77bcf86cd799439011",
"name": "<string>",
"$links": { "self": "//example.com/path/to/object" }
}
]
},
"body": "<string>",
"urls": { "workRequest": "https://example.com/path/to/object" },
"resolved": True,
"created": 123,
"$links": {
"self": "//example.com/path/to/object",
"workRequest": "//example.com/path/to/object",
"user": "//example.com/path/to/object"
},
"replies": "<unknown>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
_id: '507f1f77bcf86cd799439011',
workRequest: '507f1f77bcf86cd799439011',
user: {
_id: '507f1f77bcf86cd799439011',
name: '<string>',
emailNormal: 'user@example.com',
groups: [
{
_id: '507f1f77bcf86cd799439011',
name: '<string>',
$links: {self: '//example.com/path/to/object'}
}
]
},
body: JSON.stringify('<string>'),
urls: {workRequest: 'https://example.com/path/to/object'},
resolved: true,
created: 123,
$links: {
self: '//example.com/path/to/object',
workRequest: '//example.com/path/to/object',
user: '//example.com/path/to/object'
},
replies: '<unknown>'
})
};
fetch('https://api-staging.pixwel.com/api/comments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-staging.pixwel.com/api/comments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'_id' => '507f1f77bcf86cd799439011',
'workRequest' => '507f1f77bcf86cd799439011',
'user' => [
'_id' => '507f1f77bcf86cd799439011',
'name' => '<string>',
'emailNormal' => 'user@example.com',
'groups' => [
[
'_id' => '507f1f77bcf86cd799439011',
'name' => '<string>',
'$links' => [
'self' => '//example.com/path/to/object'
]
]
]
],
'body' => '<string>',
'urls' => [
'workRequest' => 'https://example.com/path/to/object'
],
'resolved' => true,
'created' => 123,
'$links' => [
'self' => '//example.com/path/to/object',
'workRequest' => '//example.com/path/to/object',
'user' => '//example.com/path/to/object'
],
'replies' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-staging.pixwel.com/api/comments"
payload := strings.NewReader("{\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"workRequest\": \"507f1f77bcf86cd799439011\",\n \"user\": {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"name\": \"<string>\",\n \"emailNormal\": \"user@example.com\",\n \"groups\": [\n {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"name\": \"<string>\",\n \"$links\": {\n \"self\": \"//example.com/path/to/object\"\n }\n }\n ]\n },\n \"body\": \"<string>\",\n \"urls\": {\n \"workRequest\": \"https://example.com/path/to/object\"\n },\n \"resolved\": true,\n \"created\": 123,\n \"$links\": {\n \"self\": \"//example.com/path/to/object\",\n \"workRequest\": \"//example.com/path/to/object\",\n \"user\": \"//example.com/path/to/object\"\n },\n \"replies\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-staging.pixwel.com/api/comments")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"workRequest\": \"507f1f77bcf86cd799439011\",\n \"user\": {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"name\": \"<string>\",\n \"emailNormal\": \"user@example.com\",\n \"groups\": [\n {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"name\": \"<string>\",\n \"$links\": {\n \"self\": \"//example.com/path/to/object\"\n }\n }\n ]\n },\n \"body\": \"<string>\",\n \"urls\": {\n \"workRequest\": \"https://example.com/path/to/object\"\n },\n \"resolved\": true,\n \"created\": 123,\n \"$links\": {\n \"self\": \"//example.com/path/to/object\",\n \"workRequest\": \"//example.com/path/to/object\",\n \"user\": \"//example.com/path/to/object\"\n },\n \"replies\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.pixwel.com/api/comments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"workRequest\": \"507f1f77bcf86cd799439011\",\n \"user\": {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"name\": \"<string>\",\n \"emailNormal\": \"user@example.com\",\n \"groups\": [\n {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"name\": \"<string>\",\n \"$links\": {\n \"self\": \"//example.com/path/to/object\"\n }\n }\n ]\n },\n \"body\": \"<string>\",\n \"urls\": {\n \"workRequest\": \"https://example.com/path/to/object\"\n },\n \"resolved\": true,\n \"created\": 123,\n \"$links\": {\n \"self\": \"//example.com/path/to/object\",\n \"workRequest\": \"//example.com/path/to/object\",\n \"user\": \"//example.com/path/to/object\"\n },\n \"replies\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "507f1f77bcf86cd799439011",
"workRequest": "507f1f77bcf86cd799439011",
"user": {
"_id": "507f1f77bcf86cd799439011",
"name": "<string>",
"emailNormal": "user@example.com",
"groups": [
{
"_id": "507f1f77bcf86cd799439011",
"name": "<string>",
"$links": {
"self": "//example.com/path/to/object"
}
}
]
},
"body": "<string>",
"urls": {
"workRequest": "https://example.com/path/to/object"
},
"resolved": true,
"created": 123,
"$links": {
"self": "//example.com/path/to/object",
"workRequest": "//example.com/path/to/object",
"user": "//example.com/path/to/object"
},
"replies": "<unknown>"
}Comments
Create a comment
POST
/
comments
Create a comment
curl --request POST \
--url https://api-staging.pixwel.com/api/comments \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"_id": "507f1f77bcf86cd799439011",
"workRequest": "507f1f77bcf86cd799439011",
"user": {
"_id": "507f1f77bcf86cd799439011",
"name": "<string>",
"emailNormal": "user@example.com",
"groups": [
{
"_id": "507f1f77bcf86cd799439011",
"name": "<string>",
"$links": {
"self": "//example.com/path/to/object"
}
}
]
},
"body": "<string>",
"urls": {
"workRequest": "https://example.com/path/to/object"
},
"resolved": true,
"created": 123,
"$links": {
"self": "//example.com/path/to/object",
"workRequest": "//example.com/path/to/object",
"user": "//example.com/path/to/object"
},
"replies": "<unknown>"
}
'import requests
url = "https://api-staging.pixwel.com/api/comments"
payload = {
"_id": "507f1f77bcf86cd799439011",
"workRequest": "507f1f77bcf86cd799439011",
"user": {
"_id": "507f1f77bcf86cd799439011",
"name": "<string>",
"emailNormal": "user@example.com",
"groups": [
{
"_id": "507f1f77bcf86cd799439011",
"name": "<string>",
"$links": { "self": "//example.com/path/to/object" }
}
]
},
"body": "<string>",
"urls": { "workRequest": "https://example.com/path/to/object" },
"resolved": True,
"created": 123,
"$links": {
"self": "//example.com/path/to/object",
"workRequest": "//example.com/path/to/object",
"user": "//example.com/path/to/object"
},
"replies": "<unknown>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
_id: '507f1f77bcf86cd799439011',
workRequest: '507f1f77bcf86cd799439011',
user: {
_id: '507f1f77bcf86cd799439011',
name: '<string>',
emailNormal: 'user@example.com',
groups: [
{
_id: '507f1f77bcf86cd799439011',
name: '<string>',
$links: {self: '//example.com/path/to/object'}
}
]
},
body: JSON.stringify('<string>'),
urls: {workRequest: 'https://example.com/path/to/object'},
resolved: true,
created: 123,
$links: {
self: '//example.com/path/to/object',
workRequest: '//example.com/path/to/object',
user: '//example.com/path/to/object'
},
replies: '<unknown>'
})
};
fetch('https://api-staging.pixwel.com/api/comments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-staging.pixwel.com/api/comments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'_id' => '507f1f77bcf86cd799439011',
'workRequest' => '507f1f77bcf86cd799439011',
'user' => [
'_id' => '507f1f77bcf86cd799439011',
'name' => '<string>',
'emailNormal' => 'user@example.com',
'groups' => [
[
'_id' => '507f1f77bcf86cd799439011',
'name' => '<string>',
'$links' => [
'self' => '//example.com/path/to/object'
]
]
]
],
'body' => '<string>',
'urls' => [
'workRequest' => 'https://example.com/path/to/object'
],
'resolved' => true,
'created' => 123,
'$links' => [
'self' => '//example.com/path/to/object',
'workRequest' => '//example.com/path/to/object',
'user' => '//example.com/path/to/object'
],
'replies' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-staging.pixwel.com/api/comments"
payload := strings.NewReader("{\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"workRequest\": \"507f1f77bcf86cd799439011\",\n \"user\": {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"name\": \"<string>\",\n \"emailNormal\": \"user@example.com\",\n \"groups\": [\n {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"name\": \"<string>\",\n \"$links\": {\n \"self\": \"//example.com/path/to/object\"\n }\n }\n ]\n },\n \"body\": \"<string>\",\n \"urls\": {\n \"workRequest\": \"https://example.com/path/to/object\"\n },\n \"resolved\": true,\n \"created\": 123,\n \"$links\": {\n \"self\": \"//example.com/path/to/object\",\n \"workRequest\": \"//example.com/path/to/object\",\n \"user\": \"//example.com/path/to/object\"\n },\n \"replies\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-staging.pixwel.com/api/comments")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"workRequest\": \"507f1f77bcf86cd799439011\",\n \"user\": {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"name\": \"<string>\",\n \"emailNormal\": \"user@example.com\",\n \"groups\": [\n {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"name\": \"<string>\",\n \"$links\": {\n \"self\": \"//example.com/path/to/object\"\n }\n }\n ]\n },\n \"body\": \"<string>\",\n \"urls\": {\n \"workRequest\": \"https://example.com/path/to/object\"\n },\n \"resolved\": true,\n \"created\": 123,\n \"$links\": {\n \"self\": \"//example.com/path/to/object\",\n \"workRequest\": \"//example.com/path/to/object\",\n \"user\": \"//example.com/path/to/object\"\n },\n \"replies\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.pixwel.com/api/comments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"workRequest\": \"507f1f77bcf86cd799439011\",\n \"user\": {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"name\": \"<string>\",\n \"emailNormal\": \"user@example.com\",\n \"groups\": [\n {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"name\": \"<string>\",\n \"$links\": {\n \"self\": \"//example.com/path/to/object\"\n }\n }\n ]\n },\n \"body\": \"<string>\",\n \"urls\": {\n \"workRequest\": \"https://example.com/path/to/object\"\n },\n \"resolved\": true,\n \"created\": 123,\n \"$links\": {\n \"self\": \"//example.com/path/to/object\",\n \"workRequest\": \"//example.com/path/to/object\",\n \"user\": \"//example.com/path/to/object\"\n },\n \"replies\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "507f1f77bcf86cd799439011",
"workRequest": "507f1f77bcf86cd799439011",
"user": {
"_id": "507f1f77bcf86cd799439011",
"name": "<string>",
"emailNormal": "user@example.com",
"groups": [
{
"_id": "507f1f77bcf86cd799439011",
"name": "<string>",
"$links": {
"self": "//example.com/path/to/object"
}
}
]
},
"body": "<string>",
"urls": {
"workRequest": "https://example.com/path/to/object"
},
"resolved": true,
"created": 123,
"$links": {
"self": "//example.com/path/to/object",
"workRequest": "//example.com/path/to/object",
"user": "//example.com/path/to/object"
},
"replies": "<unknown>"
}Authorizations
BasicAuthBearerAuth
Email address and password. A personal access token (pat_…) or session token (token-…) may also be sent in the password field, with any non-empty value as the username — a blank username short-circuits to a 401 before the token is read.
Body
application/json
Example:
"507f1f77bcf86cd799439011"
Example:
"507f1f77bcf86cd799439011"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Shape not inferred — the sampled response had no entries
Response
OK
Example:
"507f1f77bcf86cd799439011"
Example:
"507f1f77bcf86cd799439011"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Shape not inferred — the sampled response had no entries
⌘I