| <!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: Resources</title> |
| |
| <!-- Mobile viewport optimized: j.mp/bplateviewport --> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <!-- Bootstrap core CSS --> |
| <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/css/bootstrap.min.css"> |
| |
| <!--custom css for these pages--> |
| <link rel="stylesheet" href="css/enunciate.css"> |
| |
| <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> |
| <!--[if lt IE 9]> |
| <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script> |
| <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> |
| <![endif]--> |
| </head> |
| |
| <body data-spy="scroll" data-target="#apinav"> |
| |
| <nav class="navbar navbar-inverse navbar-fixed-top"> |
| <div class="container-fluid"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <a class="navbar-brand" href="index.html">Atlas REST API: Resources</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="dropdown"><a href="resources.html">Resources</a></li> |
| </ol> |
| |
| <h1 class="page-header" id="resources">Resources</h1> |
| |
| <p> |
| There is a <a href="application.wadl">WADL document</a> available that describes the resources API. |
| </p> |
| <p> |
| You may also enjoy the <a href="ui/index.html">interactive interface</a> provided for this API by <a href="http://swagger.io">Swagger</a>. |
| </p> |
| <p> |
| <a href="ui/index.html" class="btn btn-default">Try it out!</a> |
| </p> |
| <table class="table table-hover resources"> |
| <thead> |
| <tr> |
| <th align="center">name</th> |
| <th align="center">path</th> |
| <th align="center">methods</th> |
| <th align="center">description</th> |
| </tr> |
| </thead> |
| <tbody data-link="row" class="rowlink"> |
| <tr class="clickable-row" data-href="resource_DiscoveryREST.html"> |
| <td> <span class="resource-name">DiscoveryREST</span> |
| </td> |
| <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/search/attribute</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/search/basic</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/search/dsl</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/search/fulltext</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/search/quick</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/search/relations</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/search/relationship</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/search/saved</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/search/suggestions</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/search/saved/{guid}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/search/saved/{name}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/search/saved/execute/{name}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/search/saved/execute/guid/{guid}</span> |
| </samp></li></ul></td> |
| <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li></ul></td> |
| <td> <span class="resource-description">REST interface for data discovery using dsl or full text search</span> |
| </td> |
| </tr> |
| <tr class="clickable-row" data-href="resource_EntityREST.html"> |
| <td> <span class="resource-name">EntityREST</span> |
| </td> |
| <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/entity</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/entity/bulk</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/entity/bulk/classification</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/entity/bulk/headers</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/entity/bulk/setClassifications</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/entity/businessmetadata/import</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/entity/{guid}/audit</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/entity/businessmetadata/import/template</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}/businessmetadata</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}/classifications</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}/header</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}/labels</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/entity/bulk/uniqueAttribute/type/{typeName}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}/businessmetadata/{bmName}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}/classification/{classificationName}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}/classifications</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}/header</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}/labels</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}</span> |
| </samp></li></ul></td> |
| <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">POST</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">POST</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">POST</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">POST</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">POST</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">POST</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> |
| </samp></li></ul></td> |
| <td> <span class="resource-description">REST for a single entity</span> |
| </td> |
| </tr> |
| <tr class="clickable-row" data-href="resource_GlossaryREST.html"> |
| <td> <span class="resource-name">GlossaryREST</span> |
| </td> |
| <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/glossary</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/glossary/categories</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/glossary/category</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/glossary/import</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/glossary/term</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/glossary/terms</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/glossary/category/{categoryGuid}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/glossary/import/template</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/glossary/term/{termGuid}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/categories</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/detailed</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/partial</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/terms</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/glossary/category/{categoryGuid}/partial</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/glossary/category/{categoryGuid}/related</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/glossary/category/{categoryGuid}/terms</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/glossary/term/{termGuid}/partial</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/glossary/terms/{termGuid}/assignedEntities</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/glossary/terms/{termGuid}/related</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/categories/headers</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/terms/headers</span> |
| </samp></li></ul></td> |
| <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">POST</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">POST</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">POST</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">POST</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">POST</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">PUT</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">PUT</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">PUT</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li></ul></td> |
| <td> <span class="resource-description"></span> |
| </td> |
| </tr> |
| <tr class="clickable-row" data-href="resource_LineageREST.html"> |
| <td> <span class="resource-name">LineageREST</span> |
| </td> |
| <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/lineage/{guid}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/lineage/uniqueAttribute/type/{typeName}</span> |
| </samp></li></ul></td> |
| <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li></ul></td> |
| <td> <span class="resource-description">REST interface for an entity's lineage information</span> |
| </td> |
| </tr> |
| <tr class="clickable-row" data-href="resource_RelationshipREST.html"> |
| <td> <span class="resource-name">RelationshipREST</span> |
| </td> |
| <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/relationship</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/relationship/guid/{guid}</span> |
| </samp></li></ul></td> |
| <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> |
| </samp></li></ul></td> |
| <td> <span class="resource-description">REST interface for entity relationships.</span> |
| </td> |
| </tr> |
| <tr class="clickable-row" data-href="resource_TypesREST.html"> |
| <td> <span class="resource-name">TypesREST</span> |
| </td> |
| <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/types/typedefs</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/types/typedefs/headers</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/types/businessmetadatadef/guid/{guid}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/types/businessmetadatadef/name/{name}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/types/classificationdef/guid/{guid}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/types/classificationdef/name/{name}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/types/entitydef/guid/{guid}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/types/entitydef/name/{name}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/types/enumdef/guid/{guid}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/types/enumdef/name/{name}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/types/relationshipdef/guid/{guid}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/types/relationshipdef/name/{name}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/types/structdef/guid/{guid}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/types/structdef/name/{name}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/types/typedef/guid/{guid}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/types/typedef/name/{name}</span> |
| </samp></li><li><samp> <span class="resource-path">/v2/types/typedef/name/{typeName}</span> |
| </samp></li></ul></td> |
| <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">GET</span> |
| </samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> |
| </samp></li></ul></td> |
| <td> <span class="resource-description">REST interface for CRUD operations on type definitions</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://code.jquery.com/jquery-1.12.2.min.js"></script> |
| |
| <!-- Bootstrap core JavaScript |
| ================================================== --> |
| <script src="https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/js/bootstrap.min.js"></script> |
| |
| <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> |
| <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js" type="text/javascript"></script> |
| <script> |
| $(function() { |
| $(".clickable-row").click(function() { |
| window.document.location = $(this).data("href"); |
| }); |
| |
| $('[data-toggle="tooltip"]').tooltip() |
| }); |
| </script> |
| |
| </body> |
| </html> |
