Api Home > ArticleComment > Get

GET api/V3/ArticleComment/Get?articleId={articleId} Get all comments associated with a knowledge article

Request Information

URI Parameters

NameDescriptionTypeAdditional information
articleId

integer

Required

Body Parameters

None.

Response Information

List of article comments

Resource Description

Collection of KAComment
NameDescriptionTypeAdditional information
CommentId

integer

None.

KnowledgeArticleID

integer

None.

UserID

globally unique identifier

None.

UserFirstName

string

None.

UserLastName

string

None.

ArchivedbyUser

globally unique identifier

None.

Comment

string

None.

Archived

boolean

None.

Helpful

boolean

None.

CreatedDate

date

None.

ArchivedDate

date

None.

DateUpdated

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "CommentId": 1,
    "KnowledgeArticleID": 1,
    "UserID": "0ce05485-cd8f-46b7-9e5f-bbfbe0938749",
    "UserFirstName": "sample string 2",
    "UserLastName": "sample string 3",
    "ArchivedbyUser": "22694a39-7732-4b0e-9095-df21aac98609",
    "Comment": "sample string 5",
    "Archived": true,
    "Helpful": true,
    "CreatedDate": "2019-12-08T00:17:54.202Z",
    "ArchivedDate": "2019-12-08T00:17:54.202Z",
    "DateUpdated": "2019-12-08T00:17:54.202Z"
  },
  {
    "CommentId": 1,
    "KnowledgeArticleID": 1,
    "UserID": "0ce05485-cd8f-46b7-9e5f-bbfbe0938749",
    "UserFirstName": "sample string 2",
    "UserLastName": "sample string 3",
    "ArchivedbyUser": "22694a39-7732-4b0e-9095-df21aac98609",
    "Comment": "sample string 5",
    "Archived": true,
    "Helpful": true,
    "CreatedDate": "2019-12-08T00:17:54.202Z",
    "ArchivedDate": "2019-12-08T00:17:54.202Z",
    "DateUpdated": "2019-12-08T00:17:54.202Z"
  }
]

application/xml, text/xml

Sample:
<ArrayOfKAComment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.WebConsole.ViewModels">
  <KAComment>
    <Archived>true</Archived>
    <ArchivedDate>2019-12-08T00:17:54.202304+00:00</ArchivedDate>
    <ArchivedbyUser>22694a39-7732-4b0e-9095-df21aac98609</ArchivedbyUser>
    <Comment>sample string 5</Comment>
    <CommentId>1</CommentId>
    <CreatedDate>2019-12-08T00:17:54.202304+00:00</CreatedDate>
    <DateUpdated>2019-12-08T00:17:54.202304+00:00</DateUpdated>
    <Helpful>true</Helpful>
    <KnowledgeArticleID>1</KnowledgeArticleID>
    <UserFirstName>sample string 2</UserFirstName>
    <UserID>0ce05485-cd8f-46b7-9e5f-bbfbe0938749</UserID>
    <UserLastName>sample string 3</UserLastName>
  </KAComment>
  <KAComment>
    <Archived>true</Archived>
    <ArchivedDate>2019-12-08T00:17:54.202304+00:00</ArchivedDate>
    <ArchivedbyUser>22694a39-7732-4b0e-9095-df21aac98609</ArchivedbyUser>
    <Comment>sample string 5</Comment>
    <CommentId>1</CommentId>
    <CreatedDate>2019-12-08T00:17:54.202304+00:00</CreatedDate>
    <DateUpdated>2019-12-08T00:17:54.202304+00:00</DateUpdated>
    <Helpful>true</Helpful>
    <KnowledgeArticleID>1</KnowledgeArticleID>
    <UserFirstName>sample string 2</UserFirstName>
    <UserID>0ce05485-cd8f-46b7-9e5f-bbfbe0938749</UserID>
    <UserLastName>sample string 3</UserLastName>
  </KAComment>
</ArrayOfKAComment>