Skip to main content

REST API for Knowledge Pages

Project description

This module adds a REST API for knowledge pages. It allows you to retrieve categories and their child pages, as well as the details of a specific page.

Table of contents

Configuration

No configuration needed for this module.

Usage

To use this module, you can make requests to the following endpoints after installed:

  • api/knowledge/categories?category_initial={category_initial}&lang={lang}

  • api/knowledge/categories/{id}?&lang={lang}

  • api/knowledge/page/{id}?lang={lang}

  • api/knowledge/page/{tag}?lang={lang}

  • api/knowledge/search/{search+terms}?lang={lang}

  • api/knowledge/highlighted/{code}?lang={lang}

It’s worth mentioning that the {search+terms} param is url encoded text so for special characters (other than spaces which translates to the plus sign) have to be encoded in the url.

Known issues / Roadmap

There are no known issues for this module.

Bug Tracker

Bugs are tracked on GitLab Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • SomIT SCCL

  • Som Connexio SCCL

Contributors

Maintainers

This module is maintained by the OCA.

Odoo Community Association

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file odoo12-addon-knowledge_pages_api-12.0.1.2.0.tar.gz.

File metadata

File hashes

Hashes for odoo12-addon-knowledge_pages_api-12.0.1.2.0.tar.gz
Algorithm Hash digest
SHA256 a0757a497f01dfba8e3b75a86c6b79dd98bb29decd5239f4660887b0aa930d8c
MD5 310e809da73dd5fe66f9ba493ed5f326
BLAKE2b-256 4dba3edee0837e58c2f1e55817913141726b29e408a0a683a92a6d81b4ca0410

See more details on using hashes here.

File details

Details for the file odoo12_addon_knowledge_pages_api-12.0.1.2.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for odoo12_addon_knowledge_pages_api-12.0.1.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 74b582267873f600810400c5680df034f06a42d37ecd55b4073c121e23350dab
MD5 9bf0abb7b488301be32dc2045bf429f5
BLAKE2b-256 a56f5d8cf246dbe0e3b87b5e2d6f976bebd23120122941851a72b61024167d49

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page