@one-view/pd-oneview-knowledge-base-panel-types v0.0.12

FORMAT: 1A VERSION: 1.0.0 HOST: https://api.pd-oneview.net/knowledge-base-panel

pd-oneview-knowledge-base-panel

knowledge base plugins for oneview. this plugins will suggest list of CCR template

Articles List /v1/articles{?query,ccr,delivery,customer,vertical,order_status,page,per_page,language,order_id,geid}

obtain articles based on search query OR ccr

• Parameters
  • query (string, optional) - search query string
  • page (number, optional) - number of page
    • Default: 1
  • per_page (number, optional) - number of records per page
    • Default: 10
  • ccr : '1A' (string, optional) - ccr code
  • order_id : (string, optional) - filter based on orderCode criteria
  • geid : (string, optional) - global entity id, needed for order_id based filter
  • delivery : '111644' (string, optional) - id of delivery type
  • customer : '111644' (string, optional) - id of customer type
  • vertical : '111644' (string, optional) - id of vertical type
  • order_status : '111644' (string, optional) - id of order status type
  • language (string, optional) - language of articles
    • Default : EN_us

get articles list GET

• Request

  • Headers

      Authorization: bearer token

• Response 200 (application/json)

  • Attributes (SearchResults)

• Response 400 (application/json)

  • Attributes (Error)

• Response 403 (application/json)

  • Attributes (Error)

• Response 404 (application/json)

  • Attributes (Error)

• Response 500 (application/json)

  • Attributes (Error)

Analytics /v1/analytics/{articleId}

article analytics by article ID

• Parameters
  • articleId (required, string) - article ID

update article POST

updates article read time & view count

• Request

  • Headers

      Authorization: bearer token

  • Attributes (AnalyticsParams)

• Response 200 (application/json)

• Response 400 (application/json)

  • Attributes (Error)

• Response 401 (application/json)

  • Attributes (Error)

• Response 403 (application/json)

  • Attributes (Error)

• Response 404 (application/json)

  • Attributes (Error)

• Response 500 (application/json)

  • Attributes (Error)

Data Structures

int32 (number)

int64 (number)

Error (object)

• errorCode : 401 (int64)
• errorMessage : not authorize (string)

Error_401 (object)

• errorCode : 401 (int64)
• errorMessage : not authorize (string)

Error_404 (object)

• errorCode : 404 (int64)
• errorMessage : not found (string)

Error_403 (object)

• errorCode : 403 (int64)
• errorMessage : forbidden (string)

Error_400 (object)

• errorCode : 400 (int64)
• errorMessage : bad request (string)

Error_500 (object)

• errorCode : 500 (int64)
• errorMessage : internal server error (string)

Article

• id : 163642 (int64, required) - question id
• codename : retrieving-answers-through-api (string) - question codename
• name : Retrieving Answers through API (string) - name of question
• description : Retrieving Answers through API (string) - description of question
• category_id : 163642 (int64) - question category id
• language_id : 1 (int64) - language type
• answer (Answer) : answer of question
• parent_categories (arrayint64, fixed-type) - parent categories
• created_at : 2016-06-12T16:50:55.673Z (string) - create time
• updated_at : 2016-06-12T16:50:55.673Z (string) - update time
• views : 163642 (int64) - number of views
• categories (arrayCategory, fixed-type)

Answer

• id : 163642 (int64) - id
• body : <p>New Article</p> (string) - answer body with format
• body_txt : New Article (string) - raw answer body
• format : html (string) - format html
• updated_at : 2016-06-12T16:50:55.673Z (string) - update time
• question_id : 163642 (int64, required) - Question id

SearchResults

• results (arraySearchItem, fixed-type)

SearchItem

• id : 163642 (int64, required) - question id
• name : Retrieving Answers through API (string) - name of question
• answer (Answer)
• last_published_date : 2016-06-12T16:50:55.673Z (string) - update time
• last_published_user_name : John Doe" (string) - last editor
• categories (CurrentCategory)
• tags (arraystring, fixed-type)

CurrentCategory

• current (Category)

Category

• id : 163642 (int64, required) - Category id
• name : Designing Your Knowledge Base (string) - name of Category
• codename : designing-your-knowledge-base (string) - codename of Category
• parent_id : 163642 (int64) - Category parent id
• created_at : 2016-06-12T16:50:55.673Z (string) - create time
• updated_at : 2016-06-12T16:50:55.673Z (string) - update time

AnalyticsParams

• time_spent : 123456 (int64, required) - Time spent reading in seconds

Filters

• delivery (arrayCategory, fixed-type)
• customer (arrayCategory, fixed-type)
• vertical (arrayCategory, fixed-type)
• order_status (arrayCategory, fixed-type)