KB User's Guide - API - Recent Articles

This document provides information in the Recent Articles API for the KnowledgeBase.

Title

Get Recent Articles

Calls externally-published document content for the specified site domain ordered by the date and time of the last published update.

Collection Endpoint

[KB site domain]/[subsite (optional)]/api/v1/recent-articles

Method

GET

URL Params

Note: All URL params are optional.

parameter type description
query text string one or more search terms, separated by a plus sign (plus sign)
ownerGroup string this = filter to docs owned by current group
other = filter to docs shared by other groups

Collection Sample Response

{
  "_links": {
    "self": {
      "href": "https://kb.wisc.edu/api/v1/recent-articles?sort=6&page=1"
    },
    "first": {
      "href": "https://kb.wisc.edu/api/v1/recent-articles?sort=6"
    },
    "last": {
      "href": "https://kb.wisc.edu/api/v1/recent-articles?sort=6&page=1068"
    },
    "next": {
      "href": "https://kb.wisc.edu/api/v1/recent-articles?sort=6&page=2"
    }
  },
  "_embedded": {
    "recent_article": [
      {
        "id": "18875",
        "title": "Gene Transfer Studies Guidance",
        "keywords": "RNA, DNA, recombinant DNA, human gene transfer, gene therapy, gene transfer",
        "summary": "Version Date: February 12, 2014\r\n",
        "updated": "2017-03-21 19:18:04",
        "created": "2011-06-17 00:00:00",
        "reviewed": "2017-03-21 19:18:04",
        "activation": "2011-06-17 00:00:00",
        "expiration": "3000-01-01 00:00:00",
        "searchPriority": "3",
        "ownerGroup": "HSIRB",
        "views": "4988",
        "_links": {
          "self": {
            "href": "https://kb.wisc.edu/api/v1/recent-articles/18875"
          }
        }
      },
      {
        "id": "63382",
        "title": "Office 365 - Use of Security Groups to Manage Permissions",
        "keywords": "microsoft office365 o365 pilot manifest permissions resources calendars folders email assign requesting",
        "summary": "There is a \"pilot\" currently running allowing users to manage permissions using security groups.\r\n\r\n<p><strong>Note:</strong> This process is currently a manual one, and the Office 365 team continues to look into ways of automating any or all of these steps. These instructions will change as the process improves.</p>",
        "updated": "2017-03-21 19:03:37",
        "created": "2016-05-12 20:05:55",
        "reviewed": "2017-03-21 19:03:37",
        "activation": "2016-05-12 14:36:52",
        "expiration": "3000-01-01 00:00:00",
        "searchPriority": "3",
        "ownerGroup": "Office 365",
        "views": "2638",
        "_links": {
          "self": {
            "href": "https://kb.wisc.edu/api/v1/recent-articles/63382"
          }
        }
      },
      
      ...

      }
    ]
  },
  "page_count": 1068,
  "page_size": 10,
  "total_items": 10677,
  "page": 1
}

Entity Endpoint

/api/v1/recent-articles/[doc_id]

Example: /api/v1/recent-articles/3

Entity Sample Response

