Gets articles by translation status

  • Updated on Dec 24, 2024
  • 1 minute(s) read
  • Janeera D A
  • Pradeep Srinivasan
  • Manoharan Soundarraj
 Prev Next
Get
/v2/Translations/{projectVersionId}/{langCode}
Security
API Key
Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Path parameters
projectVersionId
stringRequired

The ID of the version

langCode
stringRequired

Language code of the version

Default"en"
Query parameters
status
integer (int32)

Article translation status 0 - None, 1 - Needs transation, 2 - Translated, 3 - In progress Default Value is 0 (Need translation)

Valid values[ 0, 1, 2, 3 ]
Default1
Responses
200

Success

Article that need translation

Here are the articleId and categoryId for the article that needs translation for the following language code in the project.

{
  "data": [
    {
      "id": "978a1e16-fd36-4724-b63f-c313a059a30b",
      "category_id": "978a1e16-fd36-4724-b63f-c313a059a30b"
    },
    {
      "id": "978a1e16-fd36-4724-b63f-c313a059a30b",
      "category_id": "978a1e16-fd36-4724-b63f-c313a059a30b"
    },
    {
      "id": "978a1e16-fd36-4724-b63f-c313a059a30b",
      "category_id": "978a1e16-fd36-4724-b63f-c313a059a30b"
    }
  ],
  "extension_data": null,
  "success": true,
  "errors": null,
  "warnings": null,
  "information": null
}
Expand All
object
data
Array of object (NeedTranslationArticleData) | null

Article need to be translated

object
id
string | null

The ID of the article

category_id
string | null

The ID of the category

extension_data
object | null

Extention data for customer API response

success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
extension_data
object | null

Thids is the Extention data object

stack_trace
string | null

Stack trace for error response message

description
string | null

Description for error cause

error_code
string | null

Error code for Api response

custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null

Warnings in the customer API response

object
extension_data
object | null

Extention Data for customer Api warning

description
string | null

Warning description

warning_code
string | null

warning code for customer Api base response

information
Array of object (BaseInformation) | null

Information passed by the customer API response

object
extension_data
object | null

Extention data for customer Api response information

description
string | null

status description for customer Api response information