You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@atlas.apache.org by ap...@apache.org on 2018/10/22 16:15:03 UTC
[21/27] atlas-website git commit: Updated REST docs for 1.x releases
(part 2)
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/d115dad8/1.0.0/api/v2/resource_TypesREST.html
----------------------------------------------------------------------
diff --git a/1.0.0/api/v2/resource_TypesREST.html b/1.0.0/api/v2/resource_TypesREST.html
index 17064fa..764df82 100644
--- a/1.0.0/api/v2/resource_TypesREST.html
+++ b/1.0.0/api/v2/resource_TypesREST.html
@@ -67,6 +67,7 @@
<li><a href="#resource_TypesREST_getStructDefByName_GET"><abbr title="GET /v2/types/structdef/name/{name}"><span class="sideoverflow">GET /v2/types/structdef/name/{name}</span></abbr></a></li>
<li><a href="#resource_TypesREST_getTypeDefByGuid_GET"><abbr title="GET /v2/types/typedef/guid/{guid}"><span class="sideoverflow">GET /v2/types/typedef/guid/{guid}</span></abbr></a></li>
<li><a href="#resource_TypesREST_getTypeDefByName_GET"><abbr title="GET /v2/types/typedef/name/{name}"><span class="sideoverflow">GET /v2/types/typedef/name/{name}</span></abbr></a></li>
+ <li><a href="#resource_TypesREST_deleteAtlasTypeByName_DELETE"><abbr title="DELETE /v2/types/typedef/name/{typeName}"><span class="sideoverflow">DELETE /v2/types/typedef/name/{typeName}</span></abbr></a></li>
<li class="divider"></li>
<li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
</ul>
@@ -99,10 +100,15 @@
</thead>
<tbody>
<tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference"><a href="json_AtlasTypesDef.html">AtlasTypesDef</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="request-description">A composite object that captures all types to be deleted</span></td>
+ </tr>
+ <tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json;charset=UTF-8" HTTP header to specify this media type to the server."><span class="request-type">application/json;charset=UTF-8</span></abbr></td>
<td><span class="datatype-reference">(custom)
</span></td>
- <td><span class="request-description">A composite object that captures all types to be deleted</span></td>
</tr>
</tbody>
</table>
@@ -134,10 +140,624 @@
<h5>Request</h5>
<pre>
DELETE /v2/types/typedefs
-Content-Type: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+{
+ "classificationDefs" : [ {
+ "entityTypes" : [ "...", "..." ],
+ "subTypes" : [ "...", "..." ],
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "cardinality" : "SET",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "SINGLE",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "RELATIONSHIP",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ }, {
+ "entityTypes" : [ "...", "..." ],
+ "subTypes" : [ "...", "..." ],
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "cardinality" : "SINGLE",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "SINGLE",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "ENUM",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ } ],
+ "entityDefs" : [ {
+ "subTypes" : [ "...", "..." ],
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "cardinality" : "SINGLE",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "LIST",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "ENTITY",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ }, {
+ "subTypes" : [ "...", "..." ],
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "cardinality" : "LIST",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "SET",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "ENTITY",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ } ],
+ "enumDefs" : [ {
+ "defaultValue" : "...",
+ "elementDefs" : [ {
+ "description" : "...",
+ "ordinal" : 12345,
+ "value" : "..."
+ }, {
+ "description" : "...",
+ "ordinal" : 12345,
+ "value" : "..."
+ } ],
+ "category" : "ENUM",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ }, {
+ "defaultValue" : "...",
+ "elementDefs" : [ {
+ "description" : "...",
+ "ordinal" : 12345,
+ "value" : "..."
+ }, {
+ "description" : "...",
+ "ordinal" : 12345,
+ "value" : "..."
+ } ],
+ "category" : "PRIMITIVE",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ } ],
+ "relationshipDefs" : [ {
+ "endDef1" : {
+ "cardinality" : "SET",
+ "description" : "...",
+ "isContainer" : true,
+ "isLegacyAttribute" : true,
+ "name" : "...",
+ "type" : "..."
+ },
+ "endDef2" : {
+ "cardinality" : "SET",
+ "description" : "...",
+ "isContainer" : true,
+ "isLegacyAttribute" : true,
+ "name" : "...",
+ "type" : "..."
+ },
+ "propagateTags" : "BOTH",
+ "relationshipCategory" : "COMPOSITION",
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "cardinality" : "LIST",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "LIST",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "PRIMITIVE",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ }, {
+ "endDef1" : {
+ "cardinality" : "SINGLE",
+ "description" : "...",
+ "isContainer" : true,
+ "isLegacyAttribute" : true,
+ "name" : "...",
+ "type" : "..."
+ },
+ "endDef2" : {
+ "cardinality" : "SINGLE",
+ "description" : "...",
+ "isContainer" : true,
+ "isLegacyAttribute" : true,
+ "name" : "...",
+ "type" : "..."
+ },
+ "propagateTags" : "ONE_TO_TWO",
+ "relationshipCategory" : "COMPOSITION",
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "cardinality" : "SET",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "LIST",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "RELATIONSHIP",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ } ],
+ "structDefs" : [ {
+ "attributeDefs" : [ {
+ "cardinality" : "SINGLE",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "LIST",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "MAP",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ }, {
+ "attributeDefs" : [ {
+ "cardinality" : "SINGLE",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "SET",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "ENUM",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ } ]
+}
</code>
</pre>
</div>
@@ -184,10 +804,15 @@ HTTP/1.1 204 No Content
</thead>
<tbody>
<tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference"><a href="json_AtlasTypesDef.html">AtlasTypesDef</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="response-description">A composite wrapper object with lists of all type definitions</span></td>
+ </tr>
+ <tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td>
<td><span class="datatype-reference">(custom)
</span></td>
- <td><span class="response-description">A composite wrapper object with lists of all type definitions</span></td>
</tr>
</tbody>
</table>
@@ -199,8 +824,8 @@ HTTP/1.1 204 No Content
<h5>Request</h5>
<pre>
GET /v2/types/typedefs
-Content-Type: */*
-Accept: application/json;charset=UTF-8
+Content-Type: application/json
+Accept: application/json
<code class="prettyprint language-txt">
...
@@ -211,10 +836,624 @@ Accept: application/json;charset=UTF-8
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
-Content-Type: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+{
+ "classificationDefs" : [ {
+ "entityTypes" : [ "...", "..." ],
+ "subTypes" : [ "...", "..." ],
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "cardinality" : "SET",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "LIST",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "OBJECT_ID_TYPE",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ }, {
+ "entityTypes" : [ "...", "..." ],
+ "subTypes" : [ "...", "..." ],
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "cardinality" : "LIST",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "LIST",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "OBJECT_ID_TYPE",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ } ],
+ "entityDefs" : [ {
+ "subTypes" : [ "...", "..." ],
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "cardinality" : "SET",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "SET",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "CLASSIFICATION",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ }, {
+ "subTypes" : [ "...", "..." ],
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "cardinality" : "SET",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "SINGLE",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "MAP",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ } ],
+ "enumDefs" : [ {
+ "defaultValue" : "...",
+ "elementDefs" : [ {
+ "description" : "...",
+ "ordinal" : 12345,
+ "value" : "..."
+ }, {
+ "description" : "...",
+ "ordinal" : 12345,
+ "value" : "..."
+ } ],
+ "category" : "RELATIONSHIP",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ }, {
+ "defaultValue" : "...",
+ "elementDefs" : [ {
+ "description" : "...",
+ "ordinal" : 12345,
+ "value" : "..."
+ }, {
+ "description" : "...",
+ "ordinal" : 12345,
+ "value" : "..."
+ } ],
+ "category" : "ENUM",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ } ],
+ "relationshipDefs" : [ {
+ "endDef1" : {
+ "cardinality" : "SET",
+ "description" : "...",
+ "isContainer" : true,
+ "isLegacyAttribute" : true,
+ "name" : "...",
+ "type" : "..."
+ },
+ "endDef2" : {
+ "cardinality" : "SINGLE",
+ "description" : "...",
+ "isContainer" : true,
+ "isLegacyAttribute" : true,
+ "name" : "...",
+ "type" : "..."
+ },
+ "propagateTags" : "ONE_TO_TWO",
+ "relationshipCategory" : "ASSOCIATION",
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "cardinality" : "SET",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "SET",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "OBJECT_ID_TYPE",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ }, {
+ "endDef1" : {
+ "cardinality" : "SET",
+ "description" : "...",
+ "isContainer" : true,
+ "isLegacyAttribute" : true,
+ "name" : "...",
+ "type" : "..."
+ },
+ "endDef2" : {
+ "cardinality" : "SET",
+ "description" : "...",
+ "isContainer" : true,
+ "isLegacyAttribute" : true,
+ "name" : "...",
+ "type" : "..."
+ },
+ "propagateTags" : "TWO_TO_ONE",
+ "relationshipCategory" : "ASSOCIATION",
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "cardinality" : "SET",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "SINGLE",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "CLASSIFICATION",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ } ],
+ "structDefs" : [ {
+ "attributeDefs" : [ {
+ "cardinality" : "LIST",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "SINGLE",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "OBJECT_ID_TYPE",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ }, {
+ "attributeDefs" : [ {
+ "cardinality" : "LIST",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "SET",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "STRUCT",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ } ]
+}
</code>
</pre>
</div>
@@ -239,10 +1478,15 @@ Any changes to the existing definitions will be discarded</p>
</thead>
<tbody>
<tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference"><a href="json_AtlasTypesDef.html">AtlasTypesDef</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="request-description">A composite wrapper object with corresponding lists of the type definition</span></td>
+ </tr>
+ <tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json;charset=UTF-8" HTTP header to specify this media type to the server."><span class="request-type">application/json;charset=UTF-8</span></abbr></td>
<td><span class="datatype-reference">(custom)
</span></td>
- <td><span class="request-description">A composite wrapper object with corresponding lists of the type definition</span></td>
</tr>
</tbody>
</table>
@@ -278,11 +1522,16 @@ Any changes to the existing definitions will be discarded</p>
</thead>
<tbody>
<tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference"><a href="json_AtlasTypesDef.html">AtlasTypesDef</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="response-description">A composite wrapper object with lists of type definitions that were successfully
+created</span></td>
+ </tr>
+ <tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td>
<td><span class="datatype-reference">(custom)
</span></td>
- <td><span class="response-description">A composite wrapper object with lists of type definitions that were successfully
-created</span></td>
</tr>
</tbody>
</table>
@@ -294,11 +1543,625 @@ created</span></td>
<h5>Request</h5>
<pre>
POST /v2/types/typedefs
-Content-Type: application/json;charset=UTF-8
-Accept: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+Accept: application/json
+
+ <code class="prettyprint language-js">
+{
+ "classificationDefs" : [ {
+ "entityTypes" : [ "...", "..." ],
+ "subTypes" : [ "...", "..." ],
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "cardinality" : "LIST",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "SINGLE",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "OBJECT_ID_TYPE",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ }, {
+ "entityTypes" : [ "...", "..." ],
+ "subTypes" : [ "...", "..." ],
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "cardinality" : "LIST",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "SINGLE",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "OBJECT_ID_TYPE",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ } ],
+ "entityDefs" : [ {
+ "subTypes" : [ "...", "..." ],
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "cardinality" : "SET",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "LIST",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "PRIMITIVE",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ }, {
+ "subTypes" : [ "...", "..." ],
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "cardinality" : "SET",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "SINGLE",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "ENTITY",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ } ],
+ "enumDefs" : [ {
+ "defaultValue" : "...",
+ "elementDefs" : [ {
+ "description" : "...",
+ "ordinal" : 12345,
+ "value" : "..."
+ }, {
+ "description" : "...",
+ "ordinal" : 12345,
+ "value" : "..."
+ } ],
+ "category" : "CLASSIFICATION",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ }, {
+ "defaultValue" : "...",
+ "elementDefs" : [ {
+ "description" : "...",
+ "ordinal" : 12345,
+ "value" : "..."
+ }, {
+ "description" : "...",
+ "ordinal" : 12345,
+ "value" : "..."
+ } ],
+ "category" : "RELATIONSHIP",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ } ],
+ "relationshipDefs" : [ {
+ "endDef1" : {
+ "cardinality" : "SET",
+ "description" : "...",
+ "isContainer" : true,
+ "isLegacyAttribute" : true,
+ "name" : "...",
+ "type" : "..."
+ },
+ "endDef2" : {
+ "cardinality" : "SINGLE",
+ "description" : "...",
+ "isContainer" : true,
+ "isLegacyAttribute" : true,
+ "name" : "...",
+ "type" : "..."
+ },
+ "propagateTags" : "BOTH",
+ "relationshipCategory" : "AGGREGATION",
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "cardinality" : "SET",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "SINGLE",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "STRUCT",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ }, {
+ "endDef1" : {
+ "cardinality" : "SINGLE",
+ "description" : "...",
+ "isContainer" : true,
+ "isLegacyAttribute" : true,
+ "name" : "...",
+ "type" : "..."
+ },
+ "endDef2" : {
+ "cardinality" : "LIST",
+ "description" : "...",
+ "isContainer" : true,
+ "isLegacyAttribute" : true,
+ "name" : "...",
+ "type" : "..."
+ },
+ "propagateTags" : "BOTH",
+ "relationshipCategory" : "AGGREGATION",
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "cardinality" : "SET",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "LIST",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "PRIMITIVE",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ } ],
+ "structDefs" : [ {
+ "attributeDefs" : [ {
+ "cardinality" : "SET",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "LIST",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "MAP",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ }, {
+ "attributeDefs" : [ {
+ "cardinality" : "SET",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "LIST",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "ARRAY",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ } ]
+}
</code>
</pre>
</div>
@@ -306,10 +2169,624 @@ Accept: application/json;charset=UTF-8
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
-Content-Type: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+{
+ "classificationDefs" : [ {
+ "entityTypes" : [ "...", "..." ],
+ "subTypes" : [ "...", "..." ],
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "cardinality" : "LIST",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "SINGLE",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "STRUCT",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ }, {
+ "entityTypes" : [ "...", "..." ],
+ "subTypes" : [ "...", "..." ],
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "cardinality" : "SINGLE",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "SINGLE",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "MAP",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ } ],
+ "entityDefs" : [ {
+ "subTypes" : [ "...", "..." ],
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "cardinality" : "LIST",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ }, {
+ "cardinality" : "SINGLE",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeName" : "...",
+ "valuesMaxCount" : 12345,
+ "valuesMinCount" : 12345
+ } ],
+ "category" : "PRIMITIVE",
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "dateFormatter" : {
+ "availableLocales" : [ "...", "..." ],
+ "calendar" : 12345,
+ "dateInstance" : { },
+ "dateTimeInstance" : { },
+ "instance" : { },
+ "lenient" : true,
+ "numberFormat" : { },
+ "timeInstance" : { },
+ "timeZone" : { }
+ },
+ "description" : "...",
+ "guid" : "...",
+ "name" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "typeVersion" : "...",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345
+ }, {
+ "subTypes" : [ "...", "..." ],
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "cardinality" : "SINGLE",
+ "constraints" : [ { }, { } ],
+ "defaultValue" : "...",
+ "description" : "...",
+ "includeInNotification" : true,
+ "isIndexable" : true,
+ "isOptional" : true,
+ "isUnique" : true,
+ "name" : "...",
+ "options" : {
+ &q
<TRUNCATED>