Get translation comments

GET 
/v2/projects/:projectId/translations/:translationId/comments

Returns translation comments of translation

Request

Path Parameters

translationId int64required
projectId int64required

Query Parameters

page integer

Default value: 0

Zero-based page index (0..N)

size integer

Possible values: >= 1

Default value: 20

The size of the page to be returned

sort string[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

200

OK

application/json

Schema

Schema

_embedded object
translationComments object[]
Array [
id int64required
Id of translation comment record
text stringrequired
Text of comment
state stringrequired
Possible values: [RESOLUTION_NOT_NEEDED, NEEDS_RESOLUTION, RESOLVED]
State of translation
author objectrequired
User who created the comment
id int64required
username stringrequired
name string
avatar object
large stringrequired
thumbnail stringrequired
deleted booleanrequired
createdAt date-timerequired
Date when it was created
updatedAt date-timerequired
Date when it was updated
]
page object
size int64
totalElements int64
totalPages int64
number int64

Example (from schema)

{
  "_embedded": {
    "translationComments": [
      {
        "id": 0,
        "text": "string",
        "state": "RESOLUTION_NOT_NEEDED",
        "author": {
          "id": 0,
          "username": "string",
          "name": "string",
          "avatar": {
            "large": "string",
            "thumbnail": "string"
          },
          "deleted": true
        },
        "createdAt": "2024-04-27T10:07:49.549Z",
        "updatedAt": "2024-04-27T10:07:49.549Z"
      }
    ]
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  }
}

400

Bad Request

*/*

Schema

Schema

string

401

Unauthorized

*/*

Schema

Schema

string

403

Forbidden

*/*

Schema

Schema

string

404

Not Found

*/*

Schema

Schema

string

Loading...