Changes between Version 9 and Version 10 of RestApi

Timestamp:

04.09.2011 17:27:37 (13 years ago)

Author:

jri

Comment:

Create a topic type

RestApi

@@ -89 +89 @@
 For details about the topic format see DataFormat#Topic.
 
-For a create operation not all properties are involved:
+For a create operation not all of the topic's properties are involved:
 
 ||= Property =||= Mandatory / Optional =||
-|| `id` || Do //not// provide an ID. The ID will be system-generated. ||
-|| `uri` || Optional. Default URI is an empty string.  ||
+|| `uri` || Optional. Default URI is an empty string. ||
 || `type_uri` || Mandatory. ||
 || `value` || For a simple topic: Optional. Default value is an empty string. You can change the value later on through an update operation.\\\\For a complex topic: Do //not// specify a value. The value will be system-generated. ||
@@ -104 +103 @@
 -X POST \
 -H Content-Type:application/json \
--d '{type_uri: "dm4.contacts.city", value: "Port-au-Prince"}' \
+-d '{type_uri: "dm4.contacts.city",
+     value: "Port-au-Prince"}' \
 | jsonpretty
 }}}
@@ -159 +159 @@
 == Topic Types ==
 
-=== Getting all topic type URIs ===
+=== Get all topic type URIs ===
 
 {{{
@@ -247 +247 @@
 }}}
 
-=== Getting a topic type ===
+=== Get a topic type ===
 
 {{{
@@ -308 +308 @@
 For details about the topic type format see DataFormat#TopicType.
 
+=== Create a topic type ===
+
+{{{
+POST /core/topictype
+
+<the topic type to create>
+}}}
+
+For details about the topic type format see DataFormat#TopicType.
+
+For a create operation not all of the topic type's properties are involved:
+
+||= Property =||= Mandatory / Optional =||
+|| `uri` || Optional. Default URI is `domain.project.topic_type_<ID>`. You can change the URI later on through an update operation. However, the URI is typically specified at topic type creation time. ||
+|| `value` || Optional. Default topic type name is an empty string. You can change the name later on through an update operation. However, the name is typically specified at topic type creation time. ||
+|| `data_type_uri` || Mandatory. ||
+|| `index_mode_uris` || Optional. Default is no indexing. ||
+|| `assoc_defs` || For complex topic types: Optional. Default is no child types. You can add child types later on through an update operation. However, the child types are typically specified at topic type creation time.\\\\For simple topic types: Do //not// specify child types. ||
+|| `view_config_topics` || Optional. Default is no view models. ||
+
+==== Example 1: Creating a simple topic type ====
+
+{{{
+curl localhost:8080/core/topictype -i \
+-X POST \
+-H Content-Type:application/json \
+-d '{uri: "spaceorg.planetarium.planet",
+     value: "Planet",
+     data_type_uri: "dm4.core.text"}' \
+| jsonpretty
+}}}
+
+Response:
+
+{{{
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "id": 3505,
+  "uri": "spaceorg.planetarium.planet",
+  "type_uri": "dm4.core.topic_type",
+  "value": "Planet",
+  "composite": {
+  },
+  "data_type_uri": "dm4.core.text",
+  "index_mode_uris": [
+
+  ],
+  "assoc_defs": [
+
+  ],
+  "view_config_topics": [
+
+  ]
+}
+}}}
+
 == Association Types ==
 
-=== Getting all association type URIs ===
+=== Get all association type URIs ===
 
 {{{