3.3.5 Message Processing Events and Sequencing Rules

Resource

Description

items/index/{index}/count/{count}?path={path}&filter={filter}&sortbyfield={sortbyfield}&ascending={ascending}

ItemList object that represents a collection of file items in the specified folder.

items/index/{index}/count/{count}/search?query={query}&sortbyfield={sortbyfield}&ascending={ascending}&scope={scope}&timeoutseconds={timeoutseconds}

SearchItemList object that represents a collection of file items that match the specified keyword.

folder/newsubfoldername?path={path}&language={language}

Default available new folder name in specified language.

itemmetadata?path={path}

ItemInfo object that represents the specified file item.

folder?path={path}

Folder being created.

item/rename?path={path}&newname={newname}

File being renamed.

item/delete?path={path}

File item being deleted.

accessuri?path={path}

Temporary URI that can be used to download a file.

item/move?newpath={newpath}&originalpath={originalpath}

File item being moved from another location.

item/copy?newpath={newpath}&originalpath={originalpath}

File item being copied from another location.

The responses to all the operations can result in the following status codes.

Status code

Reason phrase

Description

200

OK

The operation successfully completed.

400

Bad Request

One or more parameters are not valid.

401

Unauthorized

Access to the requested resource is denied.

404

Not Found

The path does not exist.

501

Not Implemented

The server does not have the functionality to support the requested operation.

503

Service Unavailable

The server is currently unable to handle the request.

504

Gateway Timeout

The request does not finish within a given time interval.

201

Created

The request resource is created.

409

Conflict

The request fails due to a conflict with the current resource.