文章 List Comment REST 端点

URLs

GET api/v1/comments.xml (or .json)

LIST comments.

请求参数

名称

类型

描述

必需

默认值

选项

CommentIds

string

Comma separated list of Comment Ids. Used to filter comments and sort order if SoryBy is set to CommentIdsOrder

否

ContentId

Guid?

Content identifier

否

ContentUrl

string

Content url

否

ContainerId

Guid?

Content container identifier

否

IncludeSubContainers

bool?

Include sub containers

否

ApplicationId

Guid?

Content application identifier

否

ContentTypeId

Guid?

Content type identifier

否

UserId

int?

User identifier

否

CommentTypeId

Guid?

Categorization type

否

SortBy

string

Sort by CommentId, ParentCommentId, CommentTypeId, CreatedUtcDate, CreatedUserId, LastUpdatedUtcDate, LastUpdatedUserId, Body, FormattedBody, SortOrder, IpAddress, IsApproved, IsFeatured, ContainerId, ApplicationId, ContentTypeId, NodeId, ContentId, Score:SCORE_ID, CommentIdsOrder

否

SortOrder

string

Sort order 'Ascending' or 'Descending'

否

IsApproved

bool?

Approval status

否

IsFeatured

bool?

Feature state

否

IncludeChildren

bool?

Include child comments. False by default.

否

PageSize

int?

Page size to retrieve

否

PageIndex

int?

Page index to retrieve

否

ParentCommentId

Guid?

Parent comment Id

否

PostTarget

string

Do not document this property.

否