Return to Answer

Thanks Cassio for emphasizing the 'changing the object state' approach.

My own answer for completeness:

PATCH /resources/{resourceId} with body {"active":false} -- deactivate a resource PATCH /resources/{resourceId} with body {"active":true} -- restore a resource GET /resources -- return all 'normal' resources GET /resources?includeInactive=true -- return all resources including the deactivated ones GET /resources/{resourceId} -- return the resource 

(The resources retrieved by 'GET' will contain the attribute 'active=true/false').

Seems like a classic case for PATCH: When I should use PATCH or PUT in my REST API request and Design?

Thanks Cassio for emphasizing the 'changing the object state' approach.

My own answer for completeness:

PATCH /resources/{resourceId} with body {"active":false} -- deactivate a resource PATCH /resources/{resourceId} with body {"active":true} -- restore a resource GET /resources -- return all 'normal' resources GET /resources?includeInactive=true -- return all resources including the deactivated ones GET /resources/{resourceId} -- return the resource 

(The resources retrieved by 'GET' will contain the attribute 'active=true/false').

Seems like a classic case for PATCH: When I should use PATCH or PUT in my REST API request and Design?

Thanks Cassio for emphasizing the 'changing the object state' approach.

My own answer for completeness:

PATCH /resources/{resourceId} with body {"active":false} -- deactivate a resource PATCH /resources/{resourceId} with body {"active":true} -- restore a resource GET /resources -- return all 'normal' resources GET /resources?includeInactive=true -- return all resources including the deactivated ones GET /resources/{resourceId} -- return the resource 

(The resources retrieved by 'GET' will contain the attribute 'active=true/false').

Thanks Cassio for emphasizing the 'changing the object state' approach.

My own answer for completeness:

PATCH /resources/{resourceId} with body {"active":false} -- deactivate a resource PATCH /resources/{resourceId} with body {"active":true} -- restore a resource GET /resources -- return all 'normal' resources GET /resources?includeInactive=true -- return all resources including the deactivated ones GET /resources/{resourceId} -- return the resource 

(The resources retrieved by 'GET' will contain the attribute 'active=true/false').

Seems like a classic case for PATCH: When I should use PATCH or PUT in my REST API request and Design?

Thanks Cassio for emphasizing the 'changing the object state' approach.

My own answer for completeness:

POST or PATCH /resources/{resourceId}/hidden -- deactivate a resource DELETE /resources/{resourceId}/hidden -- restore a resource GET /resources -- return all 'normal' resources GET /resources?hidden=true  -- return all deactivated resources GET /resources/{resourceId} -- return the resource 

(The resources retrieved by 'GET' will contain the attribute 'hidden=true/false').

That is, conceptually there is a boolean object (the 'hidden' flag) on top of the 'resource', that can be either created or deleted and whose presence changes the nature of the 'resource', i.e. a resource with this flag present ceases to be a 'normal' one.

Similar approach in GitHub: https://developer.github.com/v3/gists/#star-a-gist

Thanks Cassio for emphasizing the 'changing the object state' approach.

My own answer for completeness:

PATCH /resources/{resourceId} with body {"active":false}  -- deactivate a resource PATCH /resources/{resourceId} with body {"active":true}  -- restore a resource GET /resources -- return all 'normal' resources GET /resources?includeInactive=true -- return all resources including the deactivated ones GET /resources/{resourceId} -- return the resource 

(The resources retrieved by 'GET' will contain the attribute 'active=true/false').