CRcrowdin
String/Asset Comments

List String/Asset Comments

Required scopes: project.source.string (Read only).

List comments and issues for strings or assets. Use the oneOf pattern:

  • String type: Use stringId
  • Asset type: Use fileId
  • All comments: Omit both parameters to list all project comments
get/projects/{projectId}/comments

Request

Path parameters

projectIdinteger required

Project Identifier. Get via List Projects

Query parameters

orderBy'id' | 'text' | 'type' | 'createdAt' | 'resolvedAt' | 'issueStatus' | 'issueType' | 'isShared'

Read more about sorting rules

limitinteger

A maximum number of items to retrieve

offsetinteger

A starting offset in the collection

stringIdinteger

String Identifier. Get via List Strings

Note: Can't be used together with fileId

fileIdinteger

File Identifier. Get via List Files

Note: Can't be used together with stringId

type'comment' | 'issue'

Defines string comment type

Note: type=comment can't be used with issueType or issueStatus in same request

issueType'general_question' | 'translation_mistake' | 'context_request' | 'source_mistake'

Defines issue type. It can be one issue type or a list of comma-separated ones

issueStatus'resolved' | 'unresolved'

Defines issue resolution status

Response

Reported issues list

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,
        "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
        }
      }
    }
  ],
  "pagination": {
    "limit": 25
  }
}

Changes

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