Contents x
Gets all article versions
  • 16 Mar 2023
  • 2 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
Contents

Gets all article versions

  • Updated on 16 Mar 2023
  • 2 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
Get
/v2/Articles/{articleId}/{langCode}/versions
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
articleId
string Required

The ID of the article

langCode
string Required

Language code of the article

Responses
200

Success

Success Status Response

You can verify all the type of versions in a project.

{
  "data": [
    {
      "version_number": 1,
      "created_by": "peter jone",
      "created_at": "2023-03-16T13:17:47.35354Z",
      "modified_at": "2023-03-16T13:17:47.3535403Z",
      "base_version": 0,
      "status": 2,
      "profile_url": "https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E"
    }
  ],
  "extension_data": null,
  "success": true,
  "errors": null,
  "warnings": [],
  "information": []
}
Expand All
object
data
Array of object

Article version response data

object
version_number
integer

The version number of the article

created_by
string

Author name

created_at
string

The date the article version was created

modified_at
string

The last time the article version was modified

base_version
integer

The version number from which this article version is derived

status
integer
Valid values[0,1,2,3,4,5]
profile_url
string

Author profile image

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

400

Bad Request

Article not found

Kindly verify your articleId and perform the task again. Also verify the langCode (language code) is mismatching.

{
  "data": null,
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Article not found",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Expand All
object
data
Array of object

Article version response data

object
version_number
integer

The version number of the article

created_by
string

Author name

created_at
string

The date the article version was created

modified_at
string

The last time the article version was modified

base_version
integer

The version number from which this article version is derived

status
integer
Valid values[0,1,2,3,4,5]
profile_url
string

Author profile image

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?
What's Next