http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c5b7bdb3/0.8.1/api/v2/json_SortType.html ---------------------------------------------------------------------- diff --git a/0.8.1/api/v2/json_SortType.html b/0.8.1/api/v2/json_SortType.html new file mode 100644 index 0000000..aefc77b --- /dev/null +++ b/0.8.1/api/v2/json_SortType.html @@ -0,0 +1,126 @@ +<!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: SortType</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: SortType</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 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="syntax_json.html">JSON</a></li> + <li class="dropdown"><a href="json_SortType.html">SortType</a></li> + </ol> + + <h1 class="page-header">SortType <small>Data Type</small></h1> + + <p>to specify whether the result should be sorted? If yes, whether asc or desc.</p> + + <dl class="dl-horizontal"> + </dl> + + <table class="table datatype-values"> + <caption>Values</caption> + <thead> + <tr> + <th>value</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td><span class="value-value">NONE</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value">ASC</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value">DESC</span></td> + <td><span class="value-description"></span></td> + </tr> + </tbody> + </table> + + <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>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c5b7bdb3/0.8.1/api/v2/json_Status.html ---------------------------------------------------------------------- diff --git a/0.8.1/api/v2/json_Status.html b/0.8.1/api/v2/json_Status.html new file mode 100644 index 0000000..7eb0987 --- /dev/null +++ b/0.8.1/api/v2/json_Status.html @@ -0,0 +1,122 @@ +<!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: Status</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: Status</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 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="syntax_json.html">JSON</a></li> + <li class="dropdown"><a href="json_Status.html">Status</a></li> + </ol> + + <h1 class="page-header">Status <small>Data Type</small></h1> + + <p>Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</p> + + <dl class="dl-horizontal"> + </dl> + + <table class="table datatype-values"> + <caption>Values</caption> + <thead> + <tr> + <th>value</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td><span class="value-value">ACTIVE</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value">DELETED</span></td> + <td><span class="value-description"></span></td> + </tr> + </tbody> + </table> + + <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> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c5b7bdb3/0.8.1/api/v2/json_Status_AtlasRelationship.html ---------------------------------------------------------------------- diff --git a/0.8.1/api/v2/json_Status_AtlasRelationship.html b/0.8.1/api/v2/json_Status_AtlasRelationship.html new file mode 100644 index 0000000..f455e2b --- /dev/null +++ b/0.8.1/api/v2/json_Status_AtlasRelationship.html @@ -0,0 +1,122 @@ +<!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: Status</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: Status</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 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="syntax_json.html">JSON</a></li> + <li class="dropdown"><a href="json_Status_AtlasRelationship.html">Status</a></li> + </ol> + + <h1 class="page-header">Status <small>Data Type</small></h1> + + <p></p> + + <dl class="dl-horizontal"> + </dl> + + <table class="table datatype-values"> + <caption>Values</caption> + <thead> + <tr> + <th>value</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td><span class="value-value">ACTIVE</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value">DELETED</span></td> + <td><span class="value-description"></span></td> + </tr> + </tbody> + </table> + + <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> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c5b7bdb3/0.8.1/api/v2/json_TypeCategory.html ---------------------------------------------------------------------- diff --git a/0.8.1/api/v2/json_TypeCategory.html b/0.8.1/api/v2/json_TypeCategory.html new file mode 100644 index 0000000..29ff07f --- /dev/null +++ b/0.8.1/api/v2/json_TypeCategory.html @@ -0,0 +1,150 @@ +<!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: TypeCategory</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: TypeCategory</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 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="syntax_json.html">JSON</a></li> + <li class="dropdown"><a href="json_TypeCategory.html">TypeCategory</a></li> + </ol> + + <h1 class="page-header">TypeCategory <small>Data Type</small></h1> + + <p></p> + + <dl class="dl-horizontal"> + </dl> + + <table class="table datatype-values"> + <caption>Values</caption> + <thead> + <tr> + <th>value</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td><span class="value-value">PRIMITIVE</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value">OBJECT_ID_TYPE</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value">ENUM</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value">STRUCT</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value">CLASSIFICATION</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value">ENTITY</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value">ARRAY</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value">MAP</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value">RELATIONSHIP</span></td> + <td><span class="value-description"></span></td> + </tr> + </tbody> + </table> + + <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> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c5b7bdb3/0.8.1/api/v2/ns0.xsd ---------------------------------------------------------------------- diff --git a/0.8.1/api/v2/ns0.xsd b/0.8.1/api/v2/ns0.xsd new file mode 100644 index 0000000..cdb7997 --- /dev/null +++ b/0.8.1/api/v2/ns0.xsd @@ -0,0 +1,120 @@ +<?xml version="1.0" encoding="UTF-8"?> +<xs:schema version="1.0" + + xmlns:xs="http://www.w3.org/2001/XMLSchema"> + + <xs:element name="PList" type="PList"/> + <xs:element name="searchFilter" type="searchFilter"/> + <xs:element name="atlasClassification" type="atlasClassification"/> + <xs:element name="atlasStruct" type="atlasStruct"/> +<xs:complexType name="PList"> + <xs:annotation> + <xs:documentation> + <![CDATA[Paginated-list, for returning search results.]]> + </xs:documentation> + </xs:annotation> + <xs:sequence> + <xs:element name="list" type="xs:anyType" minOccurs="0" maxOccurs="unbounded"> + </xs:element> + <xs:element name="startIndex" type="xs:long" minOccurs="1"> + </xs:element> + <xs:element name="pageSize" type="xs:int" minOccurs="1"> + </xs:element> + <xs:element name="totalCount" type="xs:long" minOccurs="1"> + </xs:element> + <xs:element name="sortType" type="sortType" minOccurs="0"> + </xs:element> + <xs:element name="sortBy" type="xs:string" minOccurs="0"> + </xs:element> + </xs:sequence> +</xs:complexType> + +<xs:complexType name="searchFilter"> + <xs:annotation> + <xs:documentation> + <![CDATA[Generic filter, to specify search criteria using name/value pairs.]]> + </xs:documentation> + </xs:annotation> + <xs:sequence> + <xs:element name="params" minOccurs="0"> + <xs:complexType> + <xs:sequence> + <xs:element name="entry" minOccurs="0" maxOccurs="unbounded"> + <xs:complexType> + <xs:sequence> + <xs:element name="key" minOccurs="1" type="xs:string"/> + <xs:element name="value" minOccurs="1" type="xs:anyType"/> + </xs:sequence> + </xs:complexType> + </xs:element> + </xs:sequence> + </xs:complexType> + </xs:element> + <xs:element name="startIndex" type="xs:long" minOccurs="1"> + </xs:element> + <xs:element name="maxRows" type="xs:long" minOccurs="1"> + </xs:element> + <xs:element name="getCount" type="xs:boolean" minOccurs="1"> + </xs:element> + <xs:element name="sortBy" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="sortType" type="sortType" minOccurs="0"> + </xs:element> + </xs:sequence> +</xs:complexType> + +<xs:simpleType name="sortType"> + <xs:annotation> + <xs:documentation> + <![CDATA[to specify whether the result should be sorted? If yes, whether asc or desc.]]> + </xs:documentation> + </xs:annotation> + <xs:restriction base="xs:string"> + + <xs:enumeration value="NONE"/> + + <xs:enumeration value="ASC"/> + + <xs:enumeration value="DESC"/> + </xs:restriction> +</xs:simpleType> + +<xs:complexType name="atlasClassification"> + <xs:annotation> + <xs:documentation> + <![CDATA[An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.]]> + </xs:documentation> + </xs:annotation> + <xs:complexContent> + <xs:extension base="atlasStruct"> + </xs:extension> + </xs:complexContent> +</xs:complexType> + +<xs:complexType name="atlasStruct"> + <xs:annotation> + <xs:documentation> + <![CDATA[Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.]]> + </xs:documentation> + </xs:annotation> + <xs:sequence> + <xs:element name="typeName" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="attributes" minOccurs="0"> + <xs:complexType> + <xs:sequence> + <xs:element name="entry" minOccurs="0" maxOccurs="unbounded"> + <xs:complexType> + <xs:sequence> + <xs:element name="key" minOccurs="1" type="xs:string"/> + <xs:element name="value" minOccurs="1" type="xs:anyType"/> + </xs:sequence> + </xs:complexType> + </xs:element> + </xs:sequence> + </xs:complexType> + </xs:element> + </xs:sequence> +</xs:complexType> + +</xs:schema> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c5b7bdb3/0.8.1/api/v2/resource_DiscoveryREST.html ---------------------------------------------------------------------- diff --git a/0.8.1/api/v2/resource_DiscoveryREST.html b/0.8.1/api/v2/resource_DiscoveryREST.html new file mode 100644 index 0000000..a4c56e5 --- /dev/null +++ b/0.8.1/api/v2/resource_DiscoveryREST.html @@ -0,0 +1,1431 @@ +<!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: DiscoveryREST</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: DiscoveryREST</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_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><a href="#resource_DiscoveryREST_searchRelatedEntities_GET">GET /v2/search/relationship</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_DiscoveryREST.html">DiscoveryREST</a></li> + </ol> + + <h1 class="page-header">DiscoveryREST <small>Resource</small></h1> + + <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" : "BASIC", + "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" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "DELETED", + "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> + + <p>Retrieve data for the specified fulltext 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">classification</span></td> + <td>query</td> + <td><span class="parameter-description">limit the result to only entities tagged with the given classification or or its sub-types</span></td> + <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> + <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">query</span></td> + <td>query</td> + <td><span class="parameter-description">Fulltext query</span></td> + <td><span class="parameter-constraints"> </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 fulltext 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/basic +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" : "FULL_TEXT", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "EQ", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "ENDS_WITH", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, + "queryText" : "...", + "type" : "...", + "classification" : "...", + "entities" : [ { + "guid" : "...", + "status" : "DELETED", + "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" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "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" : "AND", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "STARTS_WITH", + "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" : "AND", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "ENDS_WITH", + "attributeValue" : "...", + "condition" : "AND", + "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> + </div> + </div> + </div> + </div> + + <div id="resource_DiscoveryREST_searchUsingDSL_GET"> + <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/dsl <a href="../v2/search/dsl" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Retrieve data for the specified DSL</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">classification</span></td> + <td>query</td> + <td><span class="parameter-description">limit the result to only entities tagged with the given classification or or its sub-types</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">query</span></td> + <td>query</td> + <td><span class="parameter-description">DSL query</span></td> + <td><span class="parameter-constraints"> </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 DSL execution 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 DSL 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/dsl +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" : "RELATIONSHIP", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "LTE", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "LT", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, + "queryText" : "...", + "type" : "...", + "classification" : "...", + "entities" : [ { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "DELETED", + "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" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } +} + </code> + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_DiscoveryREST_searchUsingFullText_GET"> + <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/fulltext <a href="../v2/search/fulltext" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Retrieve data for the specified fulltext 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">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> + <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">query</span></td> + <td>query</td> + <td><span class="parameter-description">Fulltext query</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 fulltext 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/fulltext +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" : "DSL", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "IN", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "NEQ", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, + "queryText" : "...", + "type" : "...", + "classification" : "...", + "entities" : [ { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "DELETED", + "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" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 + } ], + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } +} + </code> + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_DiscoveryREST_searchRelatedEntities_GET"> + <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/relationship <a href="../v2/search/relationship" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Relationship search to search for related entities satisfying the search parameters</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">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">guid</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">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">relation</span></td> + <td>query</td> + <td><span class="parameter-description">relationName</span></td> + <td><span class="parameter-constraints"> </span></td> + </tr> + <tr> + <td><span class="parameter-name">sortBy</span></td> + <td>query</td> + <td><span class="parameter-description">sort the result using this attribute name, default value is 'name'</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">sorting order</span></td> + <td><span class="parameter-constraints">"ASCENDING" or "DESCENDING"</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">guid is not a valid entity type or attributeName is not a valid relationship attribute</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> +GET /v2/search/relationship +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" : "DSL", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "GTE", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "STARTS_WITH", + "attributeValue" : "...", + "condition" : "AND", + "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" : "DELETED", + "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> + </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>