Contents x
    Gets settings for the article
    • 26 Sep 2023
    • 3 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    Gets settings for the article

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

    Get
    /v2/Articles/{articleId}/{langCode}/settings
    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
    stringRequired

    The ID of the article

    langCode
    stringRequired

    Language code of the article

    Default"en"
    Responses
    200

    Success

    Success status Response

    This is the sample response for Get-Article-Settings, You can verify the Slug, Tags, and relatedArticles.

    {
  "data": {
    "slug": "5-basic-things-to-get-started",
    "seo_title": null,
    "description": null,
    "allow_comments": true,
    "show_table_of_contents": true,
    "featured_image_url": null,
    "tags": [
      "Getting started"
    ],
    "status_indicator": 1,
    "status_indicator_expiry_date": "2023-09-26T06:34:59.4174283Z",
    "exclude_from_search": false,
    "related_articles": []
  },
  "extension_data": null,
  "success": true,
  "errors": null,
  "warnings": [],
  "information": []
}
    Expand All
    object
    data
    object (ArticleSettingCustomer)
    slug
    string

    The slug of the article

    seo_title
    string

    The SEO title of the article

    description
    string

    The SEO description of the article

    allow_comments
    boolean

    True indicates that comments are allowed in the article

    show_table_of_contents
    boolean

    True indicates that Table of Contents are shown in the article

    featured_image_url
    string

    URL of the featured image

    tags
    Array of string

    List of tags associated to the article

    string
    status_indicator
    integer (int32)

    Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom

    Valid values[0,1,2,3]
    status_indicator_expiry_date
    string (date-time)

    The number of days after which the article status will be removed

    exclude_from_search
    boolean

    True indicates that the article will not appear in the Knowledge base search results

    related_articles
    Array of object (RelatedArticleData)

    List of related articles associated to the article

    object
    id
    string

    The ID of the article

    title
    string

    The title of the article

    hidden
    boolean

    True indicates that the article is hidden

    slug
    string

    The slug of the article

    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

    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
    object (ArticleSettingCustomer)
    slug
    string

    The slug of the article

    seo_title
    string

    The SEO title of the article

    description
    string

    The SEO description of the article

    allow_comments
    boolean

    True indicates that comments are allowed in the article

    show_table_of_contents
    boolean

    True indicates that Table of Contents are shown in the article

    featured_image_url
    string

    URL of the featured image

    tags
    Array of string

    List of tags associated to the article

    string
    status_indicator
    integer (int32)

    Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom

    Valid values[0,1,2,3]
    status_indicator_expiry_date
    string (date-time)

    The number of days after which the article status will be removed

    exclude_from_search
    boolean

    True indicates that the article will not appear in the Knowledge base search results

    related_articles
    Array of object (RelatedArticleData)

    List of related articles associated to the article

    object
    id
    string

    The ID of the article

    title
    string

    The title of the article

    hidden
    boolean

    True indicates that the article is hidden

    slug
    string

    The slug of the article

    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