From e45c0628a79c14349776ed32edf555919cde8930 Mon Sep 17 00:00:00 2001 From: Brett Sun Date: Thu, 16 Feb 2017 18:34:45 +0100 Subject: [PATCH] Add docs for GET requests --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 82c9520..2e50efe 100644 --- a/README.md +++ b/README.md @@ -253,6 +253,10 @@ To check if your POST was successful, try validating by doing the following: or +1. Try to [request for the entity with a GET request](#requesting-submitted-entities) + +or + 1. Open your browser and go to `http://localhost:9984/api/v1` (your locally running BigchainDB instance - if using the default Docker settings, use port `32768` instead). @@ -366,6 +370,17 @@ manifestation](#was-my-post-to-manifestations-successful) and use the returned Right's data instead. +### Requesting Submitted Entities + +You can retrieve any submitted entities via a GET to one of the following +endpoints with the entity's ID (usually the `@id` stripped of any relative URL +artifacts): + +* `/manifestations/`: Manifestations +* `/works/`: Works +* `/rights/`: Copyrights and Rights + + ### Querying the ownership history of a Right The ownership history of a Right is represented as an time-series array of