Changes between Version 16 and Version 17 of RestApi

Timestamp:

30.10.2011 23:36:27 (13 years ago)

Author:

jri

Comment:

Adapt "Topics by type" example to page conventions

RestApi

@@ -79 +79 @@
 (The error response might become more HTTP/REST conform in the furure.)
 
-=== Get topics by type_uri === 
-
-{{{
-GET /core/topic/by_type/<type_uri>
-}}}
-
-==== Example 1: Getting all topics of one type ====
-
-
-Requesting all topics of type "Web Resource" / "dm4.webbrowser.web_resource".
-
-{{{
-curl http://localhost:8080/core/topic/by_type/dm4.webbrowser.web_resource | jsonpretty
-}}}
-
-Response (as of deepamehta-4.0.5):
-
-{{{
-HTTP/1.1 200 OK
-Content-Type: application/json
-
-{
+=== Get topics by type === 
+
+{{{
+GET /core/topic/by_type/<Type URI>[?fetch_composite=true/false]
+}}}
+
+The default for `fetch_composite` is `false`.
+
+==== Example: Getting all "Web Resource" topics ''without'' their `composite` values  ====
+
+{{{
+curl localhost:8080/core/topic/by_type/dm4.webbrowser.web_resource | jsonpretty
+}}}
+
+Response:
+
+{{{
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+   "total_count" : 2,
    "items" : [
       {
+         "id" : 2436,
+         "uri" : "",
          "type_uri" : "dm4.webbrowser.web_resource",
-         "composite" : {},
          "value" : "JSON Format - your online JSON Formatter",
-         "id" : 2436,
-         "uri" : ""
+         "composite" : {}
       },
       {
+         "id" : 2259,
+         "uri" : "",
          "type_uri" : "dm4.webbrowser.web_resource",
-         "composite" : {},
          "value" : "DeepaMehta 4.0.5",
-         "id" : 2259,
-         "uri" : ""
+         "composite" : {}
       }
-   ],
-   "total_count" : 2
+   ]
 }