Gets list of articles within project version

Updated on Dec 24, 2024

3 minute(s) read

Anand Murali

Prev Next

Get

/v2/ProjectVersions/{projectVersionId}/articles

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 project version

Query parameters

langCode

string

Get article in the project version that corresponds to the given language code. If the language code is empty, the default language of the project version will be taken into account

Responses

200

Success

Example for 200 response due to invalid project version Id

200 response in get list of articles within project version

{
  "data": [
    {
      "url": "https://example.com/v1/docs/en/getting-started",
      "id": "7db99386-2816-40f0-991f-174dgdscf",
      "title": "Why did we build Document360?",
      "public_version": 1,
      "latest_version": 1,
      "language_code": null,
      "hidden": false,
      "status": 0,
      "order": 1,
      "slug": "why did we build document360",
      "content_type": null,
      "translation_option": 0,
      "is_shared_article": false,
      "modified_at": null
    }
  ],
  "extension_data": null,
  "success": false,
  "errors": [],
  "warnings": [],
  "information": []
}

Expand All

object

data

Array of object (ArticleSimpleDataCustomerResponse) | null

object

url

string | null

Url of the article

string | null

The ID of the article

title

string | null

The article title

public_version

integer (int32)

The article version number(revision) that is currently published

latest_version

integer (int32)

The latest version number of this article

language_code

string | null Deprecated

The default language code

hidden

boolean

Indicates if the article is visible on the site

status

integer (int32)

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

Valid values[ 0, 3 ]

order

integer (int32)

The position of the article inside the parent category

slug

string | null

The slug of the article

content_type

integer (int32) | null

The content type of the article: Markdown = 0, Wysiwyg = 1, Block = 2

Valid values[ 0, 1, 2 ]

translation_option

integer (int32)

The Translation status of the article

Valid values[ 0, 1, 2, 3 ]

is_shared_article

boolean

True indicates that the article is shared

modified_at

string (date-time) | null

Article modified date time

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

Example for 400 response due to invalid Project version Id

400 bad response due to invalid Project version Id

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The supplied project version id does not exist in your project",
      "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?