{
  "id": "13905",
  "title": "What is the KnowledgeBase?",
  "keywords": "Knowledge base manage document information",
  "header": null,
  "alert": null,
  "summary": "The KnowledgeBase is a system for documenting and maintaining information for your staff and customers.  The KnowledgeBase is made up of many documents containing a wide variety of information.  ",
  "body": "<style type=\"text/css\"> \r\n  div.special {}\r\n  .special h4{margin-top:0px; margin-bottom:1px;}\r\n  .special h4.red{color:#CD9B9B; font-weight:bold;}\r\n  .special h4.right{align:right;}\r\n  .special p{margin-top:0px; margin-bottom:0px;}\r\n  .special ul{margin-top:0px; margin-bottom:1px;}\r\n  .special td{padding:10px;}\r\n</style>\r\n<div class=\"special\">\r\n<br />\r\n<h4>Manage Your Knowledge<br /><br /></h4>\r\n<p>The KnowledgeBase allows you to preserve, share, collaborate, and improve. </p>\r\n<br />\r\n  \r\n<table width=\"400\" cellpadding=\"10\">\r\n  \r\n<tbody>\r\n<tr>\r\n  \t\r\n<td style=\"background-color:#7198ca;\" valign=\"top\" align=\"left\">\r\n<h4>Preserve</h4>Document the knowledge essential to your operations.</td>\r\n    \r\n<td style=\"background-color:#eeeeee;\" valign=\"top\" align=\"left\">\r\n<h4 class=\"right\">Share</h4>Each partner site can share documentation with other partner sites.</td>\r\n  </tr>\r\n  \r\n<tr>\r\n  \t\r\n<td style=\"background-color:#eeeeee;\" valign=\"top\" align=\"left\">\r\n<h4>Collaborate</h4><span style=\"color:#505050\">Work with authors, partners, and your customers to improve your documentation.</span></td>\r\n    \r\n<td style=\"background-color:#7198ca;\" valign=\"top\" align=\"left\">\r\n<h4>Improve</h4>Once you have captured your knowledge, you can begin to improve your processes.</td>\r\n  </tr>\r\n  \r\n  </tbody></table><br />\r\n \r\n<br />\r\n<h4 style=\"color:#7198ca;\">Some examples of the type of information a KnowledgeBase document could contain are:</h4>\r\n<ul>\r\n<li>Employee policies</li>\r\n<li>Administrative procedures</li>\r\n<li>Technical Information</li>\r\n<li>Customer Information</li>\r\n</ul>\r\n\r\n<br />\r\n<h4 style=\"color:#7198ca;\">The KnowledgeBase can help you:</h4> \r\n<ul>\r\n<li>Communicate information to customers</li>\r\n<li>Consolidate scattered content</li>\r\n<li>Reduce training time for new staff</li>\r\n<li>Reduce redundancy by using shared content</li>\r\n<li>Prevent knowledge loss</li>\r\n</ul>\r\n\r\n<br />\r\n<h4 style=\"color:#7198ca;\">How does it work?</h4> \r\n<ul>\r\n<li>The KnowledgeBase is a web-based tool for managing your knowledge</li>\r\n<li>Each partner site has ability to control access to their content</li>\r\n<li>Document authors are automatically notified of aging documentation, which helps to keep content fresh</li>\r\n<li>Readers can submit vital feedback on your documentation</li>\r\n</ul>\r\n<div><br /></div>\r\n</div>",
  "footer": null,
  "owner": "Teresa A.",
  "updater": "Teresa A.",
  "created": "2010-04-28 00:00:00",
  "updated": "2017-01-05 19:22:45",
  "reviewed": "2017-01-05 19:22:45",
  "activation": "2010-04-28 00:00:00",
  "expiration": "2018-01-04 19:14:24",
  "ownerGroup": "KB Team",
  "_links": {
    "self": {
      "href": "https://kb.wisc.edu/api/v1/articles/13905"
    }
  }
} 

Success Response

Code: 200 OK
Content: Content-type: application/hal+json

Error Response

Code: 403 Forbidden
Content: {"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html","title":"Forbidden","status":403,"detail":"Forbidden"}

OR

Code: 404 Page Not Found
Content: Page not found.

OR

Code: 405 Method Not Allowed
Content: None

OR

Code: 500 Unexpected error
Content: { error : "Error producing an iterator" }

Notes

N/A

See Also:




Keywords:restapi method url data params parameters success errors responses sample calls notes service recently updated documents docs   Doc ID:71634
Owner:Leah S.Group:KB User's Guide
Created:2017-03-10 14:52 CDTUpdated:2017-03-22 14:22 CDT
Sites:KB User's Guide
Feedback:  0   0