Knowledge Base

PreviousIMACD NextLeaves

Gets a kb with the given id

get

This endpoint is used to fetch a kb details in the current organization

Authorizations

Path parameters

idstringRequired

Responses

application/json

anyOptional

get

GET /ux/common/kb/kb/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

No content

Deletes the KB with given id

delete

This endpoint is used to delete an existing KB for the current organization

Authorizations

Path parameters

idstringRequired

Responses

application/json

anyOptional

application/json

delete

DELETE /ux/common/kb/kb/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Gets attachments for the selected kb.

get

This endpoint is used to fetch the attachments.

Authorizations

Responses

application/json

objectOptional

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.

get

GET /ux/common/kb/kb/attachment/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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"
}

Get the bookmarked KB's

get

This endpoint is used to get the bookmarked KB's

Authorizations

Responses

application/json

objectOptional

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.

get

GET /ux/common/kb/kb/bookmarks/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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"
}

Get the categories for the KB

get

This endpoint is used to get the categories

Authorizations

Responses

application/json

objectOptional

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.

get

GET /ux/common/kb/kb/categories/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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"
}

Get the comments for a KB

get

This endpoint is used to get the comments for KB

Authorizations

Responses

application/json

objectOptional

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.

get

GET /ux/common/kb/kb/comments/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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"
}

Gets history for the selected kb.

get

This endpoint is used to fetch the history.

Authorizations

Responses

application/json

objectOptional

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.

get

GET /ux/common/kb/kb/history/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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"
}

Get the options for the KB configuration

get

This endpoint is used to get the default options for KB config

Authorizations

Responses

application/json

objectOptional

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.

get

GET /ux/common/kb/kb/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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"
}

Get the ratings for the KB

get

This endpoint is used to get the ratings for KB

Authorizations

Responses

application/json

objectOptional

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.

get

GET /ux/common/kb/kb/ratings/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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"
}

Get the recent KB's

get

This endpoint is used to get the recent KB's

Authorizations

Responses

application/json

objectOptional

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.

get

GET /ux/common/kb/kb/recent/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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"
}

get

This endpoint is used to get the related KB's

Authorizations

Responses

application/json

objectOptional

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.

get

GET /ux/common/kb/kb/related/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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"
}

Get user list

get

This endpoint is used to get the user list from team

Authorizations

Responses

application/json

objectOptional

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.

get

GET /ux/common/kb/kb/team_user_map/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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"
}

get

Function will return user info dict :param request: request. :return: dict

Authorizations

Responses

application/json

objectOptional

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.

get

GET /ux/common/kb/kb/user-list/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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"
}

Get the viewers for the KB

get

This endpoint is used to get the viewers for a KB

Authorizations

Responses

application/json

objectOptional

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.

get

GET /ux/common/kb/kb/viewers/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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"
}

Get the view count for the KB

get

This endpoint is used to get the view count for a KB

Authorizations

Responses

application/json

objectOptional

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.

get

GET /ux/common/kb/kb/views/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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"
}

Gets list of KB

get

This endpoint is used to fetch all the active KB's for the current organization

Authorizations

Query parameters

items_per_pageintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

Responses

application/json

objectOptional

get

GET /ux/common/kb/kb/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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": []
}

Creates a new KB

post

This endpoint is used to save a new KB for the current organization

Authorizations

Body

Other propertiesanyOptional

Responses

application/json

anyOptional

application/json

post

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"
}

Edits the kb with given id

put

This endpoint is used to edit an existing KB for the current organization

Authorizations

Path parameters

idstringRequired

Body

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.

kb_idstring · max: 25Required

titlestringRead-onlyRequired

contentstringRead-onlyRequired

creation_timestringRead-onlyRequired

kbtypestringRead-onlyRequired

created_bystring | nullableOptional

keywordsstringRead-onlyRequired

configobjectOptional

Serializer for EmbeddedDocuments.

Skips id field and uniqueness validation. When saving, skips calling instance.save

faqsstringRead-onlyRequired

known_errorstringRead-onlyRequired

imagestringRead-onlyRequired

ratingstringRead-onlyRequired

likesstringRead-onlyRequired

viewsstringRead-onlyRequired

bookmarksstringRead-onlyRequired

user_likedstringRead-onlyRequired

rating_countstringRead-onlyRequired

is_bookmarkedstringRead-onlyRequired

commentsstringRead-onlyRequired

last_update_timestringRead-onlyRequired

is_updatedstringRead-onlyRequired

creatorinteger | nullableOptional

display_idstring · max: 50Optional

notify_usersstringRead-onlyRequired

Responses

application/json

objectOptional

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

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"
}

200Success

{
  "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"
}

patch

API endpoint for knowledge base

Authorizations

Path parameters

idstringRequired

Body

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.

kb_idstring · max: 25Optional

titlestringRead-onlyOptional

contentstringRead-onlyOptional

creation_timestringRead-onlyOptional

kbtypestringRead-onlyOptional

created_bystring | nullableOptional

keywordsstringRead-onlyOptional

configobjectOptional

Serializer for EmbeddedDocuments.

Skips id field and uniqueness validation. When saving, skips calling instance.save

faqsstringRead-onlyOptional

known_errorstringRead-onlyOptional

imagestringRead-onlyOptional

ratingstringRead-onlyOptional

likesstringRead-onlyOptional

viewsstringRead-onlyOptional

bookmarksstringRead-onlyOptional

user_likedstringRead-onlyOptional

rating_countstringRead-onlyOptional

is_bookmarkedstringRead-onlyOptional

commentsstringRead-onlyOptional

last_update_timestringRead-onlyOptional

