CRcrowdin
String/Asset Comments

Add String/Asset Comment

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

Add a comment or issue to a string or asset. Use the oneOf pattern:

  • String type: Use stringId
  • Asset type: Use fileId
post/projects/{projectId}/comments

Request

Path parameters

projectIdinteger required

Project Identifier. Get via List Projects

Request body

OR

Example request

{
  "stringId": 1,
  "text": "some issue with translation",
  "type": "issue",
  "targetLanguageId": "en",
  "issueType": "translation_mistake",
  "attachments": [
    {
      "id": 123
    }
  ]
}

Response

String/Asset Comment was successfully created

OR

Example response

{
  "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,
    "senderOrganization": {
      "id": 200000101,
      "domain": "umbrella"
    },
    "resolverOrganization": {
      "id": 200000112,
      "domain": "acme"
    },
    "resolver": {
      "id": 12,
      "username": "john_smith",
      "fullName": "John Smith"
    },
    "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.