KMS REST web services

The IU Knowledge Management System provides web services through a REST API. This allows customers to pull KMS-hosted content in a standard format (JSON or XHTML) into their own web clients, as well as search content using Solr via the KMS search client.

KMS REST services use Basic Authentication (BasicAuth).

To request information about a KMS REST account for your service, contact kb@iu.edu. In your request, specify a group email account that will be responsible for the REST account.

Getting started

After determining your needs, KMS admins will create an account for you in the production environment:

  https://rest.kb.iu.edu/

For details, see KMS REST: User creation.

Using KMS REST web services

Document view

To view a document, make a GET request to:

  /v0/document/$docid.(json|xhtml)

$docid is the document ID.

Use custom HTTP headers to configure the request. For instructions, see KMS REST: Document view.

Document search

To search, make a GET request to:

  /v0/search.json

JSON is the only supported search response.

Pass the search query and other options in HTTP headers. For instructions, see KMS REST: Document search.

Sitemap

Document sitemap is available by GET request to:

  /v0/sitemap.xml

Use custom HTTP headers to configure the request. For instructions, see KMS REST: Sitemap.

Document UUID

REST customers who need to check their cached copies of KB documents can use the document UUID call to verify they have the latest version by comparing the UUID of the cached copy to the UUID of the live version.

To request a document UUID, make a GET request to:

  /v0/document/uuid/$docid

$docid is the document ID.

For more detailed instructions, see KMS REST: Document UUID.

Code for use with KMS REST

The KMS development team maintains a repository on the IU enterprise GitHub of sample code demonstrating the use of KMS REST services, and CSS to handle custom KMS content, at:

  https://github.iu.edu/kms/kmsrest-examples

For more information about GitHub at IU, see At IU, what is GitHub, and how do I use it?

This is document rest in the Knowledge Base.
Last modified on 2017-08-02 09:40:52.

  • Fill out this form to submit your issue to the UITS Support Center.
  • Please note that you must be affiliated with Indiana University to receive support.
  • All fields are required.

Please provide your IU email address. If you currently have a problem receiving email at your IU account, enter an alternate email address.

  • Fill out this form to submit your comment to the IU Knowledge Base.
  • If you are affiliated with Indiana University and need help with a computing problem, please use the I need help with a computing problem section above, or contact your campus Support Center.

Please provide your IU email address. If you currently have a problem receiving email at your IU account, enter an alternate email address.