Gets list of project versions
- 02 Nov 2024
- 2 Minutes To Read
- Contributors
- Print
- Dark modeLight
- PDF
Gets list of project versions
- Updated On 02 Nov 2024
- 2 Minutes To Read
- Contributors
- Print
- Dark modeLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/v2/ProjectVersions
Security
API Key
Header parameter nameapi_token
Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Responses
200
Success
200 Status response
The below example shows the status response 200.
{
"data": [
{
"id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"version_number": 1,
"base_version_number": 0,
"version_code_name": "v1",
"is_main_version": true,
"is_beta": false,
"is_public": true,
"is_deprecated": false,
"created_at": "2024-06-13T02:30:00Z",
"modified_at": "2024-06-13T02:30:00Z",
"language_versions": [
{
"id": "",
"name": null,
"code": "SS",
"set_as_default": false,
"hidden": false,
"enable_rtl": true,
"site_protection_level": 2,
"is_inheritance_disabled": false,
"has_inheritance_disabled_categories_or_articles": false,
"country_flag_code": null,
"is_home_page_enabled": false,
"version_display_name": null
}
],
"slug": "",
"order": 0,
"version_type": 0
}
],
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}object
data
Array of object (ProjectVersionCustomer) | null
object
id
string | null
The ID of the project version
version_number
number (double)
Project version number
base_version_number
number (double)
The version number from which this version is derived
version_code_name
string | null
Custom version name
is_main_version
boolean
"True" if this version is the main version after loading documentation
is_beta
boolean
"True" if this version is marked as Beta
is_public
boolean
"True" if this version is visible to the public
is_deprecated
boolean
"True" if this version is marked as deprecated
created_at
string (date-time)
The date and time the version was created
modified_at
string (date-time)
The last date and time the version was modified
language_versions
Array of object (Language) | null
object
id
string | null
name
string | null
code
string | null
set_as_default
boolean
hidden
boolean
enable_rtl
boolean
site_protection_level
integer (int32)
Valid values[ 0, 1, 2 ]
is_inheritance_disabled
boolean
has_inheritance_disabled_categories_or_articles
boolean
country_flag_code
string | null
is_home_page_enabled
boolean
version_display_name
string | null
slug
string | null
order
integer (int32)
version_type
integer (int32)
0 - KB workspace ; 1 - API Reference workspace;
Valid values[ 0, 1 ]
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
Was this article helpful?
