Knowledge Base
This endpoint is used to fetch all the active KB's for the current organization
Number of results to return per page.
The initial index from which to return the results.
GET /ux/common/kb/kb/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&items_per_page=100",
"previous": "http://api.example.org/accounts/?offset=200&items_per_page=100",
"results": []
}This endpoint is used to save a new KB for the current organization
POST /ux/common/kb/kb/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 327
{
"kbtype": "article",
"title": "Test KB1",
"keywords": [
"test",
"IT"
],
"content": {
"info": "This is a test KB",
"attachments": []
},
"state": "Active",
"status": "Approved",
"department": "IT",
"catalogue_service": "IT Services",
"approvers": "Shyam M",
"reviewers": "Samaresh M",
"valid_till": "2021-06-25",
"is_private": false,
"approver": 1,
"reviewer": 1
}{
"status": "success",
"id": "105687410610271163368",
"message": "Message.msg_kb_created",
"msg": "Knowledge Base Info created successfully"
}This endpoint is used to edit an existing KB for the current organization
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
PUT /ux/common/kb/kb/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 127
{
"kb_id": "text",
"created_by": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"creator": 1,
"display_id": "text"
}{
"kb_id": "text",
"title": "text",
"content": "text",
"creation_time": "text",
"kbtype": "text",
"created_by": "text",
"keywords": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"faqs": "text",
"known_error": "text",
"image": "text",
"rating": "text",
"likes": "text",
"views": "text",
"bookmarks": "text",
"user_liked": "text",
"rating_count": "text",
"is_bookmarked": "text",
"comments": "text",
"last_update_time": "text",
"is_updated": "text",
"creator": 1,
"display_id": "text",
"notify_users": "text"
}This endpoint is used to delete an existing KB for the current organization
DELETE /ux/common/kb/kb/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No content
API endpoint for knowledge base
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
PATCH /ux/common/kb/kb/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 127
{
"kb_id": "text",
"created_by": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"creator": 1,
"display_id": "text"
}{
"kb_id": "text",
"title": "text",
"content": "text",
"creation_time": "text",
"kbtype": "text",
"created_by": "text",
"keywords": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"faqs": "text",
"known_error": "text",
"image": "text",
"rating": "text",
"likes": "text",
"views": "text",
"bookmarks": "text",
"user_liked": "text",
"rating_count": "text",
"is_bookmarked": "text",
"comments": "text",
"last_update_time": "text",
"is_updated": "text",
"creator": 1,
"display_id": "text",
"notify_users": "text"
}This endpoint is used to add new attachments.
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
POST /ux/common/kb/kb/add-attachment/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 127
{
"kb_id": "text",
"created_by": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"creator": 1,
"display_id": "text"
}{
"kb_id": "text",
"title": "text",
"content": "text",
"creation_time": "text",
"kbtype": "text",
"created_by": "text",
"keywords": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"faqs": "text",
"known_error": "text",
"image": "text",
"rating": "text",
"likes": "text",
"views": "text",
"bookmarks": "text",
"user_liked": "text",
"rating_count": "text",
"is_bookmarked": "text",
"comments": "text",
"last_update_time": "text",
"is_updated": "text",
"creator": 1,
"display_id": "text",
"notify_users": "text"
}This endpoint is used to fetch the attachments.
GET /ux/common/kb/kb/attachment/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"kb_id": "text",
"title": "text",
"content": "text",
"creation_time": "text",
"kbtype": "text",
"created_by": "text",
"keywords": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"faqs": "text",
"known_error": "text",
"image": "text",
"rating": "text",
"likes": "text",
"views": "text",
"bookmarks": "text",
"user_liked": "text",
"rating_count": "text",
"is_bookmarked": "text",
"comments": "text",
"last_update_time": "text",
"is_updated": "text",
"creator": 1,
"display_id": "text",
"notify_users": "text"
}This endpoint is used to get the bookmarked KB's
GET /ux/common/kb/kb/bookmarks/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"kb_id": "text",
"title": "text",
"content": "text",
"creation_time": "text",
"kbtype": "text",
"created_by": "text",
"keywords": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"faqs": "text",
"known_error": "text",
"image": "text",
"rating": "text",
"likes": "text",
"views": "text",
"bookmarks": "text",
"user_liked": "text",
"rating_count": "text",
"is_bookmarked": "text",
"comments": "text",
"last_update_time": "text",
"is_updated": "text",
"creator": 1,
"display_id": "text",
"notify_users": "text"
}This endpoint is used to get the categories
GET /ux/common/kb/kb/categories/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"kb_id": "text",
"title": "text",
"content": "text",
"creation_time": "text",
"kbtype": "text",
"created_by": "text",
"keywords": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"faqs": "text",
"known_error": "text",
"image": "text",
"rating": "text",
"likes": "text",
"views": "text",
"bookmarks": "text",
"user_liked": "text",
"rating_count": "text",
"is_bookmarked": "text",
"comments": "text",
"last_update_time": "text",
"is_updated": "text",
"creator": 1,
"display_id": "text",
"notify_users": "text"
}This endpoint is used to save the comment for a KB
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
POST /ux/common/kb/kb/comment/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 127
{
"kb_id": "text",
"created_by": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"creator": 1,
"display_id": "text"
}{
"kb_id": "text",
"title": "text",
"content": "text",
"creation_time": "text",
"kbtype": "text",
"created_by": "text",
"keywords": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"faqs": "text",
"known_error": "text",
"image": "text",
"rating": "text",
"likes": "text",
"views": "text",
"bookmarks": "text",
"user_liked": "text",
"rating_count": "text",
"is_bookmarked": "text",
"comments": "text",
"last_update_time": "text",
"is_updated": "text",
"creator": 1,
"display_id": "text",
"notify_users": "text"
}This endpoint is used to get the comments for KB
GET /ux/common/kb/kb/comments/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"kb_id": "text",
"title": "text",
"content": "text",
"creation_time": "text",
"kbtype": "text",
"created_by": "text",
"keywords": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"faqs": "text",
"known_error": "text",
"image": "text",
"rating": "text",
"likes": "text",
"views": "text",
"bookmarks": "text",
"user_liked": "text",
"rating_count": "text",
"is_bookmarked": "text",
"comments": "text",
"last_update_time": "text",
"is_updated": "text",
"creator": 1,
"display_id": "text",
"notify_users": "text"
}API endpoint for knowledge base
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
PUT /ux/common/kb/kb/delete-attachment/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 127
{
"kb_id": "text",
"created_by": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"creator": 1,
"display_id": "text"
}{
"kb_id": "text",
"title": "text",
"content": "text",
"creation_time": "text",
"kbtype": "text",
"created_by": "text",
"keywords": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"faqs": "text",
"known_error": "text",
"image": "text",
"rating": "text",
"likes": "text",
"views": "text",
"bookmarks": "text",
"user_liked": "text",
"rating_count": "text",
"is_bookmarked": "text",
"comments": "text",
"last_update_time": "text",
"is_updated": "text",
"creator": 1,
"display_id": "text",
"notify_users": "text"
}This endpoint is used to save feedback for a KB
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
POST /ux/common/kb/kb/feedback/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 127
{
"kb_id": "text",
"created_by": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"creator": 1,
"display_id": "text"
}{
"kb_id": "text",
"title": "text",
"content": "text",
"creation_time": "text",
"kbtype": "text",
"created_by": "text",
"keywords": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"faqs": "text",
"known_error": "text",
"image": "text",
"rating": "text",
"likes": "text",
"views": "text",
"bookmarks": "text",
"user_liked": "text",
"rating_count": "text",
"is_bookmarked": "text",
"comments": "text",
"last_update_time": "text",
"is_updated": "text",
"creator": 1,
"display_id": "text",
"notify_users": "text"
}This endpoint is used to fetch the history.
GET /ux/common/kb/kb/history/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"kb_id": "text",
"title": "text",
"content": "text",
"creation_time": "text",
"kbtype": "text",
"created_by": "text",
"keywords": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"faqs": "text",
"known_error": "text",
"image": "text",
"rating": "text",
"likes": "text",
"views": "text",
"bookmarks": "text",
"user_liked": "text",
"rating_count": "text",
"is_bookmarked": "text",
"comments": "text",
"last_update_time": "text",
"is_updated": "text",
"creator": 1,
"display_id": "text",
"notify_users": "text"
}This endpoint is used to get the default options for KB config
GET /ux/common/kb/kb/options/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"kb_id": "text",
"title": "text",
"content": "text",
"creation_time": "text",
"kbtype": "text",
"created_by": "text",
"keywords": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"faqs": "text",
"known_error": "text",
"image": "text",
"rating": "text",
"likes": "text",
"views": "text",
"bookmarks": "text",
"user_liked": "text",
"rating_count": "text",
"is_bookmarked": "text",
"comments": "text",
"last_update_time": "text",
"is_updated": "text",
"creator": 1,
"display_id": "text",
"notify_users": "text"
}This endpoint is used to get the ratings for KB
GET /ux/common/kb/kb/ratings/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"kb_id": "text",
"title": "text",
"content": "text",
"creation_time": "text",
"kbtype": "text",
"created_by": "text",
"keywords": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"faqs": "text",
"known_error": "text",
"image": "text",
"rating": "text",
"likes": "text",
"views": "text",
"bookmarks": "text",
"user_liked": "text",
"rating_count": "text",
"is_bookmarked": "text",
"comments": "text",
"last_update_time": "text",
"is_updated": "text",
"creator": 1,
"display_id": "text",
"notify_users": "text"
}This endpoint is used to get the recent KB's
GET /ux/common/kb/kb/recent/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"kb_id": "text",
"title": "text",
"content": "text",
"creation_time": "text",
"kbtype": "text",
"created_by": "text",
"keywords": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"faqs": "text",
"known_error": "text",
"image": "text",
"rating": "text",
"likes": "text",
"views": "text",
"bookmarks": "text",
"user_liked": "text",
"rating_count": "text",
"is_bookmarked": "text",
"comments": "text",
"last_update_time": "text",
"is_updated": "text",
"creator": 1,
"display_id": "text",
"notify_users": "text"
}This endpoint is used to get the related KB's
GET /ux/common/kb/kb/related/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"kb_id": "text",
"title": "text",
"content": "text",
"creation_time": "text",
"kbtype": "text",
"created_by": "text",
"keywords": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"faqs": "text",
"known_error": "text",
"image": "text",
"rating": "text",
"likes": "text",
"views": "text",
"bookmarks": "text",
"user_liked": "text",
"rating_count": "text",
"is_bookmarked": "text",
"comments": "text",
"last_update_time": "text",
"is_updated": "text",
"creator": 1,
"display_id": "text",
"notify_users": "text"
}This endpoint is used to get the user list from team
GET /ux/common/kb/kb/team_user_map/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"kb_id": "text",
"title": "text",
"content": "text",
"creation_time": "text",
"kbtype": "text",
"created_by": "text",
"keywords": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"faqs": "text",
"known_error": "text",
"image": "text",
"rating": "text",
"likes": "text",
"views": "text",
"bookmarks": "text",
"user_liked": "text",
"rating_count": "text",
"is_bookmarked": "text",
"comments": "text",
"last_update_time": "text",
"is_updated": "text",
"creator": 1,
"display_id": "text",
"notify_users": "text"
}Function will return user info dict :param request: request. :return: dict
GET /ux/common/kb/kb/user-list/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"kb_id": "text",
"title": "text",
"content": "text",
"creation_time": "text",
"kbtype": "text",
"created_by": "text",
"keywords": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"faqs": "text",
"known_error": "text",
"image": "text",
"rating": "text",
"likes": "text",
"views": "text",
"bookmarks": "text",
"user_liked": "text",
"rating_count": "text",
"is_bookmarked": "text",
"comments": "text",
"last_update_time": "text",
"is_updated": "text",
"creator": 1,
"display_id": "text",
"notify_users": "text"
}This endpoint is used to get the viewers for a KB
GET /ux/common/kb/kb/viewers/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"kb_id": "text",
"title": "text",
"content": "text",
"creation_time": "text",
"kbtype": "text",
"created_by": "text",
"keywords": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"faqs": "text",
"known_error": "text",
"image": "text",
"rating": "text",
"likes": "text",
"views": "text",
"bookmarks": "text",
"user_liked": "text",
"rating_count": "text",
"is_bookmarked": "text",
"comments": "text",
"last_update_time": "text",
"is_updated": "text",
"creator": 1,
"display_id": "text",
"notify_users": "text"
}This endpoint is used to get the view count for a KB
GET /ux/common/kb/kb/views/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"kb_id": "text",
"title": "text",
"content": "text",
"creation_time": "text",
"kbtype": "text",
"created_by": "text",
"keywords": "text",
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"faqs": "text",
"known_error": "text",
"image": "text",
"rating": "text",
"likes": "text",
"views": "text",
"bookmarks": "text",
"user_liked": "text",
"rating_count": "text",
"is_bookmarked": "text",
"comments": "text",
"last_update_time": "text",
"is_updated": "text",
"creator": 1,
"display_id": "text",
"notify_users": "text"
}