Contents x
    Gets list of articles within project version
    • 26 Sep 2023
    • 3 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    Gets list of articles within project version

    • Updated on 26 Sep 2023
    • 3 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Article Summary

    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": [
    {
      "id": "7db99386-2816-40f0-991f-174dgdscf",
      "title": "Why did we build Document360?",
      "public_version": 1,
      "latest_version": 1,
      "language_code": null,
      "hidden": false,
      "status": 2,
      "order": 1,
      "slug": "why did we build document360",
      "content_type": null
    }
  ],
  "extension_data": null,
  "success": false,
  "errors": [],
  "warnings": [],
  "information": []
}
    Expand All
    object
    data
    Array of object (ArticleSimpleDataCustomer)
    object
    id
    string

    The ID of the article

    title
    string

    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

    Language code of the article

    hidden
    boolean

    Indicates if the article is visible on the site

    status
    integer (int32)

    The status of the category page: 0 - Draft, 1 - In review, 2 - Public, 3 - Published, 4 - Deleted, 5 - Forked

    Valid values[0,1,2,3,4,5]
    order
    integer (int32)

    The position of the article inside the parent category

    slug
    string

    The slug of the article

    content_type
    integer (int32)

    0 - Markdown content; 1 - HTML content; 2 - Block Content

    Valid values[0,1,2]
    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 resonse

    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

    400

    Bad Request

    Example for 400 response due to invalid Project version Id

    400 bad response due to invalid Project version Id

    {
  "data": null,
  "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
    data
    Array of object (ArticleSimpleDataCustomer)
    object
    id
    string

    The ID of the article

    title
    string

    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

    Language code of the article

    hidden
    boolean

    Indicates if the article is visible on the site

    status
    integer (int32)

    The status of the category page: 0 - Draft, 1 - In review, 2 - Public, 3 - Published, 4 - Deleted, 5 - Forked

    Valid values[0,1,2,3,4,5]
    order
    integer (int32)

    The position of the article inside the parent category

    slug
    string

    The slug of the article

    content_type
    integer (int32)

    0 - Markdown content; 1 - HTML content; 2 - Block Content

    Valid values[0,1,2]
    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 resonse

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