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 2017/08/09 16:56:41 UTC
[4/8] atlas-website git commit: Updated with latest V2 API docs
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/resource_TypesREST.html
----------------------------------------------------------------------
diff --git a/api/v2/resource_TypesREST.html b/api/v2/resource_TypesREST.html
index de94d05..cc402f7 100644
--- a/api/v2/resource_TypesREST.html
+++ b/api/v2/resource_TypesREST.html
@@ -61,6 +61,8 @@
<li><a href="#resource_TypesREST_getEntityDefByName_GET"><abbr title="GET /v2/types/entitydef/name/{name}">GET /v2/types/entitydef/name/{...</abbr></a></li>
<li><a href="#resource_TypesREST_getEnumDefByGuid_GET"><abbr title="GET /v2/types/enumdef/guid/{guid}">GET /v2/types/enumdef/guid/{gu...</abbr></a></li>
<li><a href="#resource_TypesREST_getEnumDefByName_GET"><abbr title="GET /v2/types/enumdef/name/{name}">GET /v2/types/enumdef/name/{na...</abbr></a></li>
+ <li><a href="#resource_TypesREST_getRelationshipDefByGuid_GET"><abbr title="GET /v2/types/relationshipdef/guid/{guid}">GET /v2/types/relationshipdef/...</abbr></a></li>
+ <li><a href="#resource_TypesREST_getRelationshipDefByName_GET"><abbr title="GET /v2/types/relationshipdef/name/{name}">GET /v2/types/relationshipdef/...</abbr></a></li>
<li><a href="#resource_TypesREST_getStructDefByGuid_GET"><abbr title="GET /v2/types/structdef/guid/{guid}">GET /v2/types/structdef/guid/{...</abbr></a></li>
<li><a href="#resource_TypesREST_getStructDefByName_GET"><abbr title="GET /v2/types/structdef/name/{name}">GET /v2/types/structdef/name/{...</abbr></a></li>
<li><a href="#resource_TypesREST_getTypeDefByGuid_GET"><abbr title="GET /v2/types/typedef/guid/{guid}">GET /v2/types/typedef/guid/{gu...</abbr></a></li>
@@ -147,7 +149,7 @@ Content-Type: application/json
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "STRUCT",
+ "category" : "RELATIONSHIP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -172,7 +174,7 @@ Content-Type: application/json
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "ARRAY",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -197,19 +199,21 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ENUM",
+ "category" : "CLASSIFICATION",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -228,11 +232,12 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -243,9 +248,10 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ENUM",
+ "category" : "CLASSIFICATION",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -271,6 +277,7 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -281,9 +288,10 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "MAP",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -303,24 +311,26 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "STRUCT",
+ "category" : "CLASSIFICATION",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -341,21 +351,23 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
"category" : "CLASSIFICATION",
@@ -378,11 +390,68 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "OBJECT_ID_TYPE",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "relationshipDefs" : [ {
+ "relationshipCategory" : "COMPOSITION",
+ "propagateTags" : "BOTH",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "LIST",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
"cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -393,9 +462,65 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "STRUCT",
+ "category" : "RELATIONSHIP",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ }, {
+ "relationshipCategory" : "AGGREGATION",
+ "propagateTags" : "TWO_TO_ONE",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "RELATIONSHIP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -496,7 +621,7 @@ Content-Type: application/json
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "STRUCT",
+ "category" : "ENUM",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -546,19 +671,21 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "CLASSIFICATION",
+ "category" : "ENTITY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -582,16 +709,18 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
"category" : "OBJECT_ID_TYPE",
@@ -615,11 +744,12 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -630,9 +760,10 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "PRIMITIVE",
+ "category" : "CLASSIFICATION",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -652,24 +783,26 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ENTITY",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -690,24 +823,26 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ARRAY",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -732,19 +867,132 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "PRIMITIVE",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "relationshipDefs" : [ {
+ "relationshipCategory" : "COMPOSITION",
+ "propagateTags" : "TWO_TO_ONE",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
"cardinality" : "LIST",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ARRAY",
+ "category" : "ENTITY",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ }, {
+ "relationshipCategory" : "ASSOCIATION",
+ "propagateTags" : "NONE",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "CLASSIFICATION",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -856,7 +1104,7 @@ Accept: application/json
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "OBJECT_ID_TYPE",
+ "category" : "ARRAY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -881,7 +1129,7 @@ Accept: application/json
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "ENUM",
+ "category" : "ENTITY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -906,19 +1154,21 @@ Accept: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ENTITY",
+ "category" : "ARRAY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -937,11 +1187,12 @@ Accept: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -952,9 +1203,10 @@ Accept: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "CLASSIFICATION",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -975,24 +1227,26 @@ Accept: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "STRUCT",
+ "category" : "ENTITY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1012,24 +1266,26 @@ Accept: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ENTITY",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1050,21 +1306,23 @@ Accept: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
"category" : "ENUM",
@@ -1087,11 +1345,12 @@ Accept: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -1102,9 +1361,10 @@ Accept: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ENUM",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1119,13 +1379,124 @@ Accept: application/json
"property2" : "..."
}
} ],
- "empty" : true
-}
- </code>
- </pre>
- </div>
- <div class="col-md-6">
- <h5>Response</h5>
+ "relationshipDefs" : [ {
+ "relationshipCategory" : "COMPOSITION",
+ "propagateTags" : "BOTH",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "ENUM",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ }, {
+ "relationshipCategory" : "ASSOCIATION",
+ "propagateTags" : "NONE",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "LIST",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "OBJECT_ID_TYPE",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "empty" : true
+}
+ </code>
+ </pre>
+ </div>
+ <div class="col-md-6">
+ <h5>Response</h5>
<pre>
HTTP/1.1 200 OK
Content-Type: application/json
@@ -1143,7 +1514,7 @@ Content-Type: application/json
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "STRUCT",
+ "category" : "RELATIONSHIP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1168,7 +1539,7 @@ Content-Type: application/json
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "ENUM",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1193,6 +1564,7 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -1203,6 +1575,7 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
"category" : "PRIMITIVE",
@@ -1224,24 +1597,26 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "PRIMITIVE",
+ "category" : "CLASSIFICATION",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1267,19 +1642,21 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ENTITY",
+ "category" : "RELATIONSHIP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1299,24 +1676,26 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "CLASSIFICATION",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1337,24 +1716,26 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ENTITY",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1379,6 +1760,63 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "CLASSIFICATION",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "relationshipDefs" : [ {
+ "relationshipCategory" : "COMPOSITION",
+ "propagateTags" : "ONE_TO_TWO",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -1389,9 +1827,65 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "STRUCT",
+ "category" : "PRIMITIVE",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ }, {
+ "relationshipCategory" : "COMPOSITION",
+ "propagateTags" : "ONE_TO_TWO",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "LIST",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "CLASSIFICATION",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1501,7 +1995,7 @@ Accept: application/json
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "CLASSIFICATION",
+ "category" : "RELATIONSHIP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1526,7 +2020,7 @@ Accept: application/json
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "OBJECT_ID_TYPE",
+ "category" : "RELATIONSHIP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1546,24 +2040,26 @@ Accept: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "STRUCT",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1582,24 +2078,26 @@ Accept: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ARRAY",
+ "category" : "CLASSIFICATION",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1620,24 +2118,26 @@ Accept: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "OBJECT_ID_TYPE",
+ "category" : "RELATIONSHIP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1657,11 +2157,12 @@ Accept: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -1672,9 +2173,10 @@ Accept: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ENTITY",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1700,6 +2202,7 @@ Accept: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -1710,6 +2213,7 @@ Accept: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
"category" : "OBJECT_ID_TYPE",
@@ -1732,24 +2236,26 @@ Accept: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "CLASSIFICATION",
+ "category" : "ENUM",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1764,32 +2270,143 @@ Accept: application/json
"property2" : "..."
}
} ],
- "empty" : true
-}
- </code>
- </pre>
- </div>
- <div class="col-md-6">
- <h5>Response</h5>
- <pre>
-HTTP/1.1 200 OK
-Content-Type: application/json
-
- <code class="prettyprint language-js">
-{
- "enumDefs" : [ {
- "elementDefs" : [ {
- "value" : "...",
- "description" : "...",
- "ordinal" : 12345
- }, {
- "value" : "...",
- "description" : "...",
- "ordinal" : 12345
- } ],
- "defaultValue" : "...",
- "category" : "CLASSIFICATION",
- "guid" : "...",
+ "relationshipDefs" : [ {
+ "relationshipCategory" : "AGGREGATION",
+ "propagateTags" : "TWO_TO_ONE",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "CLASSIFICATION",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ }, {
+ "relationshipCategory" : "ASSOCIATION",
+ "propagateTags" : "TWO_TO_ONE",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "LIST",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "ENUM",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "empty" : true
+}
+ </code>
+ </pre>
+ </div>
+ <div class="col-md-6">
+ <h5>Response</h5>
+ <pre>
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+{
+ "enumDefs" : [ {
+ "elementDefs" : [ {
+ "value" : "...",
+ "description" : "...",
+ "ordinal" : 12345
+ }, {
+ "value" : "...",
+ "description" : "...",
+ "ordinal" : 12345
+ } ],
+ "defaultValue" : "...",
+ "category" : "ARRAY",
+ "guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
@@ -1813,7 +2430,7 @@ Content-Type: application/json
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "ENUM",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1838,19 +2455,21 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "PRIMITIVE",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1874,19 +2493,21 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "STRUCT",
+ "category" : "ENUM",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1912,19 +2533,21 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ARRAY",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1949,19 +2572,21 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "PRIMITIVE",
+ "category" : "MAP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1982,11 +2607,12 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -1997,9 +2623,10 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "PRIMITIVE",
+ "category" : "ENTITY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -2024,6 +2651,7 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -2034,6 +2662,118 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "RELATIONSHIP",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "relationshipDefs" : [ {
+ "relationshipCategory" : "AGGREGATION",
+ "propagateTags" : "NONE",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "PRIMITIVE",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ }, {
+ "relationshipCategory" : "COMPOSITION",
+ "propagateTags" : "TWO_TO_ONE",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
"category" : "ARRAY",
@@ -2122,7 +2862,7 @@ Content-Type: application/json
[ {
"guid" : "...",
"name" : "...",
- "category" : "STRUCT"
+ "category" : "RELATIONSHIP"
} ]
</code>
</pre>
@@ -2222,6 +2962,7 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -2244,6 +2985,7 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -2366,11 +3108,12 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -2393,6 +3136,7 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -2407,7 +3151,7 @@ Content-Type: application/json
}
} ]
} ],
- "category" : "ARRAY",
+ "category" : "RELATIONSHIP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -2515,11 +3259,186 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ]
+ } ],
+ "category" : "CLASSIFICATION",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+}
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_TypesREST_getEntityDefByName_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/entitydef/name/{name} <a href="../v2/types/entitydef/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p>Get the entity definition by it's name (unique)</p>
+
+ <table class="table resource-parameters">
+ <caption>Request Parameters</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="parameter-name">name</span></td>
+ <td>path</td>
+ <td><span class="parameter-description">entity name</span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <table class="table resource-response-codes">
+ <caption>Response Codes</caption>
+ <thead>
+ <tr>
+ <th>code</th>
+ <th>condition</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="label label-success response-code">200</span></td>
+ <td><span class="response-condition">On successful lookup of the the entity definition by it's name</span></td>
+ </tr>
+ <tr>
+ <td><span class="label label-warning response-code">404</span></td>
+ <td><span class="response-condition">On Failed lookup for the given name</span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <table class="table resource-response-body">
+ <caption>Response Body</caption>
+ <thead>
+ <tr>
+ <th>media type</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </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_AtlasEntityDef.html">AtlasEntityDef</a>
+ (JSON)</span></td>
+ <td><span class="response-description">Entity definition</span></td>
+ </tr>
+ </tbody>
+ </table>
+ <h4>Example</h4>
+
+ <div class="container-fluid example panel">
+ <div class="row panel-body">
+ <div class="col-md-6">
+ <h5>Request</h5>
+ <pre>
+GET /v2/types/entitydef/name/{name}
+Accept: application/json
+
+ </pre>
+ </div>
+ <div class="col-md-6">
+ <h5>Response</h5>
+ <pre>
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+{
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
"cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -2533,30 +3452,121 @@ Content-Type: application/json
"property2" : { }
}
} ]
+ } ],
+ "category" : "ARRAY",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+}
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_TypesREST_getEnumDefByGuid_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/enumdef/guid/{guid} <a href="../v2/types/enumdef/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p>Get the enum definition for the given guid</p>
+
+ <table class="table resource-parameters">
+ <caption>Request Parameters</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="parameter-name">guid</span></td>
+ <td>path</td>
+ <td><span class="parameter-description">enum guid</span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <table class="table resource-response-codes">
+ <caption>Response Codes</caption>
+ <thead>
+ <tr>
+ <th>code</th>
+ <th>condition</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="label label-success response-code">200</span></td>
+ <td><span class="response-condition">On successful lookup of the the enum definition by it's guid</span></td>
+ </tr>
+ <tr>
+ <td><span class="label label-warning response-code">404</span></td>
+ <td><span class="response-condition">On Failed lookup for the given guid</span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <table class="table resource-response-body">
+ <caption>Response Body</caption>
+ <thead>
+ <tr>
+ <th>media type</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </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_AtlasEnumDef.html">AtlasEnumDef</a>
+ (JSON)</span></td>
+ <td><span class="response-description">enum definition</span></td>
+ </tr>
+ </tbody>
+ </table>
+ <h4>Example</h4>
+
+ <div class="container-fluid example panel">
+ <div class="row panel-body">
+ <div class="col-md-6">
+ <h5>Request</h5>
+ <pre>
+GET /v2/types/enumdef/guid/{guid}
+Accept: application/json
+
+ </pre>
+ </div>
+ <div class="col-md-6">
+ <h5>Response</h5>
+ <pre>
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+{
+ "elementDefs" : [ {
+ "value" : "...",
+ "description" : "...",
+ "ordinal" : 12345
}, {
- "name" : "...",
- "typeName" : "...",
- "isOptional" : true,
- "cardinality" : "SINGLE",
- "valuesMinCount" : 12345,
- "valuesMaxCount" : 12345,
- "isUnique" : true,
- "isIndexable" : true,
- "constraints" : [ {
- "type" : "...",
- "params" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "type" : "...",
- "params" : {
- "property1" : { },
- "property2" : { }
- }
- } ]
+ "value" : "...",
+ "description" : "...",
+ "ordinal" : 12345
} ],
- "category" : "OBJECT_ID_TYPE",
+ "defaultValue" : "...",
+ "category" : "ARRAY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -2578,10 +3588,10 @@ Content-Type: application/json
</div>
</div>
- <div id="resource_TypesREST_getEntityDefByName_GET">
- <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/entitydef/name/{name} <a href="../v2/types/entitydef/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+ <div id="resource_TypesREST_getEnumDefByName_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/enumdef/name/{name} <a href="../v2/types/enumdef/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
- <p>Get the entity definition by it's name (unique)</p>
+ <p>Get the enum definition by it's name (unique)</p>
<table class="table resource-parameters">
<caption>Request Parameters</caption>
@@ -2596,7 +3606,7 @@ Content-Type: application/json
<tr>
<td><span class="parameter-name">name</span></td>
<td>path</td>
- <td><span class="parameter-description">entity name</span></td>
+ <td><span class="parameter-description">enum name</span></td>
</tr>
</tbody>
</table>
@@ -2612,7 +3622,7 @@ Content-Type: application/json
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
- <td><span class="response-condition">On successful lookup of the the entity definition by it's name</span></td>
+ <td><span class="response-condition">On successful lookup of the the enum definition by it's name</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">404</span></td>
@@ -2633,9 +3643,9 @@ Content-Type: application/json
<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_AtlasEntityDef.html">AtlasEntityDef</a>
+ <td><span class="datatype-reference"><a href="json_AtlasEnumDef.html">AtlasEnumDef</a>
(JSON)</span></td>
- <td><span class="response-description">Entity definition</span></td>
+ <td><span class="response-description">enum definition</span></td>
</tr>
</tbody>
</table>
@@ -2646,7 +3656,7 @@ Content-Type: application/json
<div class="col-md-6">
<h5>Request</h5>
<pre>
-GET /v2/types/entitydef/n
<TRUNCATED>