KB User's Guide - API - Group Spaces

This document provides information in the Group Spaces API for the KnowledgeBase.

Title

Get Group Spaces

Calls externally-published group spaces within a specified site domain.

** APIs are not enabled for institution subsites unless specifically requested. Please contact the KB team if you would like to request an API for your subsite(s).

Collection Endpoint

https://[KB site domain]/[subsite (optional)]/api/v1/group-spaces

Example: https://kb.wisc.edu/api/v1/group-spaces or https://kb.wisc.edu/helpdesk/api/v1/group-spaces

Method

GET

URL Params

parameter type description
query text string one or more search terms, separated by a plus sign (=)
institutionId integer ID number of active institution
groupId integer ID number of active group (e.g. 1 = helpdesk, 12 = middleware, 41 = kbGuide)
sort integer

If sort is undefined, results will be sorted first sorted by updated date (descending), then by created date (descending).

1  = sort by group_id, ascending
2  = sort by group_id, descending
3  = sort by group_name, ascending
4  = sort by group_name, descending
5  = sort by group_super, ascending
6  = sort by group_super, descending
7  = sort by contact_email, ascending
8  = sort by contact_email, descending
9  = sort by start_date, ascending
10 = sort by start_date, descending
11 = sort by end_date, ascending
12 = sort by end_date, descending
13 = sort by active, ascending
14 = sort by active, descending
active integer 0 or undefined = fuzzy search (default)
1 = verbatim search 
dirPath text string searching exactly matched name of directory path behind the domain name. (e.g. "middleware" or "helpdesk").

Collection Sample Response

{
"_links": {
"self": {
"href": "https://kb.wisc.edu/helpdesk/api/v1/group-spaces?page=1"
},
"first": {
"href": "https://kb.wisc.edu/helpdesk/api/v1/group-spaces"
},
"last": {
"href": "https://kb.wisc.edu/helpdesk/api/v1/group-spaces?page=1"
}
},
"_embedded": {
"group_space": [
{
"id": "1",
"groupId": "1",
"groupName": "DoIT Help Desk",
"groupShort": "DoIT Help Desk",
"institutionId": "1",
"dirPath": "helpdesk",
"timeZone": "America/Chicago",
"mobileImg": "0",
"extSiteTitle": "DoIT Help Desk Knowledgebase",
"extSiteSeo": "",
"extSiteName": "DoIT Help Desk Knowledgebase",
"extSiteShort": "DoITHelpDesk-external",
"extSiteActive": "1",
"active": "1",
"_links": {
"self": {
"href": "https://kb.wisc.edu/helpdesk/api/v1/group-spaces/1"
}
}
},
{
"id": "381",
"groupId": "381",
"groupName": "Swallowing and Salivary Bioscience Laboratory ",
"groupShort": "Swallowing and Salivary Bioscience Laboratory KB",
"institutionId": "1",
"dirPath": "ssbl",
"timeZone": "America/Chicago",
"mobileImg": "1",
"extSiteTitle": "Swallowing and Salivary Bioscience Laboratory KB",
"extSiteSeo": "",
"extSiteName": "Swallowing and Salivary Bioscience Laboratory KB",
"extSiteShort": "SSBL-external",
"extSiteActive": "1",
"active": "1",
"_links": {
"self": {
"href": "https://kb.wisc.edu/helpdesk/api/v1/group-spaces/381"
}
}
},
{
"id": "380",
"groupId": "380",
"groupName": "Cybersecurity Operations Center",
"groupShort": "Cybersecurity Operations Center",
"institutionId": "1",
"dirPath": "csoc",
"timeZone": "America/Chicago",
"mobileImg": "1",
"extSiteTitle": "Cybersecurity Operations Center KnowledgeBase",
"extSiteSeo": "",
"extSiteName": "Cybersecurity Operations Center KnowledgeBase",
"extSiteShort": "CSOC-external",
"extSiteActive": "0",
"active": "1",
"_links": {
"self": {
"href": "https://kb.wisc.edu/helpdesk/api/v1/group-spaces/380"
}
}

},

...
} ] },
"page_count": 1,
"page_size": 500,
"total_items": 286,
"page": 1
}

Entity Endpoint

/api/v1/group-spaces/[groupId]

Example: https://kb.wisc.edu/api/v1/group-spaces/1

Entity Parameters

parameter type description
query text string one or more search terms, separated by a plus sign (=)
institutionId integer ID number of active institution
groupId integer ID number of active group (e.g. 1 = helpdesk, 12 = middleware, 41 = kbGuide)
sort integer

If sort is undefined, results will be sorted first sorted by updated date (descending), then by created date (descending).

1  = sort by group_id, ascending
2  = sort by group_id, descending
3  = sort by group_name, ascending
4  = sort by group_name, descending
5  = sort by group_super, ascending
6  = sort by group_super, descending
7  = sort by contact_email, ascending
8  = sort by contact_email, descending
9  = sort by start_date, ascending
10 = sort by start_date, descending
11 = sort by end_date, ascending
12 = sort by end_date, descending
13 = sort by active, ascending
14 = sort by active, descending
active integer 0 or undefined = fuzzy search (default)
1 = verbatim search 
dirPath text string searching exactly matched name of directory path behind the domain name. (e.g. "helpdesk" or "middleware" or "kbGuide")

Entity Sample Response

{
"id": "1",
"groupId": "1",
"groupName": "DoIT Help Desk",
"groupShort": "DoIT Help Desk",
"institutionId": "1",
"dirPath": "helpdesk",
"mobileImg": "0",
"timeZone": "America/Chicago",
"active": "1",
"extSiteId": null,
"extSiteTitle": "DoIT Help Desk Knowledgebase",
"extSiteSeo": "",
"extSiteName": "DoIT Help Desk Knowledgebase",
"extSiteShort": "DoITHelpDesk-external",
"extSiteActive": "1",
"_links": {
"self": {
"href": "https://kb.wisc.edu/api/v1/group-spaces/1"
}
}
}

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 }

Notes





Keywords:restapi method url data params parameters success errors responses sample calls notes service group space   Doc ID:86189
Owner:Teresa A.Group:KB User's Guide
Created:2018-10-02 11:34 CDTUpdated:2018-10-12 11:16 CDT
Sites:KB User's Guide
Feedback:  0   0