http://git-wip-us.apache.org/repos/asf/atlas-website/blob/af60ed7f/1.0.0-alpha/api/v2/v2/apidocs/json_ClassificationAssociateRequest.html ---------------------------------------------------------------------- diff --git a/1.0.0-alpha/api/v2/v2/apidocs/json_ClassificationAssociateRequest.html b/1.0.0-alpha/api/v2/v2/apidocs/json_ClassificationAssociateRequest.html deleted file mode 100644 index 4747dcb..0000000 --- a/1.0.0-alpha/api/v2/v2/apidocs/json_ClassificationAssociateRequest.html +++ /dev/null @@ -1,146 +0,0 @@ -<!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: ClassificationAssociateRequest</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/enunciate.css"> - - <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> - <!--[if lt IE 9]> - <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> - <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> - <![endif]--> -</head> - -<body data-spy="scroll" data-target="#apinav"> - - <nav class="navbar navbar-inverse navbar-fixed-top"> - <div class="container-fluid"> - <div class="navbar-header"> - <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - <a class="navbar-brand" href="index.html">Atlas REST API: ClassificationAssociateRequest</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_ClassificationAssociateRequest.html">ClassificationAssociateRequest</a></li> - </ol> - - <h1 class="page-header">ClassificationAssociateRequest <small>Data Type</small></h1> - - <p></p> - - <dl class="dl-horizontal"> - </dl> - - <table class="table datatype-properties"> - <caption>Properties</caption> - <thead> - <tr> - <th>name</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td> <span class="property-name">classification</span> -</td> - <td> <span class="datatype-reference"><a href="json_AtlasClassification.html">AtlasClassification</a> -</span> -</td> - <td> <span class="property-description"></span> -</td> - </tr> - <tr> - <td> <span class="property-name">entityGuids</span> -</td> - <td> <span class="datatype-reference">array of string -</span> -</td> - <td> <span class="property-description"></span> -</td> - </tr> - </tbody> - </table> - - <p class="lead">Example</p> - - <pre class="prettyprint language-js example">{ - "classification" : { - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, - "entityGuids" : [ "...", "..." ] -}</pre> - - <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/af60ed7f/1.0.0-alpha/api/v2/v2/apidocs/json_PList.html ---------------------------------------------------------------------- diff --git a/1.0.0-alpha/api/v2/v2/apidocs/json_PList.html b/1.0.0-alpha/api/v2/v2/apidocs/json_PList.html deleted file mode 100644 index 0aac299..0000000 --- a/1.0.0-alpha/api/v2/v2/apidocs/json_PList.html +++ /dev/null @@ -1,180 +0,0 @@ -<!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: PList</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/enunciate.css"> - - <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> - <!--[if lt IE 9]> - <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> - <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> - <![endif]--> -</head> - -<body data-spy="scroll" data-target="#apinav"> - - <nav class="navbar navbar-inverse navbar-fixed-top"> - <div class="container-fluid"> - <div class="navbar-header"> - <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - <a class="navbar-brand" href="index.html">Atlas REST API: PList</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_PList.html">PList</a></li> - </ol> - - <h1 class="page-header">PList <small>Data Type</small></h1> - - <p>Paginated-list, for returning search results.</p> - - <dl class="dl-horizontal"> - </dl> - - <table class="table datatype-properties"> - <caption>Properties</caption> - <thead> - <tr> - <th>name</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td> <span class="property-name">list</span> -</td> - <td> <span class="datatype-reference">array of object -</span> -</td> - <td> <span class="property-description"></span> -</td> - </tr> - <tr> - <td> <span class="property-name">startIndex</span> -</td> - <td> <span class="datatype-reference">number -</span> -</td> - <td> <span class="property-description"></span> -</td> - </tr> - <tr> - <td> <span class="property-name">pageSize</span> -</td> - <td> <span class="datatype-reference">number -</span> -</td> - <td> <span class="property-description"></span> -</td> - </tr> - <tr> - <td> <span class="property-name">totalCount</span> -</td> - <td> <span class="datatype-reference">number -</span> -</td> - <td> <span class="property-description"></span> -</td> - </tr> - <tr> - <td> <span class="property-name">sortType</span> -</td> - <td> <span class="datatype-reference"><a href="json_SortType.html">SortType</a> -</span> -</td> - <td> <span class="property-description"></span> -</td> - </tr> - <tr> - <td> <span class="property-name">sortBy</span> -</td> - <td> <span class="datatype-reference">string -</span> -</td> - <td> <span class="property-description"></span> -</td> - </tr> - </tbody> - </table> - - <p class="lead">Example</p> - - <pre class="prettyprint language-js example">{ - "list" : [ { }, { } ], - "startIndex" : 12345, - "pageSize" : 12345, - "totalCount" : 12345, - "sortType" : "DESC", - "sortBy" : "..." -}</pre> - - <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/af60ed7f/1.0.0-alpha/api/v2/v2/apidocs/json_SearchFilter.html ---------------------------------------------------------------------- diff --git a/1.0.0-alpha/api/v2/v2/apidocs/json_SearchFilter.html b/1.0.0-alpha/api/v2/v2/apidocs/json_SearchFilter.html deleted file mode 100644 index 15a6253..0000000 --- a/1.0.0-alpha/api/v2/v2/apidocs/json_SearchFilter.html +++ /dev/null @@ -1,183 +0,0 @@ -<!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: SearchFilter</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/enunciate.css"> - - <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> - <!--[if lt IE 9]> - <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> - <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> - <![endif]--> -</head> - -<body data-spy="scroll" data-target="#apinav"> - - <nav class="navbar navbar-inverse navbar-fixed-top"> - <div class="container-fluid"> - <div class="navbar-header"> - <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - <a class="navbar-brand" href="index.html">Atlas REST API: SearchFilter</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_SearchFilter.html">SearchFilter</a></li> - </ol> - - <h1 class="page-header">SearchFilter <small>Data Type</small></h1> - - <p>Generic filter, to specify search criteria using name/value pairs.</p> - - <dl class="dl-horizontal"> - </dl> - - <table class="table datatype-properties"> - <caption>Properties</caption> - <thead> - <tr> - <th>name</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td> <span class="property-name">params</span> -</td> - <td> <span class="datatype-reference">map of array of string -</span> -</td> - <td> <span class="property-description"></span> -</td> - </tr> - <tr> - <td> <span class="property-name">startIndex</span> -</td> - <td> <span class="datatype-reference">number -</span> -</td> - <td> <span class="property-description"></span> -</td> - </tr> - <tr> - <td> <span class="property-name">maxRows</span> -</td> - <td> <span class="datatype-reference">number -</span> -</td> - <td> <span class="property-description"></span> -</td> - </tr> - <tr> - <td> <span class="property-name">getCount</span> -</td> - <td> <span class="datatype-reference">boolean -</span> -</td> - <td> <span class="property-description"></span> -</td> - </tr> - <tr> - <td> <span class="property-name">sortBy</span> -</td> - <td> <span class="datatype-reference">string -</span> -</td> - <td> <span class="property-description"></span> -</td> - </tr> - <tr> - <td> <span class="property-name">sortType</span> -</td> - <td> <span class="datatype-reference"><a href="json_SortType.html">SortType</a> -</span> -</td> - <td> <span class="property-description"></span> -</td> - </tr> - </tbody> - </table> - - <p class="lead">Example</p> - - <pre class="prettyprint language-js example">{ - "params" : { - "property1" : [ "...", "..." ], - "property2" : [ "...", "..." ] - }, - "startIndex" : 12345, - "maxRows" : 12345, - "getCount" : true, - "sortBy" : "...", - "sortType" : "ASC" -}</pre> - - <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/af60ed7f/1.0.0-alpha/api/v2/v2/apidocs/json_SortType.html ---------------------------------------------------------------------- diff --git a/1.0.0-alpha/api/v2/v2/apidocs/json_SortType.html b/1.0.0-alpha/api/v2/v2/apidocs/json_SortType.html deleted file mode 100644 index 84828ad..0000000 --- a/1.0.0-alpha/api/v2/v2/apidocs/json_SortType.html +++ /dev/null @@ -1,130 +0,0 @@ -<!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/enunciate.css"> - - <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> - <!--[if lt IE 9]> - <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> - <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> - <![endif]--> -</head> - -<body data-spy="scroll" data-target="#apinav"> - - <nav class="navbar navbar-inverse navbar-fixed-top"> - <div class="container-fluid"> - <div class="navbar-header"> - <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - <a class="navbar-brand" href="index.html">Atlas REST API: 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><a href="#NONE"><abbr title="NONE"><span class="sideoverflow">NONE</span></abbr></a></li> - <li><a href="#ASC"><abbr title="ASC"><span class="sideoverflow">ASC</span></abbr></a></li> - <li><a href="#DESC"><abbr title="DESC"><span class="sideoverflow">DESC</span></abbr></a></li> - <li class="divider"></li> - <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> - </ul> - </div> - - <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main"> - <ol class="breadcrumb" id="top"> - <li class="active dropdown"><a href="index.html">Home</a></li> - <li class="active dropdown"><a href="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" id="NONE">NONE</span></td> - <td><span class="value-description"></span></td> - </tr> - <tr> - <td><span class="value-value" id="ASC">ASC</span></td> - <td><span class="value-description"></span></td> - </tr> - <tr> - <td><span class="value-value" id="DESC">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/af60ed7f/1.0.0-alpha/api/v2/v2/apidocs/ns0.xsd ---------------------------------------------------------------------- diff --git a/1.0.0-alpha/api/v2/v2/apidocs/ns0.xsd b/1.0.0-alpha/api/v2/v2/apidocs/ns0.xsd deleted file mode 100644 index 7028b05..0000000 --- a/1.0.0-alpha/api/v2/v2/apidocs/ns0.xsd +++ /dev/null @@ -1,128 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<xs:schema version="1.0" - - xmlns:xs="http://www.w3.org/2001/XMLSchema";> - - <xs:element name="atlasBaseModelObject" type="atlasBaseModelObject"/> - <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="atlasBaseModelObject" abstract="true"> - <xs:sequence> - <xs:element name="guid" type="xs:string" minOccurs="0"> - </xs:element> - </xs:sequence> -</xs:complexType> - -<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/af60ed7f/1.0.0-alpha/api/v2/v2/apidocs/resource_DiscoveryREST.html ---------------------------------------------------------------------- diff --git a/1.0.0-alpha/api/v2/v2/apidocs/resource_DiscoveryREST.html b/1.0.0-alpha/api/v2/v2/apidocs/resource_DiscoveryREST.html deleted file mode 100644 index e35ff90..0000000 --- a/1.0.0-alpha/api/v2/v2/apidocs/resource_DiscoveryREST.html +++ /dev/null @@ -1,1260 +0,0 @@ -<!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/enunciate.css"> - - <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> - <!--[if lt IE 9]> - <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> - <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> - <![endif]--> -</head> - -<body data-spy="scroll" data-target="#apinav"> - - <nav class="navbar navbar-inverse navbar-fixed-top"> - <div class="container-fluid"> - <div class="navbar-header"> - <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - <a class="navbar-brand" href="index.html">Atlas REST API: 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"><abbr title="GET /v2/search/attribute"><span class="sideoverflow">GET /v2/search/attribute</span></abbr></a></li> - <li><a href="#resource_DiscoveryREST_searchUsingBasic_GET"><abbr title="GET /v2/search/basic"><span class="sideoverflow">GET /v2/search/basic</span></abbr></a></li> - <li><a href="#resource_DiscoveryREST_searchWithParameters_POST"><abbr title="POST /v2/search/basic"><span class="sideoverflow">POST /v2/search/basic</span></abbr></a></li> - <li><a href="#resource_DiscoveryREST_searchUsingDSL_GET"><abbr title="GET /v2/search/dsl"><span class="sideoverflow">GET /v2/search/dsl</span></abbr></a></li> - <li><a href="#resource_DiscoveryREST_searchUsingFullText_GET"><abbr title="GET /v2/search/fulltext"><span class="sideoverflow">GET /v2/search/fulltext</span></abbr></a></li> - <li><a href="#resource_DiscoveryREST_searchRelatedEntities_GET"><abbr title="GET /v2/search/relationship"><span class="sideoverflow">GET /v2/search/relationship</span></abbr></a></li> - <li><a href="#resource_DiscoveryREST_getSavedSearches_GET"><abbr title="GET /v2/search/saved"><span class="sideoverflow">GET /v2/search/saved</span></abbr></a></li> - <li><a href="#resource_DiscoveryREST_addSavedSearch_POST"><abbr title="POST /v2/search/saved"><span class="sideoverflow">POST /v2/search/saved</span></abbr></a></li> - <li><a href="#resource_DiscoveryREST_updateSavedSearch_PUT"><abbr title="PUT /v2/search/saved"><span class="sideoverflow">PUT /v2/search/saved</span></abbr></a></li> - <li><a href="#resource_DiscoveryREST_deleteSavedSearch_DELETE"><abbr title="DELETE /v2/search/saved/{guid}"><span class="sideoverflow">DELETE /v2/search/saved/{guid}</span></abbr></a></li> - <li><a href="#resource_DiscoveryREST_getSavedSearch_GET"><abbr title="GET /v2/search/saved/{name}"><span class="sideoverflow">GET /v2/search/saved/{name}</span></abbr></a></li> - <li><a href="#resource_DiscoveryREST_executeSavedSearchByName_GET"><abbr title="GET /v2/search/saved/execute/{name}"><span class="sideoverflow">GET /v2/search/saved/execute/{name}</span></abbr></a></li> - <li><a href="#resource_DiscoveryREST_executeSavedSearchByGuid_GET"><abbr title="GET /v2/search/saved/execute/guid/{guid}"><span class="sideoverflow">GET /v2/search/saved/execute/guid/{guid}</span></abbr></a></li> - <li class="divider"></li> - <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> - </ul> - </div> - - <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main"> - <ol class="breadcrumb" id="top"> - <li class="active dropdown"><a href="index.html">Home</a></li> - <li class="active dropdown"><a href="resources.html">Resources</a></li> - <li class="dropdown"><a href="resource_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;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</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;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </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;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</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;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </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;charset=UTF-8" HTTP header to specify this media type to the server."><span class="request-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</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;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</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;charset=UTF-8 -Accept: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </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;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</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;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </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;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</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;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </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;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</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;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_DiscoveryREST_getSavedSearches_GET"> - <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/saved <a href="../v2/search/saved" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p></p> - - <table class="table resource-parameters"> - <caption>Request Parameters</caption> - <thead> - <tr> - <th>name</th> - <th>type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="parameter-name">user</span></td> - <td>query</td> - <td><span class="parameter-description">User for whom the search is retrieved</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;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="response-description">list of all saved searches for given user</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/saved -Accept: application/json;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_DiscoveryREST_addSavedSearch_POST"> - <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/search/saved <a href="../v2/search/saved" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p></p> - - <table class="table resource-request-body"> - <caption>Request Body</caption> - <thead> - <tr> - <th>media type</th> - <th>data type</th> - </tr> - </thead> - <tbody> - <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json;charset=UTF-8" HTTP header to specify this media type to the server."><span class="request-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</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;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="response-description">the saved search-object</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/saved -Content-Type: application/json;charset=UTF-8 -Accept: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 201 Created -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_DiscoveryREST_updateSavedSearch_PUT"> - <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/search/saved <a href="../v2/search/saved" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p></p> - - <table class="table resource-request-body"> - <caption>Request Body</caption> - <thead> - <tr> - <th>media type</th> - <th>data type</th> - </tr> - </thead> - <tbody> - <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json;charset=UTF-8" HTTP header to specify this media type to the server."><span class="request-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</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;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="response-description">the updated search-object</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/search/saved -Content-Type: application/json;charset=UTF-8 -Accept: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 204 No Content -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_DiscoveryREST_deleteSavedSearch_DELETE"> - <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/search/saved/{guid} <a href="../v2/search/saved/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p></p> - - <table class="table resource-parameters"> - <caption>Request Parameters</caption> - <thead> - <tr> - <th>name</th> - <th>type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="parameter-name">guid</span></td> - <td>path</td> - <td><span class="parameter-description">Name of the saved search</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/search/saved/{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_DiscoveryREST_getSavedSearch_GET"> - <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/saved/{name} <a href="../v2/search/saved/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p></p> - - <table class="table resource-parameters"> - <caption>Request Parameters</caption> - <thead> - <tr> - <th>name</th> - <th>type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="parameter-name">name</span></td> - <td>path</td> - <td><span class="parameter-description">Name of the saved search</span></td> - </tr> - <tr> - <td><span class="parameter-name">user</span></td> - <td>query</td> - <td><span class="parameter-description">User for whom the search is retrieved</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;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="response-description"></span></td> - </tr> - </tbody> - </table> - <h4>Example</h4> - - <div class="container-fluid example panel"> - <div class="row panel-body"> - <div class="col-md-6"> - <h5>Request</h5> - <pre> -GET /v2/search/saved/{name} -Accept: application/json;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_DiscoveryREST_executeSavedSearchByName_GET"> - <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/saved/execute/{name} <a href="../v2/search/saved/execute/{name}" 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-parameters"> - <caption>Request Parameters</caption> - <thead> - <tr> - <th>name</th> - <th>type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="parameter-name">name</span></td> - <td>path</td> - <td><span class="parameter-description">name of saved-search</span></td> - </tr> - <tr> - <td><span class="parameter-name">user</span></td> - <td>query</td> - <td><span class="parameter-description">saved-search owner</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;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</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/saved/execute/{name} -Accept: application/json;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_DiscoveryREST_executeSavedSearchByGuid_GET"> - <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/saved/execute/guid/{guid} <a href="../v2/search/saved/execute/guid/{guid}" 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-parameters"> - <caption>Request Parameters</caption> - <thead> - <tr> - <th>name</th> - <th>type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="parameter-name">guid</span></td> - <td>path</td> - <td><span class="parameter-description">Guid identifying saved search</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;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</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/saved/execute/guid/{guid} -Accept: application/json;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </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>
