| <!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>Ranger REST API: TagREST</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">Ranger REST API: TagREST</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_TagREST_importServiceTags_PUT"><abbr title="PUT /tags/importservicetags"><span class="sideoverflow">PUT /tags/importservicetags</span></abbr></a></li> |
| <li><a href="#resource_TagREST_getAllServiceResources_GET"><abbr title="GET /tags/resources"><span class="sideoverflow">GET /tags/resources</span></abbr></a></li> |
| <li><a href="#resource_TagREST_createServiceResource_POST"><abbr title="POST /tags/resources"><span class="sideoverflow">POST /tags/resources</span></abbr></a></li> |
| <li><a href="#resource_TagREST_getAllTagDefs_GET"><abbr title="GET /tags/tagdefs"><span class="sideoverflow">GET /tags/tagdefs</span></abbr></a></li> |
| <li><a href="#resource_TagREST_createTagDef_POST"><abbr title="POST /tags/tagdefs"><span class="sideoverflow">POST /tags/tagdefs</span></abbr></a></li> |
| <li><a href="#resource_TagREST_deleteTagResourceMap_DELETE"><abbr title="DELETE /tags/tagresourcemaps"><span class="sideoverflow">DELETE /tags/tagresourcemaps</span></abbr></a></li> |
| <li><a href="#resource_TagREST_getAllTagResourceMaps_GET"><abbr title="GET /tags/tagresourcemaps"><span class="sideoverflow">GET /tags/tagresourcemaps</span></abbr></a></li> |
| <li><a href="#resource_TagREST_createTagResourceMap_POST"><abbr title="POST /tags/tagresourcemaps"><span class="sideoverflow">POST /tags/tagresourcemaps</span></abbr></a></li> |
| <li><a href="#resource_TagREST_getAllTags_GET"><abbr title="GET /tags/tags"><span class="sideoverflow">GET /tags/tags</span></abbr></a></li> |
| <li><a href="#resource_TagREST_createTag_POST"><abbr title="POST /tags/tags"><span class="sideoverflow">POST /tags/tags</span></abbr></a></li> |
| <li><a href="#resource_TagREST_getTagTypes_GET"><abbr title="GET /tags/types"><span class="sideoverflow">GET /tags/types</span></abbr></a></li> |
| <li><a href="#resource_TagREST_getServiceTagsIfUpdated_GET"><abbr title="GET /tags/download/{serviceName}"><span class="sideoverflow">GET /tags/download/{serviceName}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_deleteServiceResource_DELETE"><abbr title="DELETE /tags/resource/{id}"><span class="sideoverflow">DELETE /tags/resource/{id}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_getServiceResource_GET"><abbr title="GET /tags/resource/{id}"><span class="sideoverflow">GET /tags/resource/{id}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_updateServiceResource_PUT"><abbr title="PUT /tags/resource/{id}"><span class="sideoverflow">PUT /tags/resource/{id}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_deleteTagDeltas_DELETE"><abbr title="DELETE /tags/server/tagdeltas"><span class="sideoverflow">DELETE /tags/server/tagdeltas</span></abbr></a></li> |
| <li><a href="#resource_TagREST_deleteTag_DELETE"><abbr title="DELETE /tags/tag/{id}"><span class="sideoverflow">DELETE /tags/tag/{id}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_getTag_GET"><abbr title="GET /tags/tag/{id}"><span class="sideoverflow">GET /tags/tag/{id}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_updateTag_PUT"><abbr title="PUT /tags/tag/{id}"><span class="sideoverflow">PUT /tags/tag/{id}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_deleteTagDef_DELETE"><abbr title="DELETE /tags/tagdef/{id}"><span class="sideoverflow">DELETE /tags/tagdef/{id}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_getTagDef_GET"><abbr title="GET /tags/tagdef/{id}"><span class="sideoverflow">GET /tags/tagdef/{id}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_updateTagDef_PUT"><abbr title="PUT /tags/tagdef/{id}"><span class="sideoverflow">PUT /tags/tagdef/{id}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_getTagResourceMap_GET"><abbr title="GET /tags/tagresourcemap/tag-resource-guid"><span class="sideoverflow">GET /tags/tagresourcemap/tag-resource-guid</span></abbr></a></li> |
| <li><a href="#resource_TagREST_deleteTagResourceMap_DELETE"><abbr title="DELETE /tags/tagresourcemap/{id}"><span class="sideoverflow">DELETE /tags/tagresourcemap/{id}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_getTagResourceMap_GET"><abbr title="GET /tags/tagresourcemap/{id}"><span class="sideoverflow">GET /tags/tagresourcemap/{id}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_deleteServiceResourceByGuid_DELETE"><abbr title="DELETE /tags/resource/guid/{guid}"><span class="sideoverflow">DELETE /tags/resource/guid/{guid}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_getServiceResourceByGuid_GET"><abbr title="GET /tags/resource/guid/{guid}"><span class="sideoverflow">GET /tags/resource/guid/{guid}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_updateServiceResourceByGuid_PUT"><abbr title="PUT /tags/resource/guid/{guid}"><span class="sideoverflow">PUT /tags/resource/guid/{guid}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_getServiceResourcesByService_GET"><abbr title="GET /tags/resources/service/{serviceName}"><span class="sideoverflow">GET /tags/resources/service/{serviceName}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_getSecureServiceTagsIfUpdated_GET"><abbr title="GET /tags/secure/download/{serviceName}"><span class="sideoverflow">GET /tags/secure/download/{serviceName}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_deleteTagByGuid_DELETE"><abbr title="DELETE /tags/tag/guid/{guid}"><span class="sideoverflow">DELETE /tags/tag/guid/{guid}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_getTagByGuid_GET"><abbr title="GET /tags/tag/guid/{guid}"><span class="sideoverflow">GET /tags/tag/guid/{guid}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_updateTagByGuid_PUT"><abbr title="PUT /tags/tag/guid/{guid}"><span class="sideoverflow">PUT /tags/tag/guid/{guid}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_deleteTagDefByGuid_DELETE"><abbr title="DELETE /tags/tagdef/guid/{guid}"><span class="sideoverflow">DELETE /tags/tagdef/guid/{guid}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_getTagDefByGuid_GET"><abbr title="GET /tags/tagdef/guid/{guid}"><span class="sideoverflow">GET /tags/tagdef/guid/{guid}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_getTagDefByName_GET"><abbr title="GET /tags/tagdef/name/{name}"><span class="sideoverflow">GET /tags/tagdef/name/{name}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_deleteTagResourceMapByGuid_DELETE"><abbr title="DELETE /tags/tagresourcemap/guid/{guid}"><span class="sideoverflow">DELETE /tags/tagresourcemap/guid/{guid}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_getTagResourceMapByGuid_GET"><abbr title="GET /tags/tagresourcemap/guid/{guid}"><span class="sideoverflow">GET /tags/tagresourcemap/guid/{guid}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_getTagsByType_GET"><abbr title="GET /tags/tags/type/{type}"><span class="sideoverflow">GET /tags/tags/type/{type}</span></abbr></a></li> |
| <li><a href="#resource_TagREST_getServiceResourceByServiceAndResourceSignature_GET"><abbr title="GET /tags/resource/service/{serviceName}/signature/{resourceSignature}"><span class="sideoverflow">GET /tags/resource/service/{serviceName}/signature/{resourceSignature}</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_TagREST.html">TagREST</a></li> |
| </ol> |
| |
| <h1 class="page-header">TagREST <small>Resource</small></h1> |
| |
| <p></p> |
| |
| <div id="resource_TagREST_importServiceTags_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/tags/importservicetags <a href="../tags/importservicetags" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_ServiceTags.html">ServiceTags</a> |
| (JSON)</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_serviceTags.html">serviceTags</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| PUT /tags/importservicetags |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "serviceName" : "...", |
| "tagUpdateTime" : 12345, |
| "resourceToTagIds" : { |
| "property1" : [ 12345, 12345 ], |
| "property2" : [ 12345, 12345 ] |
| }, |
| "tagDefinitions" : { |
| "property1" : { |
| "name" : "...", |
| "source" : "...", |
| "attributeDefs" : [ { |
| "name" : "...", |
| "type" : "..." |
| }, { |
| "name" : "...", |
| "type" : "..." |
| } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, |
| "property2" : { |
| "name" : "...", |
| "source" : "...", |
| "attributeDefs" : [ { |
| "name" : "...", |
| "type" : "..." |
| }, { |
| "name" : "...", |
| "type" : "..." |
| } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| }, |
| "isDelta" : true, |
| "tags" : { |
| "property1" : { |
| "validityPeriods" : [ { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "...", |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "owner" : 12345, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, |
| "property2" : { |
| "validityPeriods" : [ { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "...", |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "owner" : 12345, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| }, |
| "tagsChangeExtent" : "NONE", |
| "serviceResources" : [ { |
| "resourceElements" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "additionalInfo" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "ownerUser" : "...", |
| "serviceName" : "...", |
| "resourceSignature" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, { |
| "resourceElements" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "additionalInfo" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "ownerUser" : "...", |
| "serviceName" : "...", |
| "resourceSignature" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } ], |
| "op" : "...", |
| "tagVersion" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_getAllServiceResources_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/tags/resources <a href="../tags/resources" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference">array of <a href="json_RangerServiceResource.html">RangerServiceResource</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference">list of <a href="xml_ns0_rangerServiceResource.html">rangerServiceResource</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /tags/resources |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "resourceElements" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "additionalInfo" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "ownerUser" : "...", |
| "serviceName" : "...", |
| "resourceSignature" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } ] |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_createServiceResource_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/tags/resources <a href="../tags/resources" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">updateIfExists</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">true</span></td> |
| <td><span class="parameter-constraints">boolean</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_RangerServiceResource.html">RangerServiceResource</a> |
| (JSON)</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerServiceResource.html">rangerServiceResource</a> |
| (XML)</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_RangerServiceResource.html">RangerServiceResource</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerServiceResource.html">rangerServiceResource</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| POST /tags/resources |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "resourceElements" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "additionalInfo" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "ownerUser" : "...", |
| "serviceName" : "...", |
| "resourceSignature" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 201 Created |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "resourceElements" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "additionalInfo" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "ownerUser" : "...", |
| "serviceName" : "...", |
| "resourceSignature" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_getAllTagDefs_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/tags/tagdefs <a href="../tags/tagdefs" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference">array of <a href="json_RangerTagDef.html">RangerTagDef</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference">list of <a href="xml_ns0_rangerTagDef.html">rangerTagDef</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /tags/tagdefs |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "name" : "...", |
| "source" : "...", |
| "attributeDefs" : [ { |
| "name" : "...", |
| "type" : "..." |
| }, { |
| "name" : "...", |
| "type" : "..." |
| } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } ] |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_createTagDef_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/tags/tagdefs <a href="../tags/tagdefs" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">updateIfExists</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">true</span></td> |
| <td><span class="parameter-constraints">boolean</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_RangerTagDef.html">RangerTagDef</a> |
| (JSON)</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerTagDef.html">rangerTagDef</a> |
| (XML)</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_RangerTagDef.html">RangerTagDef</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerTagDef.html">rangerTagDef</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| POST /tags/tagdefs |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "name" : "...", |
| "source" : "...", |
| "attributeDefs" : [ { |
| "name" : "...", |
| "type" : "..." |
| }, { |
| "name" : "...", |
| "type" : "..." |
| } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 201 Created |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "name" : "...", |
| "source" : "...", |
| "attributeDefs" : [ { |
| "name" : "...", |
| "type" : "..." |
| }, { |
| "name" : "...", |
| "type" : "..." |
| } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_deleteTagResourceMap_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/tags/tagresourcemaps <a href="../tags/tagresourcemaps" 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">resource-guid</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">tag-guid</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| DELETE /tags/tagresourcemaps |
| Content-Type: */* |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_getAllTagResourceMaps_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/tags/tagresourcemaps <a href="../tags/tagresourcemaps" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference">array of <a href="json_RangerTagResourceMap.html">RangerTagResourceMap</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference">list of <a href="xml_ns0_rangerTagResourceMap.html">rangerTagResourceMap</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /tags/tagresourcemaps |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "tagId" : 12345, |
| "resourceId" : 12345, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } ] |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_createTagResourceMap_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/tags/tagresourcemaps <a href="../tags/tagresourcemaps" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">lenient</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">false</span></td> |
| <td><span class="parameter-constraints">boolean</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">resource-guid</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">tag-guid</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| </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_RangerTagResourceMap.html">RangerTagResourceMap</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerTagResourceMap.html">rangerTagResourceMap</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| POST /tags/tagresourcemaps |
| Content-Type: */* |
| Accept: application/json |
| |
| <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 |
| |
| <code class="prettyprint language-js"> |
| { |
| "tagId" : 12345, |
| "resourceId" : 12345, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_getAllTags_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/tags/tags <a href="../tags/tags" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference">array of <a href="json_RangerTag.html">RangerTag</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference">list of <a href="xml_ns0_rangerTag.html">rangerTag</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /tags/tags |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "validityPeriods" : [ { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "...", |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "owner" : 12345, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } ] |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_createTag_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/tags/tags <a href="../tags/tags" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">updateIfExists</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">true</span></td> |
| <td><span class="parameter-constraints">boolean</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_RangerTag.html">RangerTag</a> |
| (JSON)</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerTag.html">rangerTag</a> |
| (XML)</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_RangerTag.html">RangerTag</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerTag.html">rangerTag</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| POST /tags/tags |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "validityPeriods" : [ { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "...", |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "owner" : 12345, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 201 Created |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "validityPeriods" : [ { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "...", |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "owner" : 12345, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_getTagTypes_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/tags/types <a href="../tags/types" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference">array of string |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference">list of string |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /tags/types |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_getServiceTagsIfUpdated_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/tags/download/{serviceName} <a href="../tags/download/{serviceName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">serviceName</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">lastActivationTime</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">0</span></td> |
| <td><span class="parameter-constraints">long</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">lastKnownVersion</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| <td><span class="parameter-constraints">long</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">pluginCapabilities</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value"></span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">pluginId</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">supportsTagDeltas</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">false</span></td> |
| <td><span class="parameter-constraints">boolean</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_ServiceTags.html">ServiceTags</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_serviceTags.html">serviceTags</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /tags/download/{serviceName} |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "serviceName" : "...", |
| "tagUpdateTime" : 12345, |
| "resourceToTagIds" : { |
| "property1" : [ 12345, 12345 ], |
| "property2" : [ 12345, 12345 ] |
| }, |
| "tagDefinitions" : { |
| "property1" : { |
| "name" : "...", |
| "source" : "...", |
| "attributeDefs" : [ { |
| "name" : "...", |
| "type" : "..." |
| }, { |
| "name" : "...", |
| "type" : "..." |
| } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, |
| "property2" : { |
| "name" : "...", |
| "source" : "...", |
| "attributeDefs" : [ { |
| "name" : "...", |
| "type" : "..." |
| }, { |
| "name" : "...", |
| "type" : "..." |
| } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| }, |
| "isDelta" : true, |
| "tags" : { |
| "property1" : { |
| "validityPeriods" : [ { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "...", |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "owner" : 12345, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, |
| "property2" : { |
| "validityPeriods" : [ { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "...", |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "owner" : 12345, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| }, |
| "tagsChangeExtent" : "SERVICE_RESOURCE", |
| "serviceResources" : [ { |
| "resourceElements" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "additionalInfo" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "ownerUser" : "...", |
| "serviceName" : "...", |
| "resourceSignature" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, { |
| "resourceElements" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "additionalInfo" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "ownerUser" : "...", |
| "serviceName" : "...", |
| "resourceSignature" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } ], |
| "op" : "...", |
| "tagVersion" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_deleteServiceResource_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/tags/resource/{id} <a href="../tags/resource/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">id</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints">long</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 /tags/resource/{id} |
| Content-Type: */* |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_getServiceResource_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/tags/resource/{id} <a href="../tags/resource/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">id</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints">long</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_RangerServiceResource.html">RangerServiceResource</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerServiceResource.html">rangerServiceResource</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /tags/resource/{id} |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "resourceElements" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "additionalInfo" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "ownerUser" : "...", |
| "serviceName" : "...", |
| "resourceSignature" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_updateServiceResource_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/tags/resource/{id} <a href="../tags/resource/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">id</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints">long</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_RangerServiceResource.html">RangerServiceResource</a> |
| (JSON)</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerServiceResource.html">rangerServiceResource</a> |
| (XML)</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_RangerServiceResource.html">RangerServiceResource</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerServiceResource.html">rangerServiceResource</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| PUT /tags/resource/{id} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "resourceElements" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "additionalInfo" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "ownerUser" : "...", |
| "serviceName" : "...", |
| "resourceSignature" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "resourceElements" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "additionalInfo" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "ownerUser" : "...", |
| "serviceName" : "...", |
| "resourceSignature" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_deleteTagDeltas_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/tags/server/tagdeltas <a href="../tags/server/tagdeltas" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">days</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">3</span></td> |
| <td><span class="parameter-constraints">int</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 /tags/server/tagdeltas |
| Content-Type: */* |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_deleteTag_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/tags/tag/{id} <a href="../tags/tag/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">id</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints">long</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 /tags/tag/{id} |
| Content-Type: */* |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_getTag_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/tags/tag/{id} <a href="../tags/tag/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">id</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints">long</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_RangerTag.html">RangerTag</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerTag.html">rangerTag</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /tags/tag/{id} |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "validityPeriods" : [ { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "...", |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "owner" : 12345, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_updateTag_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/tags/tag/{id} <a href="../tags/tag/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">id</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints">long</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_RangerTag.html">RangerTag</a> |
| (JSON)</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerTag.html">rangerTag</a> |
| (XML)</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_RangerTag.html">RangerTag</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerTag.html">rangerTag</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| PUT /tags/tag/{id} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "validityPeriods" : [ { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "...", |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "owner" : 12345, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "validityPeriods" : [ { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "...", |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "owner" : 12345, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_deleteTagDef_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/tags/tagdef/{id} <a href="../tags/tagdef/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">id</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints">long</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 /tags/tagdef/{id} |
| Content-Type: */* |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_getTagDef_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/tags/tagdef/{id} <a href="../tags/tagdef/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">id</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints">long</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_RangerTagDef.html">RangerTagDef</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerTagDef.html">rangerTagDef</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /tags/tagdef/{id} |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "name" : "...", |
| "source" : "...", |
| "attributeDefs" : [ { |
| "name" : "...", |
| "type" : "..." |
| }, { |
| "name" : "...", |
| "type" : "..." |
| } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_updateTagDef_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/tags/tagdef/{id} <a href="../tags/tagdef/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">id</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints">long</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_RangerTagDef.html">RangerTagDef</a> |
| (JSON)</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerTagDef.html">rangerTagDef</a> |
| (XML)</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_RangerTagDef.html">RangerTagDef</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerTagDef.html">rangerTagDef</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| PUT /tags/tagdef/{id} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "name" : "...", |
| "source" : "...", |
| "attributeDefs" : [ { |
| "name" : "...", |
| "type" : "..." |
| }, { |
| "name" : "...", |
| "type" : "..." |
| } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "name" : "...", |
| "source" : "...", |
| "attributeDefs" : [ { |
| "name" : "...", |
| "type" : "..." |
| }, { |
| "name" : "...", |
| "type" : "..." |
| } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_getTagResourceMap_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/tags/tagresourcemap/tag-resource-guid <a href="../tags/tagresourcemap/tag-resource-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">resourceGuid</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">tagGuid</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_RangerTagResourceMap.html">RangerTagResourceMap</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerTagResourceMap.html">rangerTagResourceMap</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /tags/tagresourcemap/tag-resource-guid |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "tagId" : 12345, |
| "resourceId" : 12345, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_deleteTagResourceMap_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/tags/tagresourcemap/{id} <a href="../tags/tagresourcemap/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">id</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints">long</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 /tags/tagresourcemap/{id} |
| Content-Type: */* |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_getTagResourceMap_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/tags/tagresourcemap/{id} <a href="../tags/tagresourcemap/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">id</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints">long</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_RangerTagResourceMap.html">RangerTagResourceMap</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerTagResourceMap.html">rangerTagResourceMap</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /tags/tagresourcemap/{id} |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "tagId" : 12345, |
| "resourceId" : 12345, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_deleteServiceResourceByGuid_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/tags/resource/guid/{guid} <a href="../tags/resource/guid/{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> |
| <th>default</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">guid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">deleteReferences</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">false</span></td> |
| <td><span class="parameter-constraints">boolean</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| DELETE /tags/resource/guid/{guid} |
| Content-Type: */* |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_getServiceResourceByGuid_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/tags/resource/guid/{guid} <a href="../tags/resource/guid/{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"></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_RangerServiceResource.html">RangerServiceResource</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerServiceResource.html">rangerServiceResource</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /tags/resource/guid/{guid} |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "resourceElements" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "additionalInfo" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "ownerUser" : "...", |
| "serviceName" : "...", |
| "resourceSignature" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_updateServiceResourceByGuid_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/tags/resource/guid/{guid} <a href="../tags/resource/guid/{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"></span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_RangerServiceResource.html">RangerServiceResource</a> |
| (JSON)</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerServiceResource.html">rangerServiceResource</a> |
| (XML)</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_RangerServiceResource.html">RangerServiceResource</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerServiceResource.html">rangerServiceResource</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| PUT /tags/resource/guid/{guid} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "resourceElements" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "additionalInfo" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "ownerUser" : "...", |
| "serviceName" : "...", |
| "resourceSignature" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "resourceElements" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "additionalInfo" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "ownerUser" : "...", |
| "serviceName" : "...", |
| "resourceSignature" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_getServiceResourcesByService_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/tags/resources/service/{serviceName} <a href="../tags/resources/service/{serviceName}" 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">serviceName</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference">array of <a href="json_RangerServiceResource.html">RangerServiceResource</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference">list of <a href="xml_ns0_rangerServiceResource.html">rangerServiceResource</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /tags/resources/service/{serviceName} |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "resourceElements" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "additionalInfo" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "ownerUser" : "...", |
| "serviceName" : "...", |
| "resourceSignature" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } ] |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_getSecureServiceTagsIfUpdated_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/tags/secure/download/{serviceName} <a href="../tags/secure/download/{serviceName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| <th>constraints</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">serviceName</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">lastActivationTime</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">0</span></td> |
| <td><span class="parameter-constraints">long</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">lastKnownVersion</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| <td><span class="parameter-constraints">long</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">pluginCapabilities</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value"></span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">pluginId</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">supportsTagDeltas</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">false</span></td> |
| <td><span class="parameter-constraints">boolean</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_ServiceTags.html">ServiceTags</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_serviceTags.html">serviceTags</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /tags/secure/download/{serviceName} |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "serviceName" : "...", |
| "tagUpdateTime" : 12345, |
| "resourceToTagIds" : { |
| "property1" : [ 12345, 12345 ], |
| "property2" : [ 12345, 12345 ] |
| }, |
| "tagDefinitions" : { |
| "property1" : { |
| "name" : "...", |
| "source" : "...", |
| "attributeDefs" : [ { |
| "name" : "...", |
| "type" : "..." |
| }, { |
| "name" : "...", |
| "type" : "..." |
| } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, |
| "property2" : { |
| "name" : "...", |
| "source" : "...", |
| "attributeDefs" : [ { |
| "name" : "...", |
| "type" : "..." |
| }, { |
| "name" : "...", |
| "type" : "..." |
| } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| }, |
| "isDelta" : true, |
| "tags" : { |
| "property1" : { |
| "validityPeriods" : [ { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "...", |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "owner" : 12345, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, |
| "property2" : { |
| "validityPeriods" : [ { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "...", |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "owner" : 12345, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| }, |
| "tagsChangeExtent" : "TAGS", |
| "serviceResources" : [ { |
| "resourceElements" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "additionalInfo" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "ownerUser" : "...", |
| "serviceName" : "...", |
| "resourceSignature" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, { |
| "resourceElements" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "additionalInfo" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "ownerUser" : "...", |
| "serviceName" : "...", |
| "resourceSignature" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } ], |
| "op" : "...", |
| "tagVersion" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_deleteTagByGuid_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/tags/tag/guid/{guid} <a href="../tags/tag/guid/{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"></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 /tags/tag/guid/{guid} |
| Content-Type: */* |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_getTagByGuid_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/tags/tag/guid/{guid} <a href="../tags/tag/guid/{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"></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_RangerTag.html">RangerTag</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerTag.html">rangerTag</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /tags/tag/guid/{guid} |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "validityPeriods" : [ { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "...", |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "owner" : 12345, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_updateTagByGuid_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/tags/tag/guid/{guid} <a href="../tags/tag/guid/{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"></span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_RangerTag.html">RangerTag</a> |
| (JSON)</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerTag.html">rangerTag</a> |
| (XML)</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_RangerTag.html">RangerTag</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerTag.html">rangerTag</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| PUT /tags/tag/guid/{guid} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "validityPeriods" : [ { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "...", |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "owner" : 12345, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "validityPeriods" : [ { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "...", |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "owner" : 12345, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_deleteTagDefByGuid_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/tags/tagdef/guid/{guid} <a href="../tags/tagdef/guid/{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"></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 /tags/tagdef/guid/{guid} |
| Content-Type: */* |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_getTagDefByGuid_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/tags/tagdef/guid/{guid} <a href="../tags/tagdef/guid/{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"></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_RangerTagDef.html">RangerTagDef</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerTagDef.html">rangerTagDef</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /tags/tagdef/guid/{guid} |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "name" : "...", |
| "source" : "...", |
| "attributeDefs" : [ { |
| "name" : "...", |
| "type" : "..." |
| }, { |
| "name" : "...", |
| "type" : "..." |
| } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_getTagDefByName_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/tags/tagdef/name/{name} <a href="../tags/tagdef/name/{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"></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_RangerTagDef.html">RangerTagDef</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerTagDef.html">rangerTagDef</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /tags/tagdef/name/{name} |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "name" : "...", |
| "source" : "...", |
| "attributeDefs" : [ { |
| "name" : "...", |
| "type" : "..." |
| }, { |
| "name" : "...", |
| "type" : "..." |
| } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_deleteTagResourceMapByGuid_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/tags/tagresourcemap/guid/{guid} <a href="../tags/tagresourcemap/guid/{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"></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 /tags/tagresourcemap/guid/{guid} |
| Content-Type: */* |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_getTagResourceMapByGuid_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/tags/tagresourcemap/guid/{guid} <a href="../tags/tagresourcemap/guid/{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"></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_RangerTagResourceMap.html">RangerTagResourceMap</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerTagResourceMap.html">rangerTagResourceMap</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /tags/tagresourcemap/guid/{guid} |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "tagId" : 12345, |
| "resourceId" : 12345, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_getTagsByType_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/tags/tags/type/{type} <a href="../tags/tags/type/{type}" 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">type</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference">array of <a href="json_RangerTag.html">RangerTag</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference">list of <a href="xml_ns0_rangerTag.html">rangerTag</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /tags/tags/type/{type} |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "validityPeriods" : [ { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "...", |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "owner" : 12345, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } ] |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_TagREST_getServiceResourceByServiceAndResourceSignature_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/tags/resource/service/{serviceName}/signature/{resourceSignature} <a href="../tags/resource/service/{serviceName}/signature/{resourceSignature}" 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">resourceSignature</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">serviceName</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_RangerServiceResource.html">RangerServiceResource</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_rangerServiceResource.html">rangerServiceResource</a> |
| (XML)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /tags/resource/service/{serviceName}/signature/{resourceSignature} |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "resourceElements" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "additionalInfo" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "ownerUser" : "...", |
| "serviceName" : "...", |
| "resourceSignature" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </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> |
