文章 List Blog Post REST 端点

URLs

GET api/v1/blogs/{blogid}/posts.xml (or .json)

LIST blog posts.

GET api/v1/blogs/posts.xml (or .json)

LIST blog posts.

GET api/v1/groups/{groupid}/blogs/posts.xml (or .json)

LIST blog posts.

请求参数

名称

类型

描述

必需

默认值

选项

AuthorId

int?

Id of author

BlogId

int?

Either GroupId or BlogId or BlogIds are required.

BlogIds

string

Either GroupId or BlogId or BlogIds are required. Used to filter by a list of blogs. Multiple values are separated with commas.

GroupId

int?

Either GroupId or BlogId or BlogIds are required.

IncludeSubGroups

bool?

Only used when GroupId is specified. Default is false.

ContentIds

string

Comma separated list of ContentIds. Used to limit to a specific set of blog posts as well as sort order if SoryBy is set to ContentIdsOrder

IncludeUnpublished

bool?

Include unpublished posts too? Default is published only.

SortBy

string

Options are: MostComments, MostRecent, MostViewed, Score:SCORE_ID, ContentIdsOrder. Default is MostRecent.

SortOrder

string

Options include Ascending, Descending. Default is Descending.

PostTarget

string

Do not document this property.

Tags

string

A comma separated list of tags to filter posts.

LogicallyOrTags

bool?

Filter posts by tags with OR. Default is false (AND tags).

DateFilter

DateTime?

A DateTime value used to filter posts.

DateFilterType

string

Only used when using a DateFilter. Options include Year, Month, Day.

PageSize

int?

Specify the number of results to return per page. If not set the default is 20. The max is 100.

PageIndex

int?

Specify the page number of paged results to return. Zero-based index. If not specified the default is 0.