Projects

Edits a private comment on a project. Send only the fields you want to change.

Only a private comment can be edited - the same as in the app - so a public one is refused with ResourceUpdateBlocked (409). An omitted field is left alone; re-sending what the comment already holds changes nothing; sending nothing at all is a 400.

Body replaces the comment’s text. Attachments replaces its files outright: upload any new file first, then send the name and url of every file the comment should keep, or an empty array to remove them all.

The edit is recorded as the comment’s UpdatedOn. Nobody is notified of it, and anyone viewing the project in the app sees the new text straight away.

PATCH

projects

{projectId}

comments

{commentId}

Edits a private comment on a project. Send only the fields you want to change.

curl --request PATCH \
  --url https://api.usw.gorelo.io/v1/projects/{projectId}/comments/{commentId} \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "Body": "<string>",
  "Attachments": [
    {
      "Name": "<string>",
      "Url": "<string>"
    }
  ],
  "UpdatedByName": "<string>"
}
'

import requests

url = "https://api.usw.gorelo.io/v1/projects/{projectId}/comments/{commentId}"

payload = {
    "Body": "<string>",
    "Attachments": [
        {
            "Name": "<string>",
            "Url": "<string>"
        }
    ],
    "UpdatedByName": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    Body: '<string>',
    Attachments: [{Name: '<string>', Url: '<string>'}],
    UpdatedByName: '<string>'
  })
};

fetch('https://api.usw.gorelo.io/v1/projects/{projectId}/comments/{commentId}', 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.usw.gorelo.io/v1/projects/{projectId}/comments/{commentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'Body' => '<string>',
    'Attachments' => [
        [
                'Name' => '<string>',
                'Url' => '<string>'
        ]
    ],
    'UpdatedByName' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json",
    "X-API-Key: <api-key>"
  ],
]);

$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.usw.gorelo.io/v1/projects/{projectId}/comments/{commentId}"

	payload := strings.NewReader("{\n  \"Body\": \"<string>\",\n  \"Attachments\": [\n    {\n      \"Name\": \"<string>\",\n      \"Url\": \"<string>\"\n    }\n  ],\n  \"UpdatedByName\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.usw.gorelo.io/v1/projects/{projectId}/comments/{commentId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Body\": \"<string>\",\n  \"Attachments\": [\n    {\n      \"Name\": \"<string>\",\n      \"Url\": \"<string>\"\n    }\n  ],\n  \"UpdatedByName\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/projects/{projectId}/comments/{commentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"Body\": \"<string>\",\n  \"Attachments\": [\n    {\n      \"Name\": \"<string>\",\n      \"Url\": \"<string>\"\n    }\n  ],\n  \"UpdatedByName\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

授权

X-API-Key

string

header

必填

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

路径参数

projectId

string<uuid>

必填

Project the comment belongs to.

commentId

string<uuid>

必填

Comment to edit.

请求体

Fields to change.

Request body for editing a private comment on a project. Send only what you want to change: an omitted field is left as it is, and sending nothing at all is a 400.

Body

string | null

The new comment body, as HTML. Cannot be cleared: a blank body is a 400.

Attachments

object[] | null

Replaces the comment's attachments outright. Upload new files first, then send the name and url of every file the comment should keep. Send an empty array to remove them all; omit it to leave them unchanged. Max 100.

Show child attributes

UpdatedByName

string | null

Display name to record as the editor. An API key is not a person, so when it is omitted or blank the editor is recorded as API.

响应

StatusCode

enum<integer>

可用选项:

100,

101,

102,

103,

200,

201,

202,

203,

204,

205,

206,

207,

208,

226,

300,

301,

302,

303,

304,

305,

306,

307,

308,

400,

401,

402,

403,

404,

405,

406,

407,

408,

409,

410,

411,

412,

413,

414,

415,

416,

417,

421,

422,

423,

424,

426,

428,

429,

431,

451,

500,

501,

502,

503,

504,

505,

506,

507,

508,

510,

511

IsSuccess

boolean

Data

object

The identifier of the edited comment.

Show child attributes

DataContext

object | null

示例:

null

Notifications

object[]

Show child attributes

⌘I

Edits a private comment on a project. Send only the fields you want to change.

curl --request PATCH \
  --url https://api.usw.gorelo.io/v1/projects/{projectId}/comments/{commentId} \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "Body": "<string>",
  "Attachments": [
    {
      "Name": "<string>",
      "Url": "<string>"
    }
  ],
  "UpdatedByName": "<string>"
}
'

import requests

url = "https://api.usw.gorelo.io/v1/projects/{projectId}/comments/{commentId}"

payload = {
    "Body": "<string>",
    "Attachments": [
        {
            "Name": "<string>",
            "Url": "<string>"
        }
    ],
    "UpdatedByName": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    Body: '<string>',
    Attachments: [{Name: '<string>', Url: '<string>'}],
    UpdatedByName: '<string>'
  })
};

fetch('https://api.usw.gorelo.io/v1/projects/{projectId}/comments/{commentId}', 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.usw.gorelo.io/v1/projects/{projectId}/comments/{commentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'Body' => '<string>',
    'Attachments' => [
        [
                'Name' => '<string>',
                'Url' => '<string>'
        ]
    ],
    'UpdatedByName' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json",
    "X-API-Key: <api-key>"
  ],
]);

$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.usw.gorelo.io/v1/projects/{projectId}/comments/{commentId}"

	payload := strings.NewReader("{\n  \"Body\": \"<string>\",\n  \"Attachments\": [\n    {\n      \"Name\": \"<string>\",\n      \"Url\": \"<string>\"\n    }\n  ],\n  \"UpdatedByName\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.usw.gorelo.io/v1/projects/{projectId}/comments/{commentId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Body\": \"<string>\",\n  \"Attachments\": [\n    {\n      \"Name\": \"<string>\",\n      \"Url\": \"<string>\"\n    }\n  ],\n  \"UpdatedByName\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/projects/{projectId}/comments/{commentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"Body\": \"<string>\",\n  \"Attachments\": [\n    {\n      \"Name\": \"<string>\",\n      \"Url\": \"<string>\"\n    }\n  ],\n  \"UpdatedByName\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}