is_updatedstringRead-onlyOptional

creatorinteger | nullableOptional

display_idstring · max: 50Optional

notify_usersstringRead-onlyOptional

Responses

application/json

objectOptional

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

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"
}

200Success

{
  "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"
}

Add attachments for the selected kb.

post

This endpoint is used to add new attachments.

Authorizations

Body

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.

kb_idstring · max: 25Required

titlestringRead-onlyRequired

contentstringRead-onlyRequired

creation_timestringRead-onlyRequired

kbtypestringRead-onlyRequired

created_bystring | nullableOptional

keywordsstringRead-onlyRequired

configobjectOptional

Serializer for EmbeddedDocuments.

Skips id field and uniqueness validation. When saving, skips calling instance.save

faqsstringRead-onlyRequired

known_errorstringRead-onlyRequired

imagestringRead-onlyRequired

ratingstringRead-onlyRequired

likesstringRead-onlyRequired

viewsstringRead-onlyRequired

bookmarksstringRead-onlyRequired

user_likedstringRead-onlyRequired

rating_countstringRead-onlyRequired

is_bookmarkedstringRead-onlyRequired

commentsstringRead-onlyRequired

last_update_timestringRead-onlyRequired

is_updatedstringRead-onlyRequired

creatorinteger | nullableOptional

display_idstring · max: 50Optional

notify_usersstringRead-onlyRequired

Responses

application/json

objectOptional

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

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"
}

200Success

{
  "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"
}

Save the comment for a KB

post

This endpoint is used to save the comment for a KB

Authorizations

Body

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.

kb_idstring · max: 25Required

titlestringRead-onlyRequired

contentstringRead-onlyRequired

creation_timestringRead-onlyRequired

kbtypestringRead-onlyRequired

created_bystring | nullableOptional

keywordsstringRead-onlyRequired

configobjectOptional

Serializer for EmbeddedDocuments.

Skips id field and uniqueness validation. When saving, skips calling instance.save

faqsstringRead-onlyRequired

known_errorstringRead-onlyRequired

imagestringRead-onlyRequired

ratingstringRead-onlyRequired

likesstringRead-onlyRequired

viewsstringRead-onlyRequired

bookmarksstringRead-onlyRequired

user_likedstringRead-onlyRequired

rating_countstringRead-onlyRequired

is_bookmarkedstringRead-onlyRequired

commentsstringRead-onlyRequired

last_update_timestringRead-onlyRequired

is_updatedstringRead-onlyRequired

creatorinteger | nullableOptional

display_idstring · max: 50Optional

notify_usersstringRead-onlyRequired

Responses

application/json

objectOptional

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

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"
}

200Success

{
  "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"
}

put

API endpoint for knowledge base

Authorizations

Path parameters

idstringRequired

Body

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.

kb_idstring · max: 25Required

titlestringRead-onlyRequired

contentstringRead-onlyRequired

creation_timestringRead-onlyRequired

kbtypestringRead-onlyRequired

created_bystring | nullableOptional

keywordsstringRead-onlyRequired

configobjectOptional

Serializer for EmbeddedDocuments.

Skips id field and uniqueness validation. When saving, skips calling instance.save

faqsstringRead-onlyRequired

known_errorstringRead-onlyRequired

imagestringRead-onlyRequired

ratingstringRead-onlyRequired

likesstringRead-onlyRequired

viewsstringRead-onlyRequired

bookmarksstringRead-onlyRequired

user_likedstringRead-onlyRequired

rating_countstringRead-onlyRequired

is_bookmarkedstringRead-onlyRequired

commentsstringRead-onlyRequired

last_update_timestringRead-onlyRequired

is_updatedstringRead-onlyRequired

creatorinteger | nullableOptional

display_idstring · max: 50Optional

notify_usersstringRead-onlyRequired

Responses

application/json

objectOptional

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

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"
}

200Success

{
  "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"
}

Save the feedback for a KB

post

This endpoint is used to save feedback for a KB

Authorizations

Body

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.

kb_idstring · max: 25Required

titlestringRead-onlyRequired

contentstringRead-onlyRequired

creation_timestringRead-onlyRequired

kbtypestringRead-onlyRequired

created_bystring | nullableOptional

keywordsstringRead-onlyRequired

configobjectOptional

Serializer for EmbeddedDocuments.

Skips id field and uniqueness validation. When saving, skips calling instance.save

faqsstringRead-onlyRequired

known_errorstringRead-onlyRequired

imagestringRead-onlyRequired

ratingstringRead-onlyRequired

likesstringRead-onlyRequired

viewsstringRead-onlyRequired

bookmarksstringRead-onlyRequired

user_likedstringRead-onlyRequired

rating_countstringRead-onlyRequired

is_bookmarkedstringRead-onlyRequired

commentsstringRead-onlyRequired

last_update_timestringRead-onlyRequired

is_updatedstringRead-onlyRequired

creatorinteger | nullableOptional

display_idstring · max: 50Optional

notify_usersstringRead-onlyRequired

Responses

application/json

objectOptional

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

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"
}

200Success

{
  "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"
}

Gets a kb with the given id

Deletes the KB with given id

Gets attachments for the selected kb.

Get the bookmarked KB's

Get the categories for the KB

Get the comments for a KB

Gets history for the selected kb.

Get the options for the KB configuration

Get the ratings for the KB

Get the recent KB's

Get the related KB's

Get user list

Get the viewers for the KB

Get the view count for the KB

Gets list of KB

Creates a new KB

Edits the kb with given id

Add attachments for the selected kb.

Save the comment for a KB

Save the feedback for a KB