| <!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://stackpath.bootstrapcdn.com/bootstrap/3.4.1/css/bootstrap.min.css"> |
| |
| <!--custom css for these pages--> |
| <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]> |
| <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"><abbr title="DELETE /v2/types/typedefs" class="side-abbr"><span class="sideoverflow">DELETE /v2/types/typedefs</span></abbr></a></li> |
| <li><a href="#resource_TypesREST_getAllTypeDefs_GET"><abbr title="GET /v2/types/typedefs" class="side-abbr"><span class="sideoverflow">GET /v2/types/typedefs</span></abbr></a></li> |
| <li><a href="#resource_TypesREST_createAtlasTypeDefs_POST"><abbr title="POST /v2/types/typedefs" class="side-abbr"><span class="sideoverflow">POST /v2/types/typedefs</span></abbr></a></li> |
| <li><a href="#resource_TypesREST_updateAtlasTypeDefs_PUT"><abbr title="PUT /v2/types/typedefs" class="side-abbr"><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" class="side-abbr"><span class="sideoverflow">GET /v2/types/typedefs/headers</span></abbr></a></li> |
| <li><a href="#resource_TypesREST_getBusinessMetadataDefByGuid_GET"><abbr title="GET /v2/types/businessmetadatadef/guid/{guid}" class="side-abbr"><span class="sideoverflow">GET /v2/types/businessmetadatadef/guid/{guid}</span></abbr></a></li> |
| <li><a href="#resource_TypesREST_getBusinessMetadataDefByName_GET"><abbr title="GET /v2/types/businessmetadatadef/name/{name}" class="side-abbr"><span class="sideoverflow">GET /v2/types/businessmetadatadef/name/{name}</span></abbr></a></li> |
| <li><a href="#resource_TypesREST_getClassificationDefByGuid_GET"><abbr title="GET /v2/types/classificationdef/guid/{guid}" class="side-abbr"><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}" class="side-abbr"><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}" class="side-abbr"><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}" class="side-abbr"><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}" class="side-abbr"><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}" class="side-abbr"><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}" class="side-abbr"><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}" class="side-abbr"><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}" class="side-abbr"><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}" class="side-abbr"><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}" class="side-abbr"><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}" class="side-abbr"><span class="sideoverflow">GET /v2/types/typedef/name/{name}</span></abbr></a></li> |
| <li><a href="#resource_TypesREST_deleteAtlasTypeByName_DELETE"><abbr title="DELETE /v2/types/typedef/name/{typeName}" class="side-abbr"><span class="sideoverflow">DELETE /v2/types/typedef/name/{typeName}</span></abbr></a></li> |
| <li class="divider"></li> |
| <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> |
| </ul> |
| </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 rowspan="2" class="multi-row-description"><span class="request-description">A composite object that captures all types to be deleted</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" 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> |
| </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"> |
| { |
| "businessMetadataDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "PRIMITIVE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "classificationDefs" : [ { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "STRUCT", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "STRUCT", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "entityDefs" : [ { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENUM", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "enumDefs" : [ { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "STRUCT", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "relationshipDefs" : [ { |
| "endDef1" : { |
| "cardinality" : "SET", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "TWO_TO_ONE", |
| "relationshipCategory" : "ASSOCIATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "endDef1" : { |
| "cardinality" : "SET", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "SINGLE", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "TWO_TO_ONE", |
| "relationshipCategory" : "ASSOCIATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "structDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "MAP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ] |
| } |
| </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 rowspan="2" class="multi-row-description"><span class="response-description">A composite wrapper object with lists of all type definitions</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" 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> |
| </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 |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </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"> |
| { |
| "businessMetadataDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "classificationDefs" : [ { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "BUSINESS_METADATA", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "entityDefs" : [ { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "BUSINESS_METADATA", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENUM", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "enumDefs" : [ { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "OBJECT_ID_TYPE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "relationshipDefs" : [ { |
| "endDef1" : { |
| "cardinality" : "SINGLE", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "SET", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "TWO_TO_ONE", |
| "relationshipCategory" : "AGGREGATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "RELATIONSHIP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "endDef1" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "NONE", |
| "relationshipCategory" : "AGGREGATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "structDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "MAP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ] |
| } |
| </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 rowspan="2" class="multi-row-description"><span class="request-description">A composite wrapper object with corresponding lists of the type definition</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" 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> |
| </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 rowspan="2" class="multi-row-description"><span class="response-description">A composite wrapper object with lists of type definitions that were successfully |
| created</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" 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> |
| </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"> |
| { |
| "businessMetadataDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "BUSINESS_METADATA", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENUM", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "classificationDefs" : [ { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "MAP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "PRIMITIVE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "entityDefs" : [ { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "enumDefs" : [ { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "PRIMITIVE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "relationshipDefs" : [ { |
| "endDef1" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "NONE", |
| "relationshipCategory" : "AGGREGATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "MAP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "endDef1" : { |
| "cardinality" : "SINGLE", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "ONE_TO_TWO", |
| "relationshipCategory" : "ASSOCIATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "PRIMITIVE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "structDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "STRUCT", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ] |
| } |
| </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"> |
| { |
| "businessMetadataDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "BUSINESS_METADATA", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "classificationDefs" : [ { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "MAP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "entityDefs" : [ { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENUM", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "enumDefs" : [ { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "OBJECT_ID_TYPE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "PRIMITIVE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "relationshipDefs" : [ { |
| "endDef1" : { |
| "cardinality" : "SINGLE", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "SINGLE", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "NONE", |
| "relationshipCategory" : "COMPOSITION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENUM", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "endDef1" : { |
| "cardinality" : "SINGLE", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "SINGLE", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "ONE_TO_TWO", |
| "relationshipCategory" : "COMPOSITION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "structDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ] |
| } |
| </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 rowspan="2" class="multi-row-description"><span class="request-description">A composite object that captures all type definition changes</span></td> |
| </tr> |
| <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> |
| </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 rowspan="2" class="multi-row-description"><span class="response-description">A composite object with lists of type definitions that were updated</span></td> |
| </tr> |
| <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> |
| </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"> |
| { |
| "businessMetadataDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "MAP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "classificationDefs" : [ { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "entityDefs" : [ { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "STRUCT", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "OBJECT_ID_TYPE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "enumDefs" : [ { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "RELATIONSHIP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "PRIMITIVE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "relationshipDefs" : [ { |
| "endDef1" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "TWO_TO_ONE", |
| "relationshipCategory" : "COMPOSITION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "RELATIONSHIP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "endDef1" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "NONE", |
| "relationshipCategory" : "AGGREGATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "structDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "BUSINESS_METADATA", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ] |
| } |
| </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"> |
| { |
| "businessMetadataDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "BUSINESS_METADATA", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "classificationDefs" : [ { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "OBJECT_ID_TYPE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "PRIMITIVE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "entityDefs" : [ { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "STRUCT", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "enumDefs" : [ { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "BUSINESS_METADATA", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "relationshipDefs" : [ { |
| "endDef1" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "SINGLE", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "ONE_TO_TWO", |
| "relationshipCategory" : "ASSOCIATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "RELATIONSHIP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "endDef1" : { |
| "cardinality" : "SET", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "ONE_TO_TWO", |
| "relationshipCategory" : "AGGREGATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "OBJECT_ID_TYPE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "structDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "RELATIONSHIP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "RELATIONSHIP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ] |
| } |
| </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 rowspan="2" class="multi-row-description"><span class="response-description">List of AtlasTypeDefHeader AtlasTypeDefHeader</span></td> |
| </tr> |
| <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> |
| </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 |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </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"> |
| [ { |
| "category" : "ARRAY", |
| "guid" : "...", |
| "name" : "...", |
| "serviceType" : "..." |
| } ] |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TypesREST_getBusinessMetadataDefByGuid_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/businessmetadatadef/guid/{guid} <a href="../v2/types/businessmetadatadef/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get the businessMetadata 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">businessMetadata 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 businessMetadata 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_AtlasBusinessMetadataDef.html">AtlasBusinessMetadataDef</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">businessMetadata definition</span></td> |
| </tr> |
| <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_AtlasBusinessMetadataDef.html">AtlasBusinessMetadataDef</a> |
| (JSON)</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/businessmetadatadef/guid/{guid} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </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"> |
| { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "HALF_EVEN" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TypesREST_getBusinessMetadataDefByName_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/businessmetadatadef/name/{name} <a href="../v2/types/businessmetadatadef/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get the businessMetadata definition by it's name (unique)</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">name</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">businessMetadata name</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">On successful lookup of the the businessMetadata definition by it's name</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">On Failed lookup for the given name</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_AtlasBusinessMetadataDef.html">AtlasBusinessMetadataDef</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">businessMetadata definition</span></td> |
| </tr> |
| <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_AtlasBusinessMetadataDef.html">AtlasBusinessMetadataDef</a> |
| (JSON)</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/businessmetadatadef/name/{name} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </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"> |
| { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "DOWN" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| </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 rowspan="2" class="multi-row-description"><span class="response-description">classification definition</span></td> |
| </tr> |
| <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> |
| </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} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </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"> |
| { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "STRUCT", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "HALF_EVEN" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TypesREST_getClassificationDefByName_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/classificationdef/name/{name} <a href="../v2/types/classificationdef/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get the classification definition by it's name (unique)</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">name</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">classification name</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">On successful lookup of the the classification definition by it's name</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">On Failed lookup for the given name</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_AtlasClassificationDef.html">AtlasClassificationDef</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">classification definition</span></td> |
| </tr> |
| <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> |
| </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/name/{name} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </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"> |
| { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "UNNECESSARY" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TypesREST_getEntityDefByGuid_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/entitydef/guid/{guid} <a href="../v2/types/entitydef/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get the Entity 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">entity 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 entity 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_AtlasEntityDef.html">AtlasEntityDef</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">Entity definition</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_AtlasEntityDef.html">AtlasEntityDef</a> |
| (JSON)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /v2/types/entitydef/guid/{guid} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </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"> |
| { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "MAP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "HALF_UP" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TypesREST_getEntityDefByName_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/entitydef/name/{name} <a href="../v2/types/entitydef/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get the entity definition by it's name (unique)</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">name</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">entity name</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">On successful lookup of the the entity definition by it's name</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">On Failed lookup for the given name</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_AtlasEntityDef.html">AtlasEntityDef</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">Entity definition</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_AtlasEntityDef.html">AtlasEntityDef</a> |
| (JSON)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /v2/types/entitydef/name/{name} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </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"> |
| { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "STRUCT", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "DOWN" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TypesREST_getEnumDefByGuid_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/enumdef/guid/{guid} <a href="../v2/types/enumdef/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get the enum definition for the given guid</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">guid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">enum guid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">On successful lookup of the the enum definition by it's guid</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">On Failed lookup for the given guid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_AtlasEnumDef.html">AtlasEnumDef</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">enum definition</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_AtlasEnumDef.html">AtlasEnumDef</a> |
| (JSON)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /v2/types/enumdef/guid/{guid} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </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"> |
| { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "UNNECESSARY" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TypesREST_getEnumDefByName_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/enumdef/name/{name} <a href="../v2/types/enumdef/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get the enum definition by it's name (unique)</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">name</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">enum name</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">On successful lookup of the the enum definition by it's name</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">On Failed lookup for the given name</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_AtlasEnumDef.html">AtlasEnumDef</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">enum definition</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_AtlasEnumDef.html">AtlasEnumDef</a> |
| (JSON)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /v2/types/enumdef/name/{name} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </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"> |
| { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "STRUCT", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "UNNECESSARY" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TypesREST_getRelationshipDefByGuid_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/relationshipdef/guid/{guid} <a href="../v2/types/relationshipdef/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get the relationship 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">relationship 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 relationship 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_AtlasRelationshipDef.html">AtlasRelationshipDef</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">relationship definition</span></td> |
| </tr> |
| <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_AtlasRelationshipDef.html">AtlasRelationshipDef</a> |
| (JSON)</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/relationshipdef/guid/{guid} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </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"> |
| { |
| "endDef1" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "SINGLE", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "BOTH", |
| "relationshipCategory" : "AGGREGATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENUM", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "UNNECESSARY" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TypesREST_getRelationshipDefByName_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/relationshipdef/name/{name} <a href="../v2/types/relationshipdef/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get the relationship definition by it's name (unique)</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">name</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">relationship name</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">On successful lookup of the the relationship definition by it's name</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">On Failed lookup for the given name</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_AtlasRelationshipDef.html">AtlasRelationshipDef</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">relationship definition</span></td> |
| </tr> |
| <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_AtlasRelationshipDef.html">AtlasRelationshipDef</a> |
| (JSON)</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/relationshipdef/name/{name} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </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"> |
| { |
| "endDef1" : { |
| "cardinality" : "SET", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "BOTH", |
| "relationshipCategory" : "AGGREGATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "PRIMITIVE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "HALF_EVEN" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TypesREST_getStructDefByGuid_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/structdef/guid/{guid} <a href="../v2/types/structdef/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get the struct 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">struct 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 struct 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_AtlasStructDef.html">AtlasStructDef</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">struct definition</span></td> |
| </tr> |
| <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_AtlasStructDef.html">AtlasStructDef</a> |
| (JSON)</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/structdef/guid/{guid} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </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"> |
| { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "HALF_DOWN" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TypesREST_getStructDefByName_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/structdef/name/{name} <a href="../v2/types/structdef/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get the struct definition by it's name (unique)</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">name</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">struct name</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">On successful lookup of the the struct definition by it's name</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">On Failed lookup for the given name</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_AtlasStructDef.html">AtlasStructDef</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">struct definition</span></td> |
| </tr> |
| <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_AtlasStructDef.html">AtlasStructDef</a> |
| (JSON)</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/structdef/name/{name} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </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"> |
| { |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "PRIMITIVE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "HALF_EVEN" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TypesREST_getTypeDefByGuid_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/typedef/guid/{guid} <a href="../v2/types/typedef/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></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">GUID of the type</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">Successful lookup</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">Failed lookup</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_AtlasBaseTypeDef.html">AtlasBaseTypeDef</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">Type definition</span></td> |
| </tr> |
| <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_AtlasBaseTypeDef.html">AtlasBaseTypeDef</a> |
| (JSON)</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/typedef/guid/{guid} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </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"> |
| { |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "DOWN" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TypesREST_getTypeDefByName_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/typedef/name/{name} <a href="../v2/types/typedef/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get type definition by it's name</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">name</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">Type name</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">Successful lookup by name</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">Failed lookup by name</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_AtlasBaseTypeDef.html">AtlasBaseTypeDef</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">Type definition</span></td> |
| </tr> |
| <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_AtlasBaseTypeDef.html">AtlasBaseTypeDef</a> |
| (JSON)</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/typedef/name/{name} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </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"> |
| { |
| "category" : "STRUCT", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "UNNECESSARY" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TypesREST_deleteAtlasTypeByName_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/types/typedef/name/{typeName} <a href="../v2/types/typedef/name/{typeName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Delete API for type identified by its name.</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">typeName</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">Name of the type 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/typedef/name/{typeName} |
| Content-Type: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer class="footer"> |
| <div class="container"> |
| <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p> |
| </div> |
| </footer> |
| |
| </div> |
| </div> |
| </div> |
| |
| |
| <!-- JavaScript placed at the end of the document so the pages load faster. --> |
| <script src="https://code.jquery.com/jquery-1.12.2.min.js"></script> |
| |
| <!-- Bootstrap core JavaScript |
| ================================================== --> |
| <script src="https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/js/bootstrap.min.js"></script> |
| |
| <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> |
| <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js" type="text/javascript"></script> |
| <script> |
| $(function() { |
| $(".clickable-row").click(function() { |
| window.document.location = $(this).data("href"); |
| }); |
| |
| $('[data-toggle="tooltip"]').tooltip() |
| }); |
| </script> |
| |
| </body> |
| </html> |
