KB User's Guide - API - Categories
This document provides information in the Categories API for the KnowledgeBase.
Title
Get Categories
Calls externally-published Categories (aka Topics) for a specified site domain.
Collection Endpoint
https://[KB site domain]/[subsite (optional)]/api/v1/categories
Example: https://kb.wisc.edu/api/v1/categories
Method
GET
URL Params
| parameter | type | description |
|---|---|---|
| showAllAttributes | text string | set value to 1 to display more attributes in output |
| query | text string | one or more search terms, separated by a plus sign ( ) |
Collection Sample Response
{
"_links": {
"self": {
"href": "https://kb.wisc.edu/hrs/api/v1/categories"
}
},
"_embedded": {
"category": [
{
"id": 815,
"catName": "DOCUMENT TYPE",
"children": [
{
"id": 3241,
"catName": "Checklist",
"children": []
},
{
"id": 1030,
"catName": "FAQ",
"children": []
},
{
"id": 751,
"catName": "Process Map",
"children": []
},
{
"id": 3242,
"catName": "Reference",
"children": []
},
{
"id": 3243,
"catName": "Template",
"children": []
},
{
"id": 749,
"catName": "User Procedure",
"children": []
}
],
"_links": {
"self": {
"href": "https://kb.wisc.edu/hrs/api/v1/categories/815"
}
}
},
{
"id": 816,
"catName": "FUNCTIONAL AREA",
"children": [
{
"id": 744,
"catName": "Absence Mgt (AM)",
"children": []
},
{
"id": 746,
"catName": "Benefits (BN)",
"children": []
},
{
"id": 745,
"catName": "Finance (FN)",
"children": []
},
{
"id": 748,
"catName": "Human Resources (HR)",
"children": []
},
{
"id": 747,
"catName": "Payroll (PY)",
"children": []
},
{
"id": 6391,
"catName": "Prof Development (PD)",
"children": []
},
{
"id": 4156,
"catName": "Recon and WRS (REC)",
"children": []
},
{
"id": 3259,
"catName": "Talent Aquisition Mgmt (TAM)",
"children": []
},
{
"id": 4554,
"catName": "Tech and Reporting (TE)",
"children": []
},
{
"id": 739,
"catName": "Time and Labor (TL)",
"children": []
},
{
"id": 4725,
"catName": "UWSC Admin (ADM)",
"children": []
},
{
"id": 3481,
"catName": "UWSC Support (SC)",
"children": []
}
],
"_links": {
"self": {
"href": "https://kb.wisc.edu/hrs/api/v1/categories/816"
}
}
}
]
},
"total_items": 2
}
Entity Endpoint
/api/v1/[api-name]/categories[/:category_id]
Example: https://kb.wisc.edu/api/v1/categories/44
Entity Sample Response
{
"id": "44",
"parent_id": "3260",
"level": "2",
"cat_name": "Mac OS X",
"cat_desc": "",
"select_name": "Mac OS X",
"int": "1",
"ext": "1",
"hot": "1",
"active": "1",
"_links": {
"self": {
"href": "https://kb.wisc.edu/hrs/api/v1/categories/44"
}
}
}
Success Response
Code: 200 OK
Content: Content-type: application/hal+json
Error Response
Code: 404 Page Not Found
Content: { error : "Page not found." }
OR
Code: 405 Method Not Allowed
Content: { error : None }