/documentation/api/rest/ Recent content in REST on R Service Bus Hugo -- gohugo.io en-us /documentation/api/rest/rest.admin.catalog/ Mon, 01 Jan 0001 00:00:00 +0000 /documentation/api/rest/rest.admin.catalog/ <h1 id="admincatalog">/admin/catalog</h1> <ul> <li>Mount Point: <code>/rest/admin/catalog</code></li> </ul> <p>The following operations are supported in this resource:</p> <ul> <li>GET</li> </ul> <h2 id="get">GET</h2> <h3 id="parameters">Parameters</h3> <table> <thead> <tr> <th>name</th> <th>description</th> <th>type</th> <th>default</th> </tr> </thead> <tbody> <tr> <td>X-RSB-Application-Name</td> <td>(no documentation provided)</td> <td>header</td> <td></td> </tr> </tbody> </table> <h3 id="output-payload">Output Payload</h3> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><a href="../../rest-data#catalog">catalog (XML)</a></td> <td><ul><li><code>application/vnd.rsb+json</code></li><li><code>application/vnd.rsb+xml</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> /documentation/api/rest/rest.admin.catalog.catalogname.filename/ Mon, 01 Jan 0001 00:00:00 +0000 /documentation/api/rest/rest.admin.catalog.catalogname.filename/ <h1 id="admincatalogcatalognamefilename">/admin/catalog/{catalogName}/{fileName}</h1> <ul> <li>Mount Point: <code>/rest/admin/catalog/{catalogName}/{fileName}</code></li> </ul> <p>The following operations are supported in this resource:</p> <ul> <li>GET</li> <li>PUT</li> </ul> <h2 id="get">GET</h2> <h3 id="parameters">Parameters</h3> <table> <thead> <tr> <th>name</th> <th>description</th> <th>type</th> <th>default</th> </tr> </thead> <tbody> <tr> <td>catalogName</td> <td>(no documentation provided)</td> <td>path</td> <td></td> </tr> <tr> <td>fileName</td> <td>(no documentation provided)</td> <td>path</td> <td></td> </tr> <tr> <td>X-RSB-Application-Name</td> <td>(no documentation provided)</td> <td>header</td> <td></td> </tr> </tbody> </table> <h3 id="output-payload">Output Payload</h3> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>application/xml</code></li><li><code>*/*</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> <h2 id="put">PUT</h2> <h3 id="parameters-1">Parameters</h3> <table> <thead> <tr> <th>name</th> <th>description</th> <th>type</th> <th>default</th> </tr> </thead> <tbody> <tr> <td>catalogName</td> <td>(no documentation provided)</td> <td>path</td> <td></td> </tr> <tr> <td>fileName</td> <td>(no documentation provided)</td> <td>path</td> <td></td> </tr> <tr> <td>X-RSB-Application-Name</td> <td>(no documentation provided)</td> <td>header</td> <td></td> </tr> </tbody> </table> <h3 id="input-payload">Input Payload</h3> <table> <thead> <tr> <th>element</th> <th>consumeable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>text/plain</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> <h3 id="output-payload-1">Output Payload</h3> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>application/xml</code></li><li><code>*/*</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> /documentation/api/rest/rest.admin.system.configuration/ Mon, 01 Jan 0001 00:00:00 +0000 /documentation/api/rest/rest.admin.system.configuration/ <h1 id="adminsystemconfiguration">/admin/system/configuration</h1> <ul> <li>Mount Point: <code>/rest/admin/system/configuration</code></li> </ul> <p>The following operations are supported on this resource:</p> <ul> <li>GET</li> <li>PUT</li> </ul> <h2 id="get">GET</h2> <h3 id="output-payload">Output Payload</h3> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>application/json</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> <h2 id="put">PUT</h2> <h3 id="input-payload">Input Payload</h3> <table> <thead> <tr> <th>element</th> <th>consumeable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>application/json</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> <h3 id="output-payload-1">Output Payload</h3> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>*/*</code></li><li><code>application/xml</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> /documentation/api/rest/rest.admin.system.r_packages/ Mon, 01 Jan 0001 00:00:00 +0000 /documentation/api/rest/rest.admin.system.r_packages/ <h1 id="adminsystemr_packages">/admin/system/r_packages</h1> <ul> <li>Mount Point: <code>/rest/admin/system/r_packages</code></li> </ul> <p>The following operations are supported on this resource:</p> <ul> <li>POST</li> </ul> <h2 id="post">POST</h2> <h3 id="parameters">Parameters</h3> <table> <thead> <tr> <th>name</th> <th>description</th> <th>type</th> <th>default</th> </tr> </thead> <tbody> <tr> <td>rServiPoolUri</td> <td>(no documentation provided)</td> <td>query</td> <td></td> </tr> <tr> <td>sha1hexsum</td> <td>(no documentation provided)</td> <td>query</td> <td></td> </tr> <tr> <td>packageName</td> <td>(no documentation provided)</td> <td>query</td> <td></td> </tr> </tbody> </table> <h3 id="input-payload">Input Payload</h3> <table> <thead> <tr> <th>element</th> <th>consumeable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>application/gzip</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> /documentation/api/rest/rest.admin.system.restart/ Mon, 01 Jan 0001 00:00:00 +0000 /documentation/api/rest/rest.admin.system.restart/ <h1 id="adminsystemrestart">/admin/system/restart</h1> <ul> <li>Mount Point: <code>/rest/admin/system/restart</code></li> </ul> <p>The following operations are supported on this resource:</p> <ul> <li>POST</li> </ul> <h2 id="post">POST</h2> <h3 id="output-payload">Output Payload</h3> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>*/*</code></li><li><code>application/xml</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> /documentation/api/rest/rest.admin.system.rservi_pools/ Mon, 01 Jan 0001 00:00:00 +0000 /documentation/api/rest/rest.admin.system.rservi_pools/ <h1 id="adminsystemrservi_pools">/admin/system/rservi_pools</h1> <ul> <li>Mount Point: <code>/rest/admin/system/rservi_pools</code></li> </ul> <p>The following operations are supported on this resource:</p> <ul> <li>GET</li> </ul> <h2 id="get">GET</h2> <h3 id="output-payload">Output Payload</h3> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><a href="../../rest-data#rservipools">rServiPools (XML)</a></td> <td><ul><li><code>application/vnd.rsb+json</code></li><li><code>application/vnd.rsb+xml</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> /documentation/api/rest/rest.data/ Mon, 01 Jan 0001 00:00:00 +0000 /documentation/api/rest/rest.data/ <h1 id="data">/data</h1> <ul> <li>Mount Point: <code>/rest/data</code></li> </ul> <p>The following operations are supported on this resource:</p> <ul> <li>GET</li> </ul> <h2 id="get">GET</h2> <h3 id="output-payload">Output Payload</h3> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><a href="../../rest-data#directory">directory (XML)</a></td> <td><ul><li><code>application/xml</code></li><li><code>application/vnd.rsb+json</code></li><li><code>application/vnd.rsb+xml</code></li><li><code>application/json</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> /documentation/api/rest/rest.data.rootidb64extension/ Mon, 01 Jan 0001 00:00:00 +0000 /documentation/api/rest/rest.data.rootidb64extension/ <h1 id="datarootidb64extension">/data/{rootId}{b64extension}</h1> <ul> <li>Mount Point: <code>/rest/data/{rootId}{b64extension }</code></li> </ul> <p>The following operations are supported on this resource:</p> <ul> <li>GET</li> </ul> <h2 id="get">GET</h2> <h3 id="parameters">Parameters</h3> <table> <thead> <tr> <th>name</th> <th>description</th> <th>type</th> <th>default</th> </tr> </thead> <tbody> <tr> <td>rootId</td> <td>(no documentation provided)</td> <td>path</td> <td></td> </tr> <tr> <td>b64extension</td> <td>(no documentation provided)</td> <td>path</td> <td></td> </tr> </tbody> </table> <h3 id="output-payload">Output Payload</h3> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><a href="../../rest-data#directory">directory (XML)</a></td> <td><ul><li><code>application/xml</code></li><li><code>application/vnd.rsb+json</code></li><li><code>application/vnd.rsb+xml</code></li><li><code>application/json</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> /documentation/api/rest/rest.jobs/ Mon, 01 Jan 0001 00:00:00 +0000 /documentation/api/rest/rest.jobs/ <h1 id="jobs">/jobs</h1> <ul> <li>Mount Point: <code>/rest/jobs</code></li> </ul> <p>The following operations are supported on this resource:</p> <ul> <li>POST (JSON payload)</li> <li>POST (XML payload)</li> <li>POST (ZIP payload)</li> <li>POST (multi-part form)</li> </ul> <h2 id="post-json-payload">POST (JSON payload)</h2> <p>Handles a function call job with a XML payload.</p> <h3 id="input-payload">Input Payload</h3> <table> <thead> <tr> <th>element</th> <th>consumeable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>application/json</code></li></ul></td> <td>Argument passed to the function called on RServi.</td> </tr> </tbody> </table> <h3 id="output-payload">Output Payload</h3> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>application/vnd.rsb+json</code></li><li><code>application/vnd.rsb+xml</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> <h2 id="post-xml-payload">POST (XML payload)</h2> <p>Handles a function call job with a XML payload.</p> <h3 id="input-payload-1">Input Payload</h3> <table> <thead> <tr> <th>element</th> <th>consumeable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>application/xml</code></li></ul></td> <td>Argument passed to the function called on RServi.</td> </tr> </tbody> </table> <h3 id="output-payload-1">Output Payload</h3> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>application/vnd.rsb+json</code></li><li><code>application/vnd.rsb+xml</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> <h2 id="post-zip-payload">POST (ZIP payload)</h2> <p>Handles a function call job with a ZIP payload.</p> <h3 id="input-payload-2">Input Payload</h3> <table> <thead> <tr> <th>element</th> <th>consumeable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>application/x-zip-compressed</code></li><li><code>application/x-zip</code></li><li><code>application/zip</code></li></ul></td> <td>Input stream of the ZIP data.</td> </tr> </tbody> </table> <h3 id="output-payload-2">Output Payload</h3> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>application/vnd.rsb+json</code></li><li><code>application/vnd.rsb+xml</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> <h2 id="post-multi-part-form">POST (multi-part form)</h2> <p>Handles a multi-part form job upload.</p> <h3 id="input-payload-3">Input Payload</h3> <table> <thead> <tr> <th>element</th> <th>consumeable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>multipart/form-data</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> <h3 id="output-payload-3">Output Payload</h3> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>application/xml</code></li><li><code>application/json</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> /documentation/api/rest/rest.process/ Mon, 01 Jan 0001 00:00:00 +0000 /documentation/api/rest/rest.process/ <h1 id="process">/process</h1> <ul> <li>Mount Point: <code>/rest/process</code></li> </ul> <p>The following operations are supported on this resource:</p> <ul> <li>POST (JSON payload)</li> <li>POST (XML payload)</li> </ul> <h2 id="post-json-payload">POST (JSON payload)</h2> <p>Handles a function call job with a JSON payload.</p> <h3 id="input-payload">Input Payload</h3> <table> <thead> <tr> <th>element</th> <th>consumeable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>application/json</code></li></ul></td> <td>Argument passed to the function called on RServi.</td> </tr> </tbody> </table> <h3 id="output-payload">Output Payload</h3> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>application/json</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> <h2 id="post-xml-payload">POST (XML payload)</h2> <p>Handles a function call job with a XML payload.</p> <h3 id="input-payload-1">Input Payload</h3> <table> <thead> <tr> <th>element</th> <th>consumeable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>application/xml</code></li></ul></td> <td>Argument passed to the function called on RServi.</td> </tr> </tbody> </table> <h3 id="output-payload-1">Output Payload</h3> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>application/xml</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> /documentation/api/rest/rest.result.applicationname.resourcename/ Mon, 01 Jan 0001 00:00:00 +0000 /documentation/api/rest/rest.result.applicationname.resourcename/ <h1 id="resultapplicationnameresourcename">/result/{applicationName}/{resourceName}</h1> <ul> <li>Mount Point: <code>/rest/result/{applicationName}/{resourceName}</code></li> </ul> <p>The following operations are supported on this resource:</p> <ul> <li>GET</li> <li>HEAD</li> </ul> <h2 id="get">GET</h2> <p>Serves a single result file.</p> <h3 id="parameters">Parameters</h3> <table> <thead> <tr> <th>name</th> <th>description</th> <th>type</th> <th>default</th> </tr> </thead> <tbody> <tr> <td>applicationName</td> <td>(no documentation provided)</td> <td>path</td> <td></td> </tr> <tr> <td>resourceName</td> <td>(no documentation provided)</td> <td>path</td> <td></td> </tr> </tbody> </table> <h3 id="output-payload">Output Payload</h3> <h3 id="output-payload-1">Output Payload</h3> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>application/octet-stream</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> <h2 id="head">HEAD</h2> <p>Provides HTTP meta-information only for a single result file.</p> <h3 id="parameters-1">Parameters</h3> <table> <thead> <tr> <th>name</th> <th>description</th> <th>type</th> <th>default</th> </tr> </thead> <tbody> <tr> <td>applicationName</td> <td>(no documentation provided)</td> <td>path</td> <td></td> </tr> <tr> <td>resourceName</td> <td>(no documentation provided)</td> <td>path</td> <td></td> </tr> </tbody> </table> <h3 id="output-payload-2">Output Payload</h3> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>application/octet-stream</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> /documentation/api/rest/rest.results.applicationname/ Mon, 01 Jan 0001 00:00:00 +0000 /documentation/api/rest/rest.results.applicationname/ <h1 id="resultsapplicationname">/results/{applicationName}</h1> <ul> <li>Mount Point: <code>/rest/results/{applicationName}</code></li> </ul> <p>The following operations are supported on this resource:</p> <ul> <li>GET</li> </ul> <h2 id="get">GET</h2> <h3 id="parameters">Parameters</h3> <table> <thead> <tr> <th>name</th> <th>description</th> <th>type</th> <th>default</th> </tr> </thead> <tbody> <tr> <td>applicationName</td> <td>(no documentation provided)</td> <td>path</td> <td></td> </tr> </tbody> </table> <h3 id="output-payload">Output Payload</h3> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><a href="../../rest-data#results">results (XML)</a></td> <td><ul><li><code>application/vnd.rsb+json</code></li><li><code>application/vnd.rsb+xml</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> /documentation/api/rest/rest.results.applicationname.jobid/ Mon, 01 Jan 0001 00:00:00 +0000 /documentation/api/rest/rest.results.applicationname.jobid/ <h1 id="resultsapplicationnamejobid">/results/{applicationName}/{jobId}</h1> <ul> <li>Mount Point: <code>/rest/results/{applicationName}/{jobId}</code></li> </ul> <p>The following operations are supported on this resource:</p> <ul> <li>GET</li> <li>DELETE</li> </ul> <h2 id="get">GET</h2> <h3 id="parameters">Parameters</h3> <table> <thead> <tr> <th>name</th> <th>description</th> <th>type</th> <th>default</th> </tr> </thead> <tbody> <tr> <td>applicationName</td> <td>(no documentation provided)</td> <td>path</td> <td></td> </tr> <tr> <td>jobId</td> <td>(no documentation provided)</td> <td>path</td> <td></td> </tr> </tbody> </table> <h3 id="output-payload">Output Payload</h3> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><a href="../../rest-data#result">result (XML)</a></td> <td><ul><li><code>application/vnd.rsb+json</code></li><li><code>application/vnd.rsb+xml</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> <h2 id="delete">DELETE</h2> <h3 id="parameters-1">Parameters</h3> <table> <thead> <tr> <th>name</th> <th>description</th> <th>type</th> <th>default</th> </tr> </thead> <tbody> <tr> <td>applicationName</td> <td>(no documentation provided)</td> <td>path</td> <td></td> </tr> <tr> <td>jobId</td> <td>(no documentation provided)</td> <td>path</td> <td></td> </tr> </tbody> </table> <h3 id="output-payload-1">Output Payload</h3> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>application/vnd.rsb+json</code></li><li><code>application/vnd.rsb+xml</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> /documentation/api/rest/rest.system.health.check/ Mon, 01 Jan 0001 00:00:00 +0000 /documentation/api/rest/rest.system.health.check/ <h1 id="systemhealthcheck">/system/health/check</h1> <ul> <li>Mount Point: <code>/rest/system/health/check</code></li> </ul> <p>The following operations are supported on this resource:</p> <ul> <li>GET</li> </ul> <h2 id="get">GET</h2> <h3 id="output-payload">Output Payload</h3> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td>(custom)</td> <td><ul><li><code>text/plain</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table> /documentation/api/rest/rest.system.info/ Mon, 01 Jan 0001 00:00:00 +0000 /documentation/api/rest/rest.system.info/ <h1 id="systeminfo">/system/info</h1> <ul> <li>Mount Point: <code>/rest/system/info</code></li> </ul> <p>The following operations are supported on this resource:</p> <ul> <li>GET</li> </ul> <h2 id="get">GET</h2> <table> <thead> <tr> <th>element</th> <th>produceable content type(s)</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><a href="../../rest-data#nodeinformation">nodeInformation (XML)</a></td> <td><ul><li><code>application/vnd.rsb+json</code></li><li><code>application/vnd.rsb+xml</code></li></ul></td> <td>(no documentation provided)</td> </tr> </tbody> </table>