CRcrowdin
String Comments

String Comment Batch Operations

Required scopes: project.source.string (Read and Write).

patch/projects/{projectId}/comments

Request

Path parameters

projectIdinteger required

Project Identifier. Get via List Projects

Request body

op'replace' | 'remove' | 'add' required

Patch operation to perform

pathstring json-pointer required

A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>

Example request

[
  {
    "op": "replace",
    "path": "/2814/text",
    "value": "some issue edited"
  },
  {
    "op": "replace",
    "path": "/2814/issueStatus",
    "value": "resolved"
  },
  {
    "op": "add",
    "path": "/-",
    "value": {
      "text": "some issue",
      "stringId": 1,
      "type": "issue",
      "targetLanguageId": "en",
      "issueType": "translation_mistake"
    }
  },
  {
    "op": "remove",
    "path": "/2815"
  }
]

Response

String Comments were successfully updated

Example response

{
  "data": [
    {
      "data": {
        "id": 2,
        "text": "@BeMyEyes  Please provide more details on where the text will be used",
        "userId": 6,
        "user": {
          "id": 12,
          "username": "john_smith",
          "fullName": "John Smith"
        },
        "projectId": 1,
        "languageId": "en",
        "type": "issue",
        "issueType": "source_mistake",
        "issueStatus": "unresolved",
        "resolverId": 12,
        "resolvedAt": "2019-09-20T11:05:24+00:00",
        "createdAt": "2019-09-20T11:05:24+00:00",
        "attachments": [
          {
            "id": 10,
            "name": "screenshot.png",
            "mime": "image/png",
            "size": 12345,
            "category": "image",
            "thumbnailUrl": "https://example.com/thumbnail.png",
            "url": "https://example.com/original.png",
            "downloadUrl": "https://example.com/raw.png"
          }
        ],
        "stringId": 742,
        "string": {
          "id": 742,
          "text": "HTML page example",
          "type": "text",
          "context": "Document Title\\r\\nXPath: /html/head/title",
          "fileId": 22
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.