Patch shares

Performs a set of share management actions as specified in a JSON patch. The actions are performed synchronously and transactionally. A resource collection of all created and revised shares is returned. If the patch is not successfully applied, changes are rolled back.

For every action, the patch must specify an operation (add, replace, remove, test, or copy) and a target URI (for example, /authorization/shares/{shareId} or, to create a new share, /authorization/shares). Each add and replace operation requires a valid share representation.

patch/shares

Request

Base URL: http://example.com/authorization
URL: http://example.com/authorization/shares
Auth: none declared

Query parameters

validateSharedWithboolean

If true, the share recipient specified in the request body will be validated.

Request body

op'add' | 'replace' | 'remove' required

The type of operation to perform on the defined share.

pathstring required

The URI of the share.

Response

The request succeeded. Returned if the patch was applied successfully.

namestring

The name of the collection.

startinteger

The zero-based index of the first item in the collection.

limitinteger

The number of items that were requested for the collection.

countinteger

If populated indicates the number of items in the collection.

acceptstring

A space-delimited list of media types from which an Accept header may be constructed.

versioninteger

The version number of the collection representation. This representation is version 2.

Changes

No recorded changes to this operation across all 1 revision of this API.