Gets list of project versions
  • 25 Nov 2023
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Gets list of project versions

  • Dark
    Light

Article Summary

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.0,
      "base_version_number": 0.0,
      "version_code_name": "v1",
      "is_main_version": true,
      "is_beta": false,
      "is_public": true,
      "is_deprecated": false,
      "created_at": "2023-11-25T10:59:35.1355918Z",
      "modified_at": "0001-01-01T00:00: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
        }
      ],
      "slug": "",
      "order": 0
    }
  ],
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
data
Array of object (ProjectVersionCustomer)
object
id
string

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

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)
object
id
string
name
string
code
string
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
slug
string
order
integer (int32)
extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError)

Errors in the customer API response

object
extension_data
object (ExtensionDataObject)
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api response

custom_data
object
warnings
Array of object (BaseWarning)

Warning in the customer API response

object
extension_data
object (ExtensionDataObject)
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object (BaseInformation)

Information passed by the customer API response

object
extension_data
object (ExtensionDataObject)
description
string

status description for customer Api response information


Was this article helpful?