GET - resources/{resourceName}/sorted

Search for items in the resource, and returns a sorted paged result list.
When using paging, you can either specify a page number or a an item id.

URI

resources/{resourceName}/sorted

HTTP Method

Get

Request parameters

Name	Location	Type	Description
API-KEY	http header	apiKey	The API key previously generated by calling the GenerateApiKey function
resourceName	uri	resourceName	The name of the resource
parentFolderPath	query	folderPath	The folder path where the search will originate
includeSubDirectories	query	bool	If true, the search will include items in sub-directories of the specified parent folder
name	query	string	The name to search on
pageSize	query	int	Number of items per page
pageNum	query	int	1-based index of the page to return
sortOn	query	string	The field to sort the results on
sortOrder	query	sortOrder	The sorting direction
itemID	query	itemID	When an itemID is specified, it will take precedence over the pageNum. The page containing this item will be returned.

HTTP Return Status

Ok

Returns

xmlString

The results include the total amount of found items, total amount of pages, and current page:
When an item id is specified in the request, the page containing that item will be returned.

The items are sorted on the specifed field, in the specified sorting order.

A valid XML string

Security rights needed

Browse

Apply on resource

Resource from function parameter resourceName