GET api/teams/ArticleComment/Get?articleId={articleId}

Api Home > ArticleComment > Get

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

Request Information

URI Parameters

Name	Description	Type	Additional information
articleId		integer	Required

Body Parameters

None.

Response Information

List of article comments

Resource Description

Collection of KAComment

Name	Type	Additional 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": "908bcdf9-c022-433d-b64a-d77bb8c28c6e",
    "UserFirstName": "sample string 2",
    "UserLastName": "sample string 3",
    "ArchivedbyUser": "b513facf-6b6d-46e7-ad67-d920e61a53af",
    "Comment": "sample string 5",
    "Archived": true,
    "Helpful": true,
    "CreatedDate": "2024-04-20T04:37:38.440Z",
    "ArchivedDate": "2024-04-20T04:37:38.440Z",
    "DateUpdated": "2024-04-20T04:37:38.440Z"
  },
  {
    "CommentId": 1,
    "KnowledgeArticleID": 1,
    "UserID": "908bcdf9-c022-433d-b64a-d77bb8c28c6e",
    "UserFirstName": "sample string 2",
    "UserLastName": "sample string 3",
    "ArchivedbyUser": "b513facf-6b6d-46e7-ad67-d920e61a53af",
    "Comment": "sample string 5",
    "Archived": true,
    "Helpful": true,
    "CreatedDate": "2024-04-20T04:37:38.440Z",
    "ArchivedDate": "2024-04-20T04:37:38.440Z",
    "DateUpdated": "2024-04-20T04:37:38.440Z"
  }
]

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>2024-04-20T04:37:38.4409828+00:00</ArchivedDate>
    <ArchivedbyUser>b513facf-6b6d-46e7-ad67-d920e61a53af</ArchivedbyUser>
    <Comment>sample string 5</Comment>
    <CommentId>1</CommentId>
    <CreatedDate>2024-04-20T04:37:38.4409828+00:00</CreatedDate>
    <DateUpdated>2024-04-20T04:37:38.4409828+00:00</DateUpdated>
    <Helpful>true</Helpful>
    <KnowledgeArticleID>1</KnowledgeArticleID>
    <UserFirstName>sample string 2</UserFirstName>
    <UserID>908bcdf9-c022-433d-b64a-d77bb8c28c6e</UserID>
    <UserLastName>sample string 3</UserLastName>
  </KAComment>
  <KAComment>
    <Archived>true</Archived>
    <ArchivedDate>2024-04-20T04:37:38.4409828+00:00</ArchivedDate>
    <ArchivedbyUser>b513facf-6b6d-46e7-ad67-d920e61a53af</ArchivedbyUser>
    <Comment>sample string 5</Comment>
    <CommentId>1</CommentId>
    <CreatedDate>2024-04-20T04:37:38.4409828+00:00</CreatedDate>
    <DateUpdated>2024-04-20T04:37:38.4409828+00:00</DateUpdated>
    <Helpful>true</Helpful>
    <KnowledgeArticleID>1</KnowledgeArticleID>
    <UserFirstName>sample string 2</UserFirstName>
    <UserID>908bcdf9-c022-433d-b64a-d77bb8c28c6e</UserID>
    <UserLastName>sample string 3</UserLastName>
  </KAComment>
</ArrayOfKAComment>