Gets articles by translation status
- 23 May 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Gets articles by translation status
- Updated on 23 May 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback!
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 ]
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
}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 (ExtensionDataObject)
success
boolean
Status indication for customer API response
errors
Array of object (BaseError) | null
Errors in the customer API response
object
extension_data
object (ExtensionDataObject)
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
warnings
Array of object (BaseWarning) | null
Warnings in the customer API response
object
extension_data
object (ExtensionDataObject)
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 (ExtensionDataObject)
description
string | null
status description for customer Api response information
Was this article helpful?
