文章 List Search Result REST 端点

URLs

GET api/v1/related/{id}.xml (or .json)

LIST related content.

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

LIST search results.

请求参数

名称

类型

描述

必需

默认值

选项

Query

string

Query is not required but you should use either Query or Filters otherwise you'll get all documents in the search index.

Filters

string

Filters is not required but you should use either Query or Filters otherwise you'll get all documents in the search index.

Sort

string

Two options for sort are titlesort and date and it also supports asc and desc. To sort by title ascending use sort=titlesort+asc, to sort by date descending use sort=date+desc.

StartDate

DateTime?

Start Date

EndDate

DateTime?

End Date

Collapse

bool?

Result collapsing will default to false if not specified.

FieldFacets

string

Field Facets

DateRangeFacets

string

Date Range Facets

FieldFilters

string

Field Filters

DateRangeFilters

string

Date Range Filters

Tags

string

Comma delimited list of tags.

LogicallyOrTags

bool?

Whether to AND or OR tags specified in the Tags parameter. Default is False, logically AND tags.

Mlt

bool?

More Like This. Can be used in conjunction with Filters. If using MLT, Id should be set.

Id

string

Used when using MLT.

GuidId

Guid?

The GUID representing the content.

ApplicationId

Guid?

The GUID representing the application.

ContainerId

Guid?

The GUID representing the container.

Category

string

Category

IsContent

bool?

Is Content

IsApplication

bool?

Is Application

IsContainer

bool?

Is Container

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.