Please enable JavaScript to view this site.

iService API Documentation

Navigation: iService API Forms > Customer Portal

Create KB article (api=create)

Scroll Prev Top Next More

Purpose

 

The create API is used to create a new KB article.

 

UI Reference: The API is called when the ''Add article'' button is clicked on the Knowledge base page.

 

URI: webapp-api-findanswer?api=create

 

Access Rights Required:  

 

 

Request

 

 

Request Parameters

Name

Type

Description

details

Object

This returns all details of the object of interaction.

details[].subject

String

This returns the subject of interaction.

details[].questionHtml

String

This returns a question which has been mentioned in mail.

details[].answerHtml

String

This returns a answer which has been mentioned in mail.

details[].topicID

String

This has the value of topic id in which interaction belongs to.

details[].isPublic

String

Shows if an article is public.

details[].properties

Array

This returns all properties and their values if property value set in interaction.see property values.

details[].propertiesEdit

Array


pageAction

String

This parameter represents the action name which is performed from the page.

 

 

Request Payload Example

{
    "details": {
        "subject": "Testing",
        "questionHtml": "Test Question?",
        "answerHtml": "Test Answer.",
        "topicID": "109",
        "isPublic": "true",
        "properties": [],
        "propertiesEdit": []
    },
    "_pageAction": "CreateFindAnswer"
}

 

 

 

Response

 

Response Parameters

Name

Type

Description

errors

Array

This represents the list of errors.

errorDetails

Array

This represents the list of error details.

articleID

String

Id of an article.

row

Object

Object with row and their details.

row[].id

String

This is Interaction id.

row[].subject

String

This returns the subject of interaction.

row[].date

String

This returns the date of interaction.

row[].topicID

String

This has the value of topic id in which interaction belongs to.

row[].topicName

String

This has the value of the topic name in which interaction belongs to.

row[].public

String


row[].creatorName

String

Name of the article creator.

row[].rating

String


row[].viewCount

String

This has a total view count of interaction.

row[].attachments

Array

Shows attachments in an article.

row[].properties

Array

This returns all properties and their values if property value set in interaction.see property values.

row[].propertiesEdit

Array


 

 

Response Example

{
    "errors": [],
    "errorDetails": [],
    "articleID": "45225",
    "row": {
        "id": "45225",
        "subject": "Testing",
        "date": "2021-09-29T13:05:11.1530000Z",
        "topicID": "109",
        "topicName": "_Feedback",
        "public": "public",
        "creatorName": "e-shop Administrator",
        "rating": "0.0",
        "viewCount": "0",
        "attachments": [],
        "properties": [],
        "propertiesEdit": []
    }
}

© 2008 - 2022 One-to-One Service.com, Inc. All rights reserved.