http://git-wip-us.apache.org/repos/asf/atlas-website/blob/58bb55a6/api/v2/resource_TypesREST.html ---------------------------------------------------------------------- diff --git a/api/v2/resource_TypesREST.html b/api/v2/resource_TypesREST.html index cc402f7..fe3b1ba 100644 --- a/api/v2/resource_TypesREST.html +++ b/api/v2/resource_TypesREST.html @@ -15,7 +15,7 @@ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css";> <!--custom css for these pages--> - <link rel="stylesheet" href="css/style.css"> + <link rel="stylesheet" href="css/enunciate.css"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -50,23 +50,23 @@ <div class="row"> <div class="col-sm-3 col-md-2 sidebar" id="apinav"> <ul class="nav nav-sidebar"> - <li><a href="#resource_TypesREST_deleteAtlasTypeDefs_DELETE">DELETE /v2/types/typedefs</a></li> - <li><a href="#resource_TypesREST_getAllTypeDefs_GET">GET /v2/types/typedefs</a></li> - <li><a href="#resource_TypesREST_createAtlasTypeDefs_POST">POST /v2/types/typedefs</a></li> - <li><a href="#resource_TypesREST_updateAtlasTypeDefs_PUT">PUT /v2/types/typedefs</a></li> - <li><a href="#resource_TypesREST_getTypeDefHeaders_GET">GET /v2/types/typedefs/headers</a></li> - <li><a href="#resource_TypesREST_getClassificationDefByGuid_GET"><abbr title="GET /v2/types/classificationdef/guid/{guid}">GET /v2/types/classificationde...</abbr></a></li> - <li><a href="#resource_TypesREST_getClassificationDefByName_GET"><abbr title="GET /v2/types/classificationdef/name/{name}">GET /v2/types/classificationde...</abbr></a></li> - <li><a href="#resource_TypesREST_getEntityDefByGuid_GET"><abbr title="GET /v2/types/entitydef/guid/{guid}">GET /v2/types/entitydef/guid/{...</abbr></a></li> - <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> - <li><a href="#resource_TypesREST_getTypeDefByName_GET"><abbr title="GET /v2/types/typedef/name/{name}">GET /v2/types/typedef/name/{na...</abbr></a></li> + <li><a href="#resource_TypesREST_deleteAtlasTypeDefs_DELETE"><abbr title="DELETE /v2/types/typedefs"><span class="sideoverflow">DELETE /v2/types/typedefs</span></abbr></a></li> + <li><a href="#resource_TypesREST_getAllTypeDefs_GET"><abbr title="GET /v2/types/typedefs"><span class="sideoverflow">GET /v2/types/typedefs</span></abbr></a></li> + <li><a href="#resource_TypesREST_createAtlasTypeDefs_POST"><abbr title="POST /v2/types/typedefs"><span class="sideoverflow">POST /v2/types/typedefs</span></abbr></a></li> + <li><a href="#resource_TypesREST_updateAtlasTypeDefs_PUT"><abbr title="PUT /v2/types/typedefs"><span class="sideoverflow">PUT /v2/types/typedefs</span></abbr></a></li> + <li><a href="#resource_TypesREST_getTypeDefHeaders_GET"><abbr title="GET /v2/types/typedefs/headers"><span class="sideoverflow">GET /v2/types/typedefs/headers</span></abbr></a></li> + <li><a href="#resource_TypesREST_getClassificationDefByGuid_GET"><abbr title="GET /v2/types/classificationdef/guid/{guid}"><span class="sideoverflow">GET /v2/types/classificationdef/guid/{guid}</span></abbr></a></li> + <li><a href="#resource_TypesREST_getClassificationDefByName_GET"><abbr title="GET /v2/types/classificationdef/name/{name}"><span class="sideoverflow">GET /v2/types/classificationdef/name/{name}</span></abbr></a></li> + <li><a href="#resource_TypesREST_getEntityDefByGuid_GET"><abbr title="GET /v2/types/entitydef/guid/{guid}"><span class="sideoverflow">GET /v2/types/entitydef/guid/{guid}</span></abbr></a></li> + <li><a href="#resource_TypesREST_getEntityDefByName_GET"><abbr title="GET /v2/types/entitydef/name/{name}"><span class="sideoverflow">GET /v2/types/entitydef/name/{name}</span></abbr></a></li> + <li><a href="#resource_TypesREST_getEnumDefByGuid_GET"><abbr title="GET /v2/types/enumdef/guid/{guid}"><span class="sideoverflow">GET /v2/types/enumdef/guid/{guid}</span></abbr></a></li> + <li><a href="#resource_TypesREST_getEnumDefByName_GET"><abbr title="GET /v2/types/enumdef/name/{name}"><span class="sideoverflow">GET /v2/types/enumdef/name/{name}</span></abbr></a></li> + <li><a href="#resource_TypesREST_getRelationshipDefByGuid_GET"><abbr title="GET /v2/types/relationshipdef/guid/{guid}"><span class="sideoverflow">GET /v2/types/relationshipdef/guid/{guid}</span></abbr></a></li> + <li><a href="#resource_TypesREST_getRelationshipDefByName_GET"><abbr title="GET /v2/types/relationshipdef/name/{name}"><span class="sideoverflow">GET /v2/types/relationshipdef/name/{name}</span></abbr></a></li> + <li><a href="#resource_TypesREST_getStructDefByGuid_GET"><abbr title="GET /v2/types/structdef/guid/{guid}"><span class="sideoverflow">GET /v2/types/structdef/guid/{guid}</span></abbr></a></li> + <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 class="divider"></li> <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> </ul> @@ -99,9 +99,9 @@ </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><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> @@ -134,409 +134,10 @@ <h5>Request</h5> <pre> DELETE /v2/types/typedefs -Content-Type: application/json - - <code class="prettyprint language-js"> -{ - "enumDefs" : [ { - "elementDefs" : [ { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - }, { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - } ], - "defaultValue" : "...", - "category" : "RELATIONSHIP", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "elementDefs" : [ { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - }, { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - } ], - "defaultValue" : "...", - "category" : "STRUCT", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - } ], - "structDefs" : [ { - "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" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "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" : "CLASSIFICATION", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - } ], - "classificationDefs" : [ { - "superTypes" : [ "...", "..." ], - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "LIST", - "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" : "STRUCT", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "superTypes" : [ "...", "..." ], - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SET", - "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" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - } ], - "entityDefs" : [ { - "superTypes" : [ "...", "..." ], - "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" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "superTypes" : [ "...", "..." ], - "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" : "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" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SET", - "valuesMinCount" : 12345, - "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" : "..." - } - }, { - "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" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - } ], - "empty" : true -} +Content-Type: application/json;charset=UTF-8 + + <code class="prettyprint language-txt"> +... </code> </pre> </div> @@ -583,9 +184,9 @@ 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><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> @@ -598,7 +199,7 @@ HTTP/1.1 204 No Content <h5>Request</h5> <pre> GET /v2/types/typedefs -Accept: application/json +Accept: application/json;charset=UTF-8 </pre> </div> @@ -606,409 +207,10 @@ Accept: application/json <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" : "ENUM", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "elementDefs" : [ { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - }, { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - } ], - "defaultValue" : "...", - "category" : "ENUM", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - } ], - "structDefs" : [ { - "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" : "ENTITY", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "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" : "OBJECT_ID_TYPE", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - } ], - "classificationDefs" : [ { - "superTypes" : [ "...", "..." ], - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SET", - "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" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "superTypes" : [ "...", "..." ], - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "LIST", - "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" : "..." - } - } ], - "entityDefs" : [ { - "superTypes" : [ "...", "..." ], - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SET", - "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" : "STRUCT", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "superTypes" : [ "...", "..." ], - "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" : "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" : "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" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - } ], - "empty" : true -} +Content-Type: application/json;charset=UTF-8 + + <code class="prettyprint language-txt"> +... </code> </pre> </div> @@ -1033,9 +235,9 @@ 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><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> @@ -1072,9 +274,9 @@ 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><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> @@ -1088,410 +290,11 @@ created</span></td> <h5>Request</h5> <pre> POST /v2/types/typedefs -Content-Type: application/json -Accept: 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, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "elementDefs" : [ { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - }, { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - } ], - "defaultValue" : "...", - "category" : "ENTITY", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - } ], - "structDefs" : [ { - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "LIST", - "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", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "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" : "STRUCT", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - } ], - "classificationDefs" : [ { - "superTypes" : [ "...", "..." ], - "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" : "ENTITY", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "superTypes" : [ "...", "..." ], - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "LIST", - "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" : "..." - } - } ], - "entityDefs" : [ { - "superTypes" : [ "...", "..." ], - "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" : "ENUM", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "superTypes" : [ "...", "..." ], - "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" : "STRUCT", - "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" : "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 -} +Content-Type: application/json;charset=UTF-8 +Accept: application/json;charset=UTF-8 + + <code class="prettyprint language-txt"> +... </code> </pre> </div> @@ -1499,409 +302,10 @@ Accept: application/json <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" : "RELATIONSHIP", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "elementDefs" : [ { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - }, { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - } ], - "defaultValue" : "...", - "category" : "OBJECT_ID_TYPE", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - } ], - "structDefs" : [ { - "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" : "PRIMITIVE", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "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" : "..." - } - } ], - "classificationDefs" : [ { - "superTypes" : [ "...", "..." ], - "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" : "RELATIONSHIP", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "superTypes" : [ "...", "..." ], - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "LIST", - "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" : "..." - } - } ], - "entityDefs" : [ { - "superTypes" : [ "...", "..." ], - "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" : "OBJECT_ID_TYPE", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "superTypes" : [ "...", "..." ], - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SET", - "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" : "...", - "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" : "...", - "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" : "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" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - } ], - "empty" : true -} +Content-Type: application/json;charset=UTF-8 + + <code class="prettyprint language-txt"> +... </code> </pre> </div> @@ -1925,9 +329,9 @@ Content-Type: application/json </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><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 type definition changes</span></td> </tr> </tbody> @@ -1964,9 +368,9 @@ Content-Type: application/json </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><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 object with lists of type definitions that were updated</span></td> </tr> </tbody> @@ -1979,410 +383,11 @@ Content-Type: application/json <h5>Request</h5> <pre> PUT /v2/types/typedefs -Content-Type: application/json -Accept: application/json - - <code class="prettyprint language-js"> -{ - "enumDefs" : [ { - "elementDefs" : [ { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - }, { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - } ], - "defaultValue" : "...", - "category" : "RELATIONSHIP", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "elementDefs" : [ { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - }, { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - } ], - "defaultValue" : "...", - "category" : "RELATIONSHIP", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - } ], - "structDefs" : [ { - "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" : "OBJECT_ID_TYPE", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SET", - "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" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - } ], - "classificationDefs" : [ { - "superTypes" : [ "...", "..." ], - "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" : "RELATIONSHIP", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "superTypes" : [ "...", "..." ], - "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" : "STRUCT", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - } ], - "entityDefs" : [ { - "superTypes" : [ "...", "..." ], - "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" : "OBJECT_ID_TYPE", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "superTypes" : [ "...", "..." ], - "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" : "ENUM", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - } ], - "relationshipDefs" : [ { - "relationshipCategory" : "AGGREGATION", - "propagateTags" : "TWO_TO_ONE", - "endDef1" : { - "type" : "...", - "name" : "..."
<TRUNCATED>
