http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/b4557f9c/0.8.0-incubating/api/v2/resource_TypesREST.html ---------------------------------------------------------------------- diff --git a/0.8.0-incubating/api/v2/resource_TypesREST.html b/0.8.0-incubating/api/v2/resource_TypesREST.html new file mode 100644 index 0000000..de94d05 --- /dev/null +++ b/0.8.0-incubating/api/v2/resource_TypesREST.html @@ -0,0 +1,3489 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> + + <title>Atlas REST API: TypesREST</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- Bootstrap core CSS --> + <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"> + + <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> + <![endif]--> +</head> + +<body data-spy="scroll" data-target="#apinav"> + + <nav class="navbar navbar-inverse navbar-fixed-top"> + <div class="container-fluid"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="index.html">Atlas REST API: TypesREST</a> + </div> + <div id="navbar" class="navbar-collapse collapse"> + <ul class="nav navbar-nav navbar-right"> + <li><a href="resources.html">Resources</a></li> + <li><a href="data.html">Data Types</a></li> + </ul> + </div> + </div> + </nav> + + <div class="container-fluid"> + <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_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 class="divider"></li> + <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> + </ul> + </div> + + <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main"> + <ol class="breadcrumb" id="top"> + <li class="active dropdown"><a href="index.html">Home</a></li> + <li class="active dropdown"><a href="resources.html">Resources</a></li> + <li class="dropdown"><a href="resource_TypesREST.html">TypesREST</a></li> + </ol> + + <h1 class="page-header">TypesREST <small>Resource</small></h1> + + <p>REST interface for CRUD operations on type definitions</p> + + <div id="resource_TypesREST_deleteAtlasTypeDefs_DELETE"> + <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/types/typedefs <a href="../v2/types/typedefs" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Bulk delete API for all types</p> + + <table class="table resource-request-body"> + <caption>Request 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 "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><span class="request-description">A composite object that captures all types to be deleted</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">204</span></td> + <td><span class="response-condition">On successful deletion of the requested type definitions</span></td> + </tr> + <tr> + <td><span class="label label-warning response-code">400</span></td> + <td><span class="response-condition">On validation failure for any type definitions</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> +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" : "STRUCT", + "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" : "ARRAY", + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "ENUM", + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "ENUM", + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "MAP", + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "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" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "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" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "STRUCT", + "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 204 No Content + + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_TypesREST_getAllTypeDefs_GET"> + <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/typedefs <a href="../v2/types/typedefs" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Bulk retrieval API for retrieving all type definitions in Atlas</p> + + <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">AtlasTypesDef with type definitions matching the search criteria or else returns empty list of type definitions</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_AtlasTypesDef.html">AtlasTypesDef</a> + (JSON)</span></td> + <td><span class="response-description">A composite wrapper object with lists of all type definitions</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/typedefs +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"> +{ + "enumDefs" : [ { + "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" : "..." + } + }, { + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "CLASSIFICATION", + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "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" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "PRIMITIVE", + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "ENTITY", + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "ARRAY", + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "ARRAY", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } + } ], + "empty" : true +} + </code> + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_TypesREST_createAtlasTypeDefs_POST"> + <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/types/typedefs <a href="../v2/types/typedefs" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Bulk create APIs for all atlas type definitions, only new definitions will be created. +Any changes to the existing definitions will be discarded</p> + + <table class="table resource-request-body"> + <caption>Request 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 "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><span class="request-description">A composite wrapper object with corresponding lists of the type definition</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 update of requested type definitions</span></td> + </tr> + <tr> + <td><span class="label label-warning response-code">400</span></td> + <td><span class="response-condition">On validation failure for any type definitions</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_AtlasTypesDef.html">AtlasTypesDef</a> + (JSON)</span></td> + <td><span class="response-description">A composite wrapper object with lists of type definitions that were successfully +created</span></td> + </tr> + </tbody> + </table> + <h4>Example</h4> + + <div class="container-fluid example panel"> + <div class="row panel-body"> + <div class="col-md-6"> + <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" : "OBJECT_ID_TYPE", + "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" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "ENTITY", + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "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" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "ENTITY", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } + } ], + "entityDefs" : [ { + "superTypes" : [ "...", "..." ], + "attributeDefs" : [ { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "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" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "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" : "STRUCT", + "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" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "PRIMITIVE", + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "PRIMITIVE", + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "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" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "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" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "STRUCT", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } + } ], + "empty" : true +} + </code> + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_TypesREST_updateAtlasTypeDefs_PUT"> + <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/types/typedefs <a href="../v2/types/typedefs" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Bulk update API for all types, changes detected in the type definitions would be persisted</p> + + <table class="table resource-request-body"> + <caption>Request 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 "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><span class="request-description">A composite object that captures all type definition changes</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 update of requested type definitions</span></td> + </tr> + <tr> + <td><span class="label label-warning response-code">400</span></td> + <td><span class="response-condition">On validation failure for any type definitions</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_AtlasTypesDef.html">AtlasTypesDef</a> + (JSON)</span></td> + <td><span class="response-description">A composite object with lists of type definitions that were updated</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> +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" : "CLASSIFICATION", + "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" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "STRUCT", + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "ARRAY", + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "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" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "ENTITY", + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "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" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "CLASSIFICATION", + "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" : "CLASSIFICATION", + "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" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "PRIMITIVE", + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "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" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "ARRAY", + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "PRIMITIVE", + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "PRIMITIVE", + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "ARRAY", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } + } ], + "empty" : true +} + </code> + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_TypesREST_getTypeDefHeaders_GET"> + <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/typedefs/headers <a href="../v2/types/typedefs/headers" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Bulk retrieval API for all type definitions returned as a list of minimal information header</p> + + <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">Returns a list of AtlasTypeDefHeader matching the search criteria +or an empty list if no match.</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">array of <a href="json_AtlasTypeDefHeader.html">AtlasTypeDefHeader</a> + (JSON)</span></td> + <td><span class="response-description">List of AtlasTypeDefHeader AtlasTypeDefHeader</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/typedefs/headers +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"> +[ { + "guid" : "...", + "name" : "...", + "category" : "STRUCT" +} ] + </code> + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_TypesREST_getClassificationDefByGuid_GET"> + <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/classificationdef/guid/{guid} <a href="../v2/types/classificationdef/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Get the classification 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">classification 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 classification 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_AtlasClassificationDef.html">AtlasClassificationDef</a> + (JSON)</span></td> + <td><span class="response-description">classification 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/classificationdef/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"> +{ + "superTypes" : [ "...", "..." ], + "attributeDefs" : [ { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + }, { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + }, { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + } ] + } ], + "category" : "PRIMITIVE", + "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_getClassificationDefByName
<TRUNCATED>
