Resource operations

RESTful APIs are stateless. The resource manager maintains the resource state that is reported as the resource representation. The client maintains the application state and the client might manipulate the resource locally, but until a PUT or POST is made, the resource as known by the resource manager is not changed.

Operation

HTTP Verb

Description

Create

POST

resource URI (payload = resource data)

Creates new resources. A synchronous POST returns the newly created resource. An asynchronous POST returns a TaskResource URI in the Location header. This URI tracks the progress of the POSToperation.

Read

GET

resource URI

Returns the requested resource representation(s)

Update

PUT

resource URI (payload = update data)

Updates an existing resource

PATCH

resource URI (payload = update data)

Updates a part of the resource. For example, when you only need to update one field of the resource.

Delete

DELETE

resource URI

Deletes the specified resource