| <!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: EntityREST</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: EntityREST</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_EntityREST_createOrUpdate_POST"><abbr title="POST /v2/entity" class="side-abbr"><span class="sideoverflow">POST /v2/entity</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_deleteByGuids_DELETE"><abbr title="DELETE /v2/entity/bulk" class="side-abbr"><span class="sideoverflow">DELETE /v2/entity/bulk</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_getByGuids_GET"><abbr title="GET /v2/entity/bulk" class="side-abbr"><span class="sideoverflow">GET /v2/entity/bulk</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_createOrUpdate_POST"><abbr title="POST /v2/entity/bulk" class="side-abbr"><span class="sideoverflow">POST /v2/entity/bulk</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_addClassification_POST"><abbr title="POST /v2/entity/bulk/classification" class="side-abbr"><span class="sideoverflow">POST /v2/entity/bulk/classification</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_getEntityHeaders_GET"><abbr title="GET /v2/entity/bulk/headers" class="side-abbr"><span class="sideoverflow">GET /v2/entity/bulk/headers</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_setClassifications_POST"><abbr title="POST /v2/entity/bulk/setClassifications" class="side-abbr"><span class="sideoverflow">POST /v2/entity/bulk/setClassifications</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_importBMAttributes_POST"><abbr title="POST /v2/entity/businessmetadata/import" class="side-abbr"><span class="sideoverflow">POST /v2/entity/businessmetadata/import</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_deleteByGuid_DELETE"><abbr title="DELETE /v2/entity/guid/{guid}" class="side-abbr"><span class="sideoverflow">DELETE /v2/entity/guid/{guid}</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_getById_GET"><abbr title="GET /v2/entity/guid/{guid}" class="side-abbr"><span class="sideoverflow">GET /v2/entity/guid/{guid}</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_partialUpdateEntityAttrByGuid_PUT"><abbr title="PUT /v2/entity/guid/{guid}" class="side-abbr"><span class="sideoverflow">PUT /v2/entity/guid/{guid}</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_getAuditEvents_GET"><abbr title="GET /v2/entity/{guid}/audit" class="side-abbr"><span class="sideoverflow">GET /v2/entity/{guid}/audit</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_produceTemplate_GET"><abbr title="GET /v2/entity/businessmetadata/import/template" class="side-abbr"><span class="sideoverflow">GET /v2/entity/businessmetadata/import/template</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_removeBusinessAttributes_DELETE"><abbr title="DELETE /v2/entity/guid/{guid}/businessmetadata" class="side-abbr"><span class="sideoverflow">DELETE /v2/entity/guid/{guid}/businessmetadata</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_addOrUpdateBusinessAttributes_POST"><abbr title="POST /v2/entity/guid/{guid}/businessmetadata" class="side-abbr"><span class="sideoverflow">POST /v2/entity/guid/{guid}/businessmetadata</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_getClassifications_GET"><abbr title="GET /v2/entity/guid/{guid}/classifications" class="side-abbr"><span class="sideoverflow">GET /v2/entity/guid/{guid}/classifications</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_addClassifications_POST"><abbr title="POST /v2/entity/guid/{guid}/classifications" class="side-abbr"><span class="sideoverflow">POST /v2/entity/guid/{guid}/classifications</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_updateClassifications_PUT"><abbr title="PUT /v2/entity/guid/{guid}/classifications" class="side-abbr"><span class="sideoverflow">PUT /v2/entity/guid/{guid}/classifications</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_getHeaderById_GET"><abbr title="GET /v2/entity/guid/{guid}/header" class="side-abbr"><span class="sideoverflow">GET /v2/entity/guid/{guid}/header</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_removeLabels_DELETE"><abbr title="DELETE /v2/entity/guid/{guid}/labels" class="side-abbr"><span class="sideoverflow">DELETE /v2/entity/guid/{guid}/labels</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_setLabels_POST"><abbr title="POST /v2/entity/guid/{guid}/labels" class="side-abbr"><span class="sideoverflow">POST /v2/entity/guid/{guid}/labels</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_addLabels_PUT"><abbr title="PUT /v2/entity/guid/{guid}/labels" class="side-abbr"><span class="sideoverflow">PUT /v2/entity/guid/{guid}/labels</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_deleteByUniqueAttribute_DELETE"><abbr title="DELETE /v2/entity/uniqueAttribute/type/{typeName}" class="side-abbr"><span class="sideoverflow">DELETE /v2/entity/uniqueAttribute/type/{typeName}</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_getByUniqueAttributes_GET"><abbr title="GET /v2/entity/uniqueAttribute/type/{typeName}" class="side-abbr"><span class="sideoverflow">GET /v2/entity/uniqueAttribute/type/{typeName}</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_partialUpdateEntityByUniqueAttrs_PUT"><abbr title="PUT /v2/entity/uniqueAttribute/type/{typeName}" class="side-abbr"><span class="sideoverflow">PUT /v2/entity/uniqueAttribute/type/{typeName}</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_getEntitiesByUniqueAttributes_GET"><abbr title="GET /v2/entity/bulk/uniqueAttribute/type/{typeName}" class="side-abbr"><span class="sideoverflow">GET /v2/entity/bulk/uniqueAttribute/type/{typeName}</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_removeBusinessAttributes_DELETE"><abbr title="DELETE /v2/entity/guid/{guid}/businessmetadata/{bmName}" class="side-abbr"><span class="sideoverflow">DELETE /v2/entity/guid/{guid}/businessmetadata/{bmName}</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_addOrUpdateBusinessAttributes_POST"><abbr title="POST /v2/entity/guid/{guid}/businessmetadata/{bmName}" class="side-abbr"><span class="sideoverflow">POST /v2/entity/guid/{guid}/businessmetadata/{bmName}</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_deleteClassification_DELETE"><abbr title="DELETE /v2/entity/guid/{guid}/classification/{classificationName}" class="side-abbr"><span class="sideoverflow">DELETE /v2/entity/guid/{guid}/classification/{classificationName}</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_getClassification_GET"><abbr title="GET /v2/entity/guid/{guid}/classification/{classificationName}" class="side-abbr"><span class="sideoverflow">GET /v2/entity/guid/{guid}/classification/{classificationName}</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_addClassificationsByUniqueAttribute_POST"><abbr title="POST /v2/entity/uniqueAttribute/type/{typeName}/classifications" class="side-abbr"><span class="sideoverflow">POST /v2/entity/uniqueAttribute/type/{typeName}/classifications</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_updateClassificationsByUniqueAttribute_PUT"><abbr title="PUT /v2/entity/uniqueAttribute/type/{typeName}/classifications" class="side-abbr"><span class="sideoverflow">PUT /v2/entity/uniqueAttribute/type/{typeName}/classifications</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_getEntityHeaderByUniqueAttributes_GET"><abbr title="GET /v2/entity/uniqueAttribute/type/{typeName}/header" class="side-abbr"><span class="sideoverflow">GET /v2/entity/uniqueAttribute/type/{typeName}/header</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_removeLabels_DELETE"><abbr title="DELETE /v2/entity/uniqueAttribute/type/{typeName}/labels" class="side-abbr"><span class="sideoverflow">DELETE /v2/entity/uniqueAttribute/type/{typeName}/labels</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_setLabels_POST"><abbr title="POST /v2/entity/uniqueAttribute/type/{typeName}/labels" class="side-abbr"><span class="sideoverflow">POST /v2/entity/uniqueAttribute/type/{typeName}/labels</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_addLabels_PUT"><abbr title="PUT /v2/entity/uniqueAttribute/type/{typeName}/labels" class="side-abbr"><span class="sideoverflow">PUT /v2/entity/uniqueAttribute/type/{typeName}/labels</span></abbr></a></li> |
| <li><a href="#resource_EntityREST_deleteClassificationByUniqueAttribute_DELETE"><abbr title="DELETE /v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}" class="side-abbr"><span class="sideoverflow">DELETE /v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}</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_EntityREST.html">EntityREST</a></li> |
| </ol> |
| |
| <h1 class="page-header">EntityREST <small>Resource</small></h1> |
| |
| <p>REST for a single entity</p> |
| |
| <div id="resource_EntityREST_createOrUpdate_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/entity <a href="../v2/entity" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Create new entity or update existing entity in Atlas. |
| Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName</p> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</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_AtlasEntityWithExtInfo.html">AtlasEntityWithExtInfo</a> |
| (JSON)</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_AtlasEntityWithExtInfo.html">AtlasEntityWithExtInfo</a> |
| (JSON)</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_EntityMutationResponse.html">EntityMutationResponse</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">EntityMutationResponse</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_EntityMutationResponse.html">EntityMutationResponse</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/entity |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "entity" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "DELETED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "referredEntities" : { |
| "property1" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "DELETED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "PURGED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| } |
| } |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 201 Created |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "guidAssignments" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "mutatedEntities" : { |
| "property1" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "property2" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| }, |
| "partialUpdatedEntities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_deleteByGuids_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/entity/bulk <a href="../v2/entity/bulk" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Bulk API to delete list of entities identified by its GUIDs</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>multivalued</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">guid</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-multivalued">yes</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_EntityMutationResponse.html">EntityMutationResponse</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></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_EntityMutationResponse.html">EntityMutationResponse</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> |
| DELETE /v2/entity/bulk |
| 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 204 No Content |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "guidAssignments" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "mutatedEntities" : { |
| "property1" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "property2" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| }, |
| "partialUpdatedEntities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_getByGuids_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/entity/bulk <a href="../v2/entity/bulk" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Bulk API to retrieve list of entities identified by its GUIDs.</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| <th>constraints</th> |
| <th>multivalued</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">guid</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| <td><span class="parameter-multivalued">yes</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">ignoreRelationships</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">false</span></td> |
| <td><span class="parameter-constraints">boolean</span></td> |
| <td><span class="parameter-multivalued">no</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">minExtInfo</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">false</span></td> |
| <td><span class="parameter-constraints">boolean</span></td> |
| <td><span class="parameter-multivalued">no</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_AtlasEntitiesWithExtInfo.html">AtlasEntitiesWithExtInfo</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></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_AtlasEntitiesWithExtInfo.html">AtlasEntitiesWithExtInfo</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/entity/bulk |
| 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"> |
| { |
| "entities" : [ { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "DELETED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "ACTIVE", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "referredEntities" : { |
| "property1" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "ACTIVE", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "ACTIVE", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| } |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_createOrUpdate_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/entity/bulk <a href="../v2/entity/bulk" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Bulk API to create new entities or updates existing entities in Atlas. |
| Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName</p> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</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_AtlasEntitiesWithExtInfo.html">AtlasEntitiesWithExtInfo</a> |
| (JSON)</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_AtlasEntitiesWithExtInfo.html">AtlasEntitiesWithExtInfo</a> |
| (JSON)</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_EntityMutationResponse.html">EntityMutationResponse</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></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_EntityMutationResponse.html">EntityMutationResponse</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/entity/bulk |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "entities" : [ { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "DELETED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "ACTIVE", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "referredEntities" : { |
| "property1" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "DELETED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "ACTIVE", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| } |
| } |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 201 Created |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "guidAssignments" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "mutatedEntities" : { |
| "property1" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "property2" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| }, |
| "partialUpdatedEntities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_addClassification_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/entity/bulk/classification <a href="../v2/entity/bulk/classification" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Bulk API to associate a tag to multiple entities. |
| Option 1: List of GUIDs to associate a tag |
| Option 2: Typename and list of uniq attributes for entities to associate a tag |
| Option 3: List of GUIDs and Typename with list of uniq attributes for entities to associate a tag</p> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</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_ClassificationAssociateRequest.html">ClassificationAssociateRequest</a> |
| (JSON)</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_ClassificationAssociateRequest.html">ClassificationAssociateRequest</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/entity/bulk/classification |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "classification" : { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "entitiesUniqueAttributes" : [ { |
| "property1" : { }, |
| "property2" : { } |
| }, { |
| "property1" : { }, |
| "property2" : { } |
| } ], |
| "entityGuids" : [ "...", "..." ], |
| "entityTypeName" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 201 Created |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_getEntityHeaders_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/entity/bulk/headers <a href="../v2/entity/bulk/headers" 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> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">tagUpdateStartTime</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints">required</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_AtlasEntityHeaders.html">AtlasEntityHeaders</a> |
| (JSON)</span></td> |
| <td><span class="response-description"></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/entity/bulk/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"> |
| { |
| "guidHeaderMap" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| } |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_setClassifications_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/entity/bulk/setClassifications <a href="../v2/entity/bulk/setClassifications" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</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_AtlasEntityHeaders.html">AtlasEntityHeaders</a> |
| (JSON)</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">string |
| (JSON)</span></td> |
| <td><span class="response-description"></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/entity/bulk/setClassifications |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "guidHeaderMap" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| } |
| } |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 201 Created |
| Content-Type: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_importBMAttributes_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/entity/businessmetadata/import <a href="../v2/entity/businessmetadata/import" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Upload the file for creating Business Metadata in BULK</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">fileDetail</span></td> |
| <td>formdata</td> |
| <td><span class="parameter-description">FormDataContentDisposition metadata of file</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">uploadedInputStream</span></td> |
| <td>formdata</td> |
| <td><span class="parameter-description">InputStream of file</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: multipart/form-data" HTTP header to specify this media type to the server."><span class="request-type">multipart/form-data</span></abbr></td> |
| <td><span class="datatype-reference">(custom) |
| </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">If Business Metadata creation was successful</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">400</span></td> |
| <td><span class="response-condition">If Business Metadata definition has invalid or missing information</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">409</span></td> |
| <td><span class="response-condition">If Business Metadata already exists (duplicate qualifiedName)</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_BulkImportResponse.html">BulkImportResponse</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></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_BulkImportResponse.html">BulkImportResponse</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/entity/businessmetadata/import |
| Content-Type: multipart/form-data |
| 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"> |
| { |
| "failedImportInfoList" : [ { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| }, { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| } ], |
| "successImportInfoList" : [ { |
| "childObjectName" : "...", |
| "importStatus" : "FAILED", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| }, { |
| "childObjectName" : "...", |
| "importStatus" : "FAILED", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| } ] |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_deleteByGuid_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/entity/guid/{guid} <a href="../v2/entity/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Delete an entity identified by its 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">GUID for the entity</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_EntityMutationResponse.html">EntityMutationResponse</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">EntityMutationResponse</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_EntityMutationResponse.html">EntityMutationResponse</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> |
| DELETE /v2/entity/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 204 No Content |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "guidAssignments" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "mutatedEntities" : { |
| "property1" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "property2" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| }, |
| "partialUpdatedEntities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_getById_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/entity/guid/{guid} <a href="../v2/entity/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Fetch complete definition of an entity given its GUID.</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">guid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">GUID for the entity</span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">ignoreRelationships</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">false</span></td> |
| <td><span class="parameter-constraints">boolean</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">minExtInfo</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">false</span></td> |
| <td><span class="parameter-constraints">boolean</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_AtlasEntityWithExtInfo.html">AtlasEntityWithExtInfo</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">AtlasEntity</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_AtlasEntityWithExtInfo.html">AtlasEntityWithExtInfo</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/entity/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"> |
| { |
| "entity" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "ACTIVE", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "referredEntities" : { |
| "property1" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "PURGED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "DELETED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| } |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_partialUpdateEntityAttrByGuid_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/entity/guid/{guid} <a href="../v2/entity/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Entity Partial Update - Add/Update entity attribute identified by its GUID. |
| Supports only uprimitive attribute type and entity references. |
| does not support updation of complex types like arrays, maps |
| Null updates are not possible</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"></span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">name</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</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">object |
| (JSON)</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">object |
| (JSON)</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_EntityMutationResponse.html">EntityMutationResponse</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></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_EntityMutationResponse.html">EntityMutationResponse</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/entity/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 204 No Content |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "guidAssignments" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "mutatedEntities" : { |
| "property1" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "property2" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| }, |
| "partialUpdatedEntities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_getAuditEvents_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/entity/{guid}/audit <a href="../v2/entity/{guid}/audit" 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> |
| <th>default</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">guid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">auditAction</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| <td><span class="parameter-constraints">"BUSINESS_ATTRIBUTE_UPDATE" or "CLASSIFICATION_ADD" or "CLASSIFICATION_DELETE" or "CLASSIFICATION_UPDATE" or "CUSTOM_ATTRIBUTE_UPDATE" or "ENTITY_CREATE" or "ENTITY_DELETE" or "ENTITY_IMPORT_CREATE" or "ENTITY_IMPORT_DELETE" or "ENTITY_IMPORT_UPDATE" or "ENTITY_PURGE" or "ENTITY_UPDATE" or "LABEL_ADD" or "LABEL_DELETE" or "PROPAGATED_CLASSIFICATION_ADD" or "PROPAGATED_CLASSIFICATION_DELETE" or "PROPAGATED_CLASSIFICATION_UPDATE" or "TERM_ADD" or "TERM_DELETE"</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">count</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">100</span></td> |
| <td><span class="parameter-constraints">short</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">offset</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">-1</span></td> |
| <td><span class="parameter-constraints">int</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">sortBy</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">sortOrder</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">startKey</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| <td><span class="parameter-constraints"> </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_EntityAuditEventV2.html">EntityAuditEventV2</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></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_EntityAuditEventV2.html">EntityAuditEventV2</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/entity/{guid}/audit |
| 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"> |
| [ { |
| "action" : "ENTITY_CREATE", |
| "details" : "...", |
| "entity" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "ACTIVE", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "entityId" : "...", |
| "eventKey" : "...", |
| "timestamp" : 12345, |
| "type" : "ENTITY_AUDIT_V2", |
| "user" : "..." |
| } ] |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_produceTemplate_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/entity/businessmetadata/import/template <a href="../v2/entity/businessmetadata/import/template" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get the sample Template for uploading/creating bulk BusinessMetaData</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-warning response-code">400</span></td> |
| <td><span class="response-condition">If the provided fileType is not supported</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/octet-stream" HTTP header to request that this media type be provided by the server."><span class="response-type">application/octet-stream</span></abbr></td> |
| <td><span class="datatype-reference">object |
| </span></td> |
| <td><span class="response-description">Template File</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/entity/businessmetadata/import/template |
| Content-Type: application/json |
| Accept: application/octet-stream |
| |
| <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/octet-stream |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_removeBusinessAttributes_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/entity/guid/{guid}/businessmetadata <a href="../v2/entity/guid/{guid}/businessmetadata" 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"></span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</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">map of object |
| (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> |
| DELETE /v2/entity/guid/{guid}/businessmetadata |
| 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> |
| |
| <div id="resource_EntityREST_addOrUpdateBusinessAttributes_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/entity/guid/{guid}/businessmetadata <a href="../v2/entity/guid/{guid}/businessmetadata" 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> |
| <th>default</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">guid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">isOverwrite</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">false</span></td> |
| <td><span class="parameter-constraints">boolean</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</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">map of object |
| (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/entity/guid/{guid}/businessmetadata |
| Content-Type: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 201 Created |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_getClassifications_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/entity/guid/{guid}/classifications <a href="../v2/entity/guid/{guid}/classifications" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Gets the list of classifications for a given entity represented by a 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">globally unique identifier for the entity</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_AtlasClassifications.html">AtlasClassifications</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">a list of classifications for the given entity guid</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_AtlasClassifications.html">AtlasClassifications</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/entity/guid/{guid}/classifications |
| 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"> |
| { |
| "list" : [ { }, { } ], |
| "pageSize" : 12345, |
| "sortBy" : "...", |
| "sortType" : "DESC", |
| "startIndex" : 12345, |
| "totalCount" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_addClassifications_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/entity/guid/{guid}/classifications <a href="../v2/entity/guid/{guid}/classifications" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Adds classifications to an existing entity represented by a 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">globally unique identifier for the entity</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</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">array of <a href="json_AtlasClassification.html">AtlasClassification</a> |
| (JSON)</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">array of <a href="json_AtlasClassification.html">AtlasClassification</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/entity/guid/{guid}/classifications |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 201 Created |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_updateClassifications_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/entity/guid/{guid}/classifications <a href="../v2/entity/guid/{guid}/classifications" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Updates classifications to an existing entity represented by a 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">globally unique identifier for the entity</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</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">array of <a href="json_AtlasClassification.html">AtlasClassification</a> |
| (JSON)</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">array of <a href="json_AtlasClassification.html">AtlasClassification</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/entity/guid/{guid}/classifications |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| </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_EntityREST_getHeaderById_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/entity/guid/{guid}/header <a href="../v2/entity/guid/{guid}/header" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get entity header given its 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">GUID for the entity</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_AtlasEntityHeader.html">AtlasEntityHeader</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">AtlasEntity</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_AtlasEntityHeader.html">AtlasEntityHeader</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/entity/guid/{guid}/header |
| 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"> |
| { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_removeLabels_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/entity/guid/{guid}/labels <a href="../v2/entity/guid/{guid}/labels" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>delete given labels to a given entity</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">- Unique entity identifier</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</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">array of string |
| (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> |
| DELETE /v2/entity/guid/{guid}/labels |
| 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> |
| |
| <div id="resource_EntityREST_setLabels_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/entity/guid/{guid}/labels <a href="../v2/entity/guid/{guid}/labels" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Set labels to a given entity</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">- Unique entity identifier</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <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">array of string |
| (JSON)</span></td> |
| <td><span class="request-description">- set of labels to be set to the entity</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/entity/guid/{guid}/labels |
| Content-Type: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 201 Created |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_addLabels_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/entity/guid/{guid}/labels <a href="../v2/entity/guid/{guid}/labels" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>add given labels to a given entity</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">- Unique entity identifier</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</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">array of string |
| (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/entity/guid/{guid}/labels |
| 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> |
| |
| <div id="resource_EntityREST_deleteByUniqueAttribute_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName} <a href="../v2/entity/uniqueAttribute/type/{typeName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Delete an entity identified by its type and unique attributes. |
| |
| In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format |
| |
| attr:<attrName>=<attrValue> |
| |
| NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName |
| |
| The REST request would look something like this |
| |
| DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue</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">- entity type to be deleted</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_EntityMutationResponse.html">EntityMutationResponse</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">EntityMutationResponse</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_EntityMutationResponse.html">EntityMutationResponse</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> |
| DELETE /v2/entity/uniqueAttribute/type/{typeName} |
| 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 204 No Content |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "guidAssignments" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "mutatedEntities" : { |
| "property1" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "property2" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| }, |
| "partialUpdatedEntities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_getByUniqueAttributes_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName} <a href="../v2/entity/uniqueAttribute/type/{typeName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Fetch complete definition of an entity given its type and unique attribute. |
| |
| In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format |
| |
| attr:<attrName>=<attrValue> |
| |
| NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName |
| |
| The REST request would look something like this |
| |
| GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">typeName</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">ignoreRelationships</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">false</span></td> |
| <td><span class="parameter-constraints">boolean</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">minExtInfo</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">false</span></td> |
| <td><span class="parameter-constraints">boolean</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_AtlasEntityWithExtInfo.html">AtlasEntityWithExtInfo</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">AtlasEntityWithExtInfo</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_AtlasEntityWithExtInfo.html">AtlasEntityWithExtInfo</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/entity/uniqueAttribute/type/{typeName} |
| 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"> |
| { |
| "entity" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "ACTIVE", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "referredEntities" : { |
| "property1" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "PURGED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "DELETED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| } |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_partialUpdateEntityByUniqueAttrs_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName} <a href="../v2/entity/uniqueAttribute/type/{typeName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Entity Partial Update - Allows a subset of attributes to be updated on |
| an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. |
| Null updates are not possible |
| |
| In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format |
| |
| attr:<attrName>=<attrValue> |
| |
| NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName |
| |
| The REST request would look something like this |
| |
| PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue</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"></span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</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_AtlasEntityWithExtInfo.html">AtlasEntityWithExtInfo</a> |
| (JSON)</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_AtlasEntityWithExtInfo.html">AtlasEntityWithExtInfo</a> |
| (JSON)</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_EntityMutationResponse.html">EntityMutationResponse</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></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_EntityMutationResponse.html">EntityMutationResponse</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/entity/uniqueAttribute/type/{typeName} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "entity" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "ACTIVE", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "referredEntities" : { |
| "property1" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "PURGED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "PURGED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| } |
| } |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "guidAssignments" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "mutatedEntities" : { |
| "property1" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "property2" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| }, |
| "partialUpdatedEntities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_getEntitiesByUniqueAttributes_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/entity/bulk/uniqueAttribute/type/{typeName} <a href="../v2/entity/bulk/uniqueAttribute/type/{typeName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Bulk API to retrieve list of entities identified by its unique attributes. |
| |
| In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format |
| |
| typeName=<typeName>&attr_1:<attrName>=<attrValue>&attr_2:<attrName>=<attrValue>&attr_3:<attrName>=<attrValue> |
| |
| NOTE: The attrName should be an unique attribute for the given entity-type |
| |
| The REST request would look something like this |
| |
| GET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_0:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">typeName</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">ignoreRelationships</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">false</span></td> |
| <td><span class="parameter-constraints">boolean</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">minExtInfo</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">false</span></td> |
| <td><span class="parameter-constraints">boolean</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_AtlasEntitiesWithExtInfo.html">AtlasEntitiesWithExtInfo</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">AtlasEntitiesWithExtInfo</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_AtlasEntitiesWithExtInfo.html">AtlasEntitiesWithExtInfo</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/entity/bulk/uniqueAttribute/type/{typeName} |
| 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"> |
| { |
| "entities" : [ { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "ACTIVE", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "PURGED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "referredEntities" : { |
| "property1" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "DELETED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "DELETED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| } |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_removeBusinessAttributes_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/entity/guid/{guid}/businessmetadata/{bmName} <a href="../v2/entity/guid/{guid}/businessmetadata/{bmName}" 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">bmName</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">guid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</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">map of object |
| (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> |
| DELETE /v2/entity/guid/{guid}/businessmetadata/{bmName} |
| 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> |
| |
| <div id="resource_EntityREST_addOrUpdateBusinessAttributes_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/entity/guid/{guid}/businessmetadata/{bmName} <a href="../v2/entity/guid/{guid}/businessmetadata/{bmName}" 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">bmName</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">guid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</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">map of object |
| (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/entity/guid/{guid}/businessmetadata/{bmName} |
| Content-Type: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 201 Created |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_deleteClassification_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/entity/guid/{guid}/classification/{classificationName} <a href="../v2/entity/guid/{guid}/classification/{classificationName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Deletes a given classification from an existing entity represented by a 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">classificationName</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">name of the classifcation</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">guid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">globally unique identifier for the entity</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">associatedEntityGuid</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></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/entity/guid/{guid}/classification/{classificationName} |
| 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> |
| |
| <div id="resource_EntityREST_getClassification_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/entity/guid/{guid}/classification/{classificationName} <a href="../v2/entity/guid/{guid}/classification/{classificationName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Gets the list of classifications for a given entity represented by a 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">classificationName</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">guid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">globally unique identifier for the entity</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_AtlasClassification.html">AtlasClassification</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">classification for the given entity guid</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_AtlasClassification.html">AtlasClassification</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/entity/guid/{guid}/classification/{classificationName} |
| 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"> |
| { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_addClassificationsByUniqueAttribute_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}/classifications <a href="../v2/entity/uniqueAttribute/type/{typeName}/classifications" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Adds classification to the entity identified by its type and unique attributes.</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"></span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</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">array of <a href="json_AtlasClassification.html">AtlasClassification</a> |
| (JSON)</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">array of <a href="json_AtlasClassification.html">AtlasClassification</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/entity/uniqueAttribute/type/{typeName}/classifications |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 201 Created |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_updateClassificationsByUniqueAttribute_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}/classifications <a href="../v2/entity/uniqueAttribute/type/{typeName}/classifications" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Updates classification on an entity identified by its type and unique attributes.</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"></span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</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">array of <a href="json_AtlasClassification.html">AtlasClassification</a> |
| (JSON)</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">array of <a href="json_AtlasClassification.html">AtlasClassification</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/entity/uniqueAttribute/type/{typeName}/classifications |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| </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_EntityREST_getEntityHeaderByUniqueAttributes_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}/header <a href="../v2/entity/uniqueAttribute/type/{typeName}/header" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Fetch AtlasEntityHeader given its type and unique attribute. |
| |
| In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format |
| |
| attr:<attrName>=<attrValue> |
| |
| NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName |
| |
| The REST request would look something like this |
| |
| GET /v2/entity/uniqueAttribute/type/aType/header?attr:aTypeAttribute=someValue</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"></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_AtlasEntityHeader.html">AtlasEntityHeader</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">AtlasEntityHeader</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_AtlasEntityHeader.html">AtlasEntityHeader</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/entity/uniqueAttribute/type/{typeName}/header |
| 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"> |
| { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_removeLabels_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}/labels <a href="../v2/entity/uniqueAttribute/type/{typeName}/labels" 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">typeName</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</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">array of string |
| (JSON)</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">array of string |
| (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> |
| DELETE /v2/entity/uniqueAttribute/type/{typeName}/labels |
| 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> |
| |
| <div id="resource_EntityREST_setLabels_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}/labels <a href="../v2/entity/uniqueAttribute/type/{typeName}/labels" 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">typeName</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</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">array of string |
| (JSON)</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">array of string |
| (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/entity/uniqueAttribute/type/{typeName}/labels |
| Content-Type: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 201 Created |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_EntityREST_addLabels_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}/labels <a href="../v2/entity/uniqueAttribute/type/{typeName}/labels" 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">typeName</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</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">array of string |
| (JSON)</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">array of string |
| (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/entity/uniqueAttribute/type/{typeName}/labels |
| 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> |
| |
| <div id="resource_EntityREST_deleteClassificationByUniqueAttribute_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName} <a href="../v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Deletes a given classification from an entity identified by its type and unique attributes.</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">classificationName</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">name of the classification</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">typeName</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></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/entity/uniqueAttribute/type/{typeName}/classification/{classificationName} |
| 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> |
