Gets articles by translation status
  • 29 May 2023
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Gets articles by translation status

  • Dark
    Light

Article Summary

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
string Required

The ID of the version

langCode
string Required

Language code of the version

Query parameters
status
integer

Article translation status 0 - None, 1 - Needs transation, 2 - Translated, 3 - In progress

Default Value is 0 (Need translation)

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

Article need to be translated

object
id
string

The ID of the article

category_id
string

The ID of the category

extension_data
object
success
boolean

Status indication for customer API response

errors
Array of object

Errors in the customer API response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer API response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer API response

object
extension_data
description
string

status description for customer Api response information


Was this article helpful?