http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/resource_DiscoveryREST.html ---------------------------------------------------------------------- diff --git a/api/v2/resource_DiscoveryREST.html b/api/v2/resource_DiscoveryREST.html index 63e4875..345313a 100644 --- a/api/v2/resource_DiscoveryREST.html +++ b/api/v2/resource_DiscoveryREST.html @@ -50,7 +50,9 @@ <div class="row"> <div class="col-sm-3 col-md-2 sidebar" id="apinav"> <ul class="nav nav-sidebar"> + <li><a href="#resource_DiscoveryREST_searchUsingAttribute_GET">GET /v2/search/attribute</a></li> <li><a href="#resource_DiscoveryREST_searchUsingBasic_GET">GET /v2/search/basic</a></li> + <li><a href="#resource_DiscoveryREST_searchWithParameters_POST">POST /v2/search/basic</a></li> <li><a href="#resource_DiscoveryREST_searchUsingDSL_GET">GET /v2/search/dsl</a></li> <li><a href="#resource_DiscoveryREST_searchUsingFullText_GET">GET /v2/search/fulltext</a></li> <li class="divider"></li> @@ -69,6 +71,225 @@ <p>REST interface for data discovery using dsl or full text search</p> + <div id="resource_DiscoveryREST_searchUsingAttribute_GET"> + <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/attribute <a href="../v2/search/attribute" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Retrieve data for the specified attribute search query</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">attrName</span></td> + <td>query</td> + <td><span class="parameter-description">Attribute name</span></td> + <td><span class="parameter-constraints"> </span></td> + </tr> + <tr> + <td><span class="parameter-name">attrValuePrefix</span></td> + <td>query</td> + <td><span class="parameter-description">Attibute value to search on</span></td> + <td><span class="parameter-constraints"> </span></td> + </tr> + <tr> + <td><span class="parameter-name">limit</span></td> + <td>query</td> + <td><span class="parameter-description">limit the result set to only include the specified number of entries</span></td> + <td><span class="parameter-constraints">int</span></td> + </tr> + <tr> + <td><span class="parameter-name">offset</span></td> + <td>query</td> + <td><span class="parameter-description">start offset of the result set (useful for pagination)</span></td> + <td><span class="parameter-constraints">int</span></td> + </tr> + <tr> + <td><span class="parameter-name">typeName</span></td> + <td>query</td> + <td><span class="parameter-description">limit the result to only entities of specified type or its sub-types</span></td> + <td><span class="parameter-constraints"> </span></td> + </tr> + </tbody> + </table> + + <table class="table resource-response-codes"> + <caption>Response Codes</caption> + <thead> + <tr> + <th>code</th> + <th>condition</th> + </tr> + </thead> + <tbody> + <tr> + <td><span class="label label-success response-code">200</span></td> + <td><span class="response-condition">On successful FullText lookup with some results, might return an empty list if execution succeeded +without any results</span></td> + </tr> + <tr> + <td><span class="label label-warning response-code">400</span></td> + <td><span class="response-condition">Invalid wildcard or query parameters</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_AtlasSearchResult.html">AtlasSearchResult</a> + (JSON)</span></td> + <td><span class="response-description">Search results</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/search/attribute +Accept: application/json + + </pre> + </div> + <div class="col-md-6"> + <h5>Response</h5> + <pre> +HTTP/1.1 200 OK +Content-Type: application/json + + <code class="prettyprint language-js"> +{ + "queryType" : "GREMLIN", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "GT", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "LIKE", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, + "queryText" : "...", + "type" : "...", + "classification" : "...", + "entities" : [ { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "attributes" : { + "name" : [ "...", "..." ], + "values" : [ ] + }, + "fullTextResult" : [ { + "entity" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 + }, { + "entity" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 + } ], + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } +} + </code> + </pre> + </div> + </div> + </div> + </div> + <div id="resource_DiscoveryREST_searchUsingBasic_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/basic <a href="../v2/search/basic" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> @@ -92,6 +313,12 @@ <td><span class="parameter-constraints"> </span></td> </tr> <tr> + <td><span class="parameter-name">excludeDeletedEntities</span></td> + <td>query</td> + <td><span class="parameter-description"></span></td> + <td><span class="parameter-constraints">boolean</span></td> + </tr> + <tr> <td><span class="parameter-name">limit</span></td> <td>query</td> <td><span class="parameter-description">limit the result set to only include the specified number of entries</span></td> @@ -178,12 +405,35 @@ Content-Type: application/json <code class="prettyprint language-js"> { "queryType" : "BASIC", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "IN", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "STARTS_WITH", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, "queryText" : "...", "type" : "...", "classification" : "...", "entities" : [ { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -222,6 +472,31 @@ Content-Type: application/json }, { "entity" : { "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 + } ], + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], @@ -230,9 +505,227 @@ Content-Type: application/json "property1" : { }, "property2" : { } } + } + } +} + </code> + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_DiscoveryREST_searchWithParameters_POST"> + <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/search/basic <a href="../v2/search/basic" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Attribute based search for entities satisfying the search parameters</p> + + <table class="table resource-request-body"> + <caption>Request Body</caption> + <thead> + <tr> + <th>media type</th> + <th>data type</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> + <td><span class="datatype-reference"><a href="json_SearchParameters.html">SearchParameters</a> + (JSON)</span></td> + <td><span class="request-description">Search parameters</span></td> + </tr> + </tbody> + </table> + + <table class="table resource-response-codes"> + <caption>Response Codes</caption> + <thead> + <tr> + <th>code</th> + <th>condition</th> + </tr> + </thead> + <tbody> + <tr> + <td><span class="label label-success response-code">200</span></td> + <td><span class="response-condition">On successful search</span></td> + </tr> + <tr> + <td><span class="label label-warning response-code">400</span></td> + <td><span class="response-condition">Tag/Entity doesn't exist or Tag/entity filter is present without tag/type name</span></td> + </tr> + </tbody> + </table> + + <table class="table resource-response-body"> + <caption>Response Body</caption> + <thead> + <tr> + <th>media type</th> + <th>data type</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> + <td><span class="datatype-reference"><a href="json_AtlasSearchResult.html">AtlasSearchResult</a> + (JSON)</span></td> + <td><span class="response-description">Atlas search result</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/search/basic +Content-Type: application/json +Accept: application/json + + <code class="prettyprint language-js"> +{ + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "NEQ", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "GTE", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] +} + </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"> +{ + "queryType" : "DSL", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "IN", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "CONTAINS", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, + "queryText" : "...", + "type" : "...", + "classification" : "...", + "entities" : [ { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "attributes" : { + "name" : [ "...", "..." ], + "values" : [ ] + }, + "fullTextResult" : [ { + "entity" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } }, "score" : 12345.0 - } ] + }, { + "entity" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 + } ], + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } } </code> </pre> @@ -349,7 +842,30 @@ Content-Type: application/json <code class="prettyprint language-js"> { - "queryType" : "DSL", + "queryType" : "GREMLIN", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "NEQ", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "CONTAINS", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, "queryText" : "...", "type" : "...", "classification" : "...", @@ -365,7 +881,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -381,7 +897,7 @@ Content-Type: application/json "fullTextResult" : [ { "entity" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -404,7 +920,31 @@ Content-Type: application/json } }, "score" : 12345.0 - } ] + } ], + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } } </code> </pre> @@ -430,6 +970,12 @@ Content-Type: application/json </thead> <tbody> <tr> + <td><span class="parameter-name">excludeDeletedEntities</span></td> + <td>query</td> + <td><span class="parameter-description"></span></td> + <td><span class="parameter-constraints">boolean</span></td> + </tr> + <tr> <td><span class="parameter-name">limit</span></td> <td>query</td> <td><span class="parameter-description">limit the result set to only include the specified number of entries</span></td> @@ -509,7 +1055,30 @@ Content-Type: application/json <code class="prettyprint language-js"> { - "queryType" : "BASIC", + "queryType" : "ATTRIBUTE", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "LTE", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "LTE", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, "queryText" : "...", "type" : "...", "classification" : "...", @@ -525,7 +1094,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -541,7 +1110,7 @@ Content-Type: application/json "fullTextResult" : [ { "entity" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -564,7 +1133,31 @@ Content-Type: application/json } }, "score" : 12345.0 - } ] + } ], + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } } </code> </pre>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/resource_EntityREST.html ---------------------------------------------------------------------- diff --git a/api/v2/resource_EntityREST.html b/api/v2/resource_EntityREST.html index 6d72790..3c6460c 100644 --- a/api/v2/resource_EntityREST.html +++ b/api/v2/resource_EntityREST.html @@ -60,6 +60,7 @@ <li><a href="#resource_EntityREST_partialUpdateEntityAttrByGuid_PUT">PUT /v2/entity/guid/{guid}</a></li> <li><a href="#resource_EntityREST_getClassifications_GET"><abbr title="GET /v2/entity/guid/{guid}/classifications">GET /v2/entity/guid/{guid}/cla...</abbr></a></li> <li><a href="#resource_EntityREST_addClassifications_POST"><abbr title="POST /v2/entity/guid/{guid}/classifications">POST /v2/entity/guid/{guid}/cl...</abbr></a></li> + <li><a href="#resource_EntityREST_updateClassification_PUT"><abbr title="PUT /v2/entity/guid/{guid}/classifications">PUT /v2/entity/guid/{guid}/cla...</abbr></a></li> <li><a href="#resource_EntityREST_deleteByUniqueAttribute_DELETE"><abbr title="DELETE /v2/entity/uniqueAttribute/type/{typeName}">DELETE /v2/entity/uniqueAttrib...</abbr></a></li> <li><a href="#resource_EntityREST_getByUniqueAttributes_GET"><abbr title="GET /v2/entity/uniqueAttribute/type/{typeName}">GET /v2/entity/uniqueAttribute...</abbr></a></li> <li><a href="#resource_EntityREST_partialUpdateEntityByUniqueAttrs_PUT"><abbr title="PUT /v2/entity/uniqueAttribute/type/{typeName}">PUT /v2/entity/uniqueAttribute...</abbr></a></li> @@ -137,12 +138,16 @@ Accept: application/json { "entity" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -171,6 +176,10 @@ Accept: application/json "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -192,12 +201,16 @@ Accept: application/json }, "property2" : { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -254,7 +267,7 @@ Content-Type: application/json } ], "property2" : [ { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -264,7 +277,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -290,7 +303,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -311,7 +324,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -375,7 +388,7 @@ Content-Type: application/json }, "firstEntityUpdated" : { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -477,7 +490,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -488,7 +501,7 @@ Content-Type: application/json } ], "property2" : [ { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -524,7 +537,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -545,7 +558,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -556,7 +569,7 @@ Content-Type: application/json } ], "partialUpdatedEntities" : [ { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -566,7 +579,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -577,7 +590,7 @@ Content-Type: application/json } ], "deletedEntities" : [ { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -609,7 +622,7 @@ Content-Type: application/json }, "firstEntityUpdated" : { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -620,7 +633,7 @@ Content-Type: application/json }, "firstEntityPartialUpdated" : { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -700,12 +713,16 @@ Content-Type: application/json { "entities" : [ { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -726,12 +743,16 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -754,12 +775,16 @@ Content-Type: application/json "referredEntities" : { "property1" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -781,12 +806,16 @@ Content-Type: application/json }, "property2" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -869,12 +898,16 @@ Accept: application/json { "entities" : [ { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -901,6 +934,10 @@ Accept: application/json "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -923,12 +960,16 @@ Accept: application/json "referredEntities" : { "property1" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -950,12 +991,16 @@ Accept: application/json }, "property2" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -991,7 +1036,7 @@ Content-Type: application/json "mutatedEntities" : { "property1" : [ { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1001,7 +1046,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1022,7 +1067,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1038,7 +1083,7 @@ Content-Type: application/json }, "createdEntities" : [ { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1080,7 +1125,7 @@ Content-Type: application/json } ], "partialUpdatedEntities" : [ { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1090,7 +1135,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1101,7 +1146,7 @@ Content-Type: application/json } ], "deletedEntities" : [ { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1111,7 +1156,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1122,7 +1167,7 @@ Content-Type: application/json } ], "firstEntityCreated" : { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1291,7 +1336,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1312,7 +1357,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1328,7 +1373,7 @@ Content-Type: application/json }, "createdEntities" : [ { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1338,7 +1383,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1349,7 +1394,7 @@ Content-Type: application/json } ], "updatedEntities" : [ { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1359,7 +1404,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1370,7 +1415,7 @@ Content-Type: application/json } ], "partialUpdatedEntities" : [ { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1380,7 +1425,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1391,7 +1436,7 @@ Content-Type: application/json } ], "deletedEntities" : [ { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1434,7 +1479,7 @@ Content-Type: application/json }, "firstEntityPartialUpdated" : { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1520,6 +1565,10 @@ Content-Type: application/json "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -1542,12 +1591,16 @@ Content-Type: application/json "referredEntities" : { "property1" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -1569,12 +1622,16 @@ Content-Type: application/json }, "property2" : { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -1704,7 +1761,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1741,7 +1798,7 @@ Content-Type: application/json }, "createdEntities" : [ { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1751,7 +1808,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1772,7 +1829,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1783,7 +1840,7 @@ Content-Type: application/json } ], "partialUpdatedEntities" : [ { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1804,7 +1861,7 @@ Content-Type: application/json } ], "deletedEntities" : [ { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1814,7 +1871,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1836,7 +1893,7 @@ Content-Type: application/json }, "firstEntityUpdated" : { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1847,7 +1904,7 @@ Content-Type: application/json }, "firstEntityPartialUpdated" : { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2010,6 +2067,82 @@ HTTP/1.1 201 Created </div> </div> + <div id="resource_EntityREST_updateClassification_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/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> + <td><span class="datatype-reference">list of <a href="xml_ns0_atlasClassification.html">atlasClassification</a> + (XML)</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"> +[ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } +} ] + </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> @@ -2074,7 +2207,7 @@ Content-Type: application/json "mutatedEntities" : { "property1" : [ { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2084,7 +2217,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2095,7 +2228,7 @@ Content-Type: application/json } ], "property2" : [ { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2142,7 +2275,7 @@ Content-Type: application/json } ], "updatedEntities" : [ { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2173,7 +2306,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2194,7 +2327,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2216,7 +2349,7 @@ Content-Type: application/json }, "firstEntityUpdated" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2313,6 +2446,10 @@ Content-Type: application/json "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -2335,12 +2472,16 @@ Content-Type: application/json "referredEntities" : { "property1" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -2368,6 +2509,10 @@ Content-Type: application/json "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -2475,6 +2620,10 @@ Accept: application/json "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -2497,12 +2646,16 @@ Accept: application/json "referredEntities" : { "property1" : { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -2524,12 +2677,16 @@ Accept: application/json }, "property2" : { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -2586,7 +2743,7 @@ Content-Type: application/json } ], "property2" : [ { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2596,7 +2753,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2622,7 +2779,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2633,7 +2790,7 @@ Content-Type: application/json } ], "updatedEntities" : [ { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2664,7 +2821,7 @@ Content-Type: application/json } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2675,7 +2832,7 @@ Content-Type: application/json } ], "deletedEntities" : [ { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2696,7 +2853,7 @@ Content-Type: application/json } ], "firstEntityCreated" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2718,7 +2875,7 @@ Content-Type: application/json }, "firstEntityPartialUpdated" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/resource_LineageREST.html ---------------------------------------------------------------------- diff --git a/api/v2/resource_LineageREST.html b/api/v2/resource_LineageREST.html index 1360880..5d0da52 100644 --- a/api/v2/resource_LineageREST.html +++ b/api/v2/resource_LineageREST.html @@ -174,7 +174,7 @@ Content-Type: application/json "guidEntityMap" : { "property1" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -185,7 +185,7 @@ Content-Type: application/json }, "property2" : { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -202,7 +202,7 @@ Content-Type: application/json "fromEntityId" : "...", "toEntityId" : "..." } ], - "lineageDirection" : "OUTPUT", + "lineageDirection" : "BOTH", "lineageDepth" : 12345 } </code> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/resource_RelationshipREST.html ---------------------------------------------------------------------- diff --git a/api/v2/resource_RelationshipREST.html b/api/v2/resource_RelationshipREST.html new file mode 100644 index 0000000..026e7d7 --- /dev/null +++ b/api/v2/resource_RelationshipREST.html @@ -0,0 +1,502 @@ +<!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: RelationshipREST</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- Bootstrap core CSS --> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css"> + + <!--custom css for these pages--> + <link rel="stylesheet" href="css/style.css"> + + <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> + <![endif]--> +</head> + +<body data-spy="scroll" data-target="#apinav"> + + <nav class="navbar navbar-inverse navbar-fixed-top"> + <div class="container-fluid"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="index.html">Atlas REST API: RelationshipREST</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_RelationshipREST_create_POST">POST /v2/relationship</a></li> + <li><a href="#resource_RelationshipREST_update_PUT">PUT /v2/relationship</a></li> + <li><a href="#resource_RelationshipREST_deleteById_DELETE"><abbr title="DELETE /v2/relationship/guid/{guid}">DELETE /v2/relationship/guid/{...</abbr></a></li> + <li><a href="#resource_RelationshipREST_getById_GET"><abbr title="GET /v2/relationship/guid/{guid}">GET /v2/relationship/guid/{gui...</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_RelationshipREST.html">RelationshipREST</a></li> + </ol> + + <h1 class="page-header">RelationshipREST <small>Resource</small></h1> + + <p>REST interface for entity relationships.</p> + + <div id="resource_RelationshipREST_create_POST"> + <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/relationship <a href="../v2/relationship" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Create a new relationship between entities.</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_AtlasRelationship.html">AtlasRelationship</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> + </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_AtlasRelationship.html">AtlasRelationship</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/relationship +Content-Type: application/json +Accept: application/json + + <code class="prettyprint language-js"> +{ + "guid" : "...", + "status" : "DELETED", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "end1" : { + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } + }, + "end2" : { + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } + }, + "label" : "...", + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } +} + </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"> +{ + "guid" : "...", + "status" : "ACTIVE", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "end1" : { + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } + }, + "end2" : { + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } + }, + "label" : "...", + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } +} + </code> + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_RelationshipREST_update_PUT"> + <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/relationship <a href="../v2/relationship" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Update an existing relationship between entities.</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_AtlasRelationship.html">AtlasRelationship</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> + </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_AtlasRelationship.html">AtlasRelationship</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/relationship +Content-Type: application/json +Accept: application/json + + <code class="prettyprint language-js"> +{ + "guid" : "...", + "status" : "ACTIVE", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "end1" : { + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } + }, + "end2" : { + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } + }, + "label" : "...", + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } +} + </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"> +{ + "guid" : "...", + "status" : "ACTIVE", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "end1" : { + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } + }, + "end2" : { + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } + }, + "label" : "...", + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } +} + </code> + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_RelationshipREST_deleteById_DELETE"> + <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/relationship/guid/{guid} <a href="../v2/relationship/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Delete a relationship between entities using 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"></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/relationship/guid/{guid} + + </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_RelationshipREST_getById_GET"> + <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/relationship/guid/{guid} <a href="../v2/relationship/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Get relationship information between entities using 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"></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> + </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_AtlasRelationship.html">AtlasRelationship</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/relationship/guid/{guid} +Accept: application/json + + </pre> + </div> + <div class="col-md-6"> + <h5>Response</h5> + <pre> +HTTP/1.1 200 OK +Content-Type: application/json + + <code class="prettyprint language-js"> +{ + "guid" : "...", + "status" : "ACTIVE", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "end1" : { + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } + }, + "end2" : { + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } + }, + "label" : "...", + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } +} + </code> + </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://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script> + + <!-- Bootstrap core JavaScript + ================================================== --> + <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script> + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="https://cdn.rawgit.com/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>