Document360 Customer API

Get category page versions

13 Nov 2024
2 Minutes to read
Contributors

Print
Share
Dark
Light
PDF

Get category page versions

Updated on 13 Nov 2024
2 Minutes to read
Contributors

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback!

Get

Deprecated

/v2/Categories/{categoryId}/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

categoryId

stringRequired

The ID of the category

Responses

200

Success

Success response

Success response for getting category page with version.

{
  "versions": [
    {
      "version_number": 1,
      "created_by": null,
      "created_at": "2024-06-13T02:30:00Z",
      "modified_at": "2024-06-13T02:30:00Z",
      "base_version": 0,
      "status": 0,
      "profile_url": "https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E"
    }
  ],
  "extension_data": null,
  "success": true,
  "errors": null,
  "warnings": [],
  "information": []
}

Expand All

object

versions

Array of object (CategorySimpleVersionCustomer) | null

get category data by version

object

version_number

integer (int32)

The currently fetched version number of this category page

created_by

string | null

The ID of the user that created the category page

created_at

string (date-time)

The date the category page was created

modified_at

string (date-time)

The date the category page was last modified

base_version

integer (int32)

The base version of the currently fetched category page

status

integer (int32)

The status of the article: 0 - Draft, 3 - Published

Valid values[ 0, 3 ]

profile_url

string | null

The URL of team account's profile image

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

400

Bad Request

Category not found

Kindly verify the Categotry Id and Langauage code, and peroform the task again.

{
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Category not found",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

Expand All

object

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?

What's Next