You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nlpcraft.apache.org by ar...@apache.org on 2020/12/01 01:47:04 UTC
[incubator-nlpcraft-website] branch master updated: WIP.
This is an automated email from the ASF dual-hosted git repository.
aradzinski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft-website.git
The following commit(s) were added to refs/heads/master by this push:
new b3ca06d WIP.
b3ca06d is described below
commit b3ca06d7cb9f15bc7c7dfbf701a4f049e1022139
Author: Aaron Radzinski <ar...@datalingvo.com>
AuthorDate: Mon Nov 30 17:36:36 2020 -0800
WIP.
---
_includes/quick-links.html | 2 +-
index.html | 2 +-
openapi.html | 8399 --------------------------------------------
using-rest.html | 4 +-
4 files changed, 4 insertions(+), 8403 deletions(-)
diff --git a/_includes/quick-links.html b/_includes/quick-links.html
index d52ec11..6758aae 100644
--- a/_includes/quick-links.html
+++ b/_includes/quick-links.html
@@ -23,7 +23,7 @@
<i class="fab fa-fw fa-java mr-2"></i><a target="_" href="/apis/latest/index.html">Javadoc</a>
</li>
<li>
- <i class="fas fa-fw fa-code mr-2"></i><a href="/openapi.html" target="openapi">REST API</a>
+ <i class="fas fa-fw fa-code mr-2"></i><a href="https://app.swaggerhub.com/apis-docs/Apache-NLPCraft/apache-nlpcraft/{{site.latest_version}}" target="swaggerhub">REST API</a>
</li>
<li>
<i class="fas fa-fw fa-download mr-2"></i><a href="/download.html">Download</a>
diff --git a/index.html b/index.html
index b3416f9..d4887c6 100644
--- a/index.html
+++ b/index.html
@@ -95,7 +95,7 @@ layout: default
<span class="txt">Latest </span>
<a target="_" href="https://javadoc.io/doc/org.apache.nlpcraft/nlpcraft"><img src="https://javadoc.io/badge/org.apache.nlpcraft/nlpcraft.svg" alt="Javadocs"></a>
</a>
- <a href="/openapi.html" target="openapi" style="margin-left: 20px">
+ <a href="https://app.swaggerhub.com/apis-docs/Apache-NLPCraft/apache-nlpcraft/{{site.latest_version}}" target="swaggerhub" style="margin-left: 20px">
<img alt="" class="quick-link-img" src="{{ 'images/swagger.png' | relative_url }}"><span class="txt">REST API</span>
</a>
</div>
diff --git a/openapi.html b/openapi.html
deleted file mode 100644
index 448a818..0000000
--- a/openapi.html
+++ /dev/null
@@ -1,8399 +0,0 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
-
-<!--
-==================\/\/\/\/\/\/\/\/\/==================
--->
-
-<!DOCTYPE html>
-<!--suppress HtmlUnknownAttribute -->
-<html lang="en">
-<head>
- <!-- Global site tag (gtag.js) - Google Analytics -->
- <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script>
- <script>
- window.dataLayer = window.dataLayer || [];
- function gtag(){dataLayer.push(arguments);}
- gtag('js', new Date());
-
- gtag('config', 'UA-180663034-1');
- </script>
-
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <meta name="viewport" content="width=device-width, initial-scale=1.0, shrink-to-fit=no">
- <meta name="description" content="An open source API to convert natural language into actions.">
- <meta name="author" content="NLPCraft.">
-
- <link rel="apple-touch-icon" sizes="144x144" href="/apple-touch-icon.png">
- <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
- <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
- <link rel="manifest" href="/site.webmanifest">
- <link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5">
-
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/api-html@1.1.6/themes/compact/assets/css/bundle.min.css">
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/api-html@1.1.6/themes/compact/assets/css/style.css">
-
- <style>:root {--color-base: #4298fc; --color-base-light: #4298fc; --color-text: #FFF;}</style>
- <title>Apache NLPCraft API (0.7.2)</title>
- <style>
- body {
- letter-spacing: 0.02em;
- font-family: "Helvetica Neue", Helvetica, sans-serif;
- color: #333;
- }
-
- header {
- background: url(/images/bg-main-box.jpg) bottom center no-repeat;
- }
-
- aside * {z-index: 2;}
- aside div {position: relative;}
- aside::before {
- content: ' ';
- display: block;
- position: fixed;
- left: 0;
- top: 0;
- width: 320px;
- height: 100vh;
- z-index: 1;
- opacity: 0.2;
- background-image: linear-gradient(to bottom, #aaa, rgba(0, 0, 0, 0.2)), url(https://cdn.jsdelivr.net/npm/api-html@1.1.6/themes/compact/assets/img/patterns/5.svg);
- background-position: 50% 0;
- background-size: 500px auto;
- }
- .main-loader {
- position: fixed;
- z-index: 9999;
- top: 0;
- left: 0;
- width: 100vw;
- height: 100vh;
- background: white;
- }
- .main-loader img {
- position: relative;
- width: 150px;
- top: calc(50% - 10px);
- left: calc(50% - 75px);
- }
- .search-result a > strong, .search-result a > span {display: inline-block;}
-
- @media all and (max-width: 1350px) and (min-width: 1050px) {
- aside::before { width: 300px; }
- }
-
- @media all and (max-width: 1050px) {
- aside::before { width: 0; }
- }
- </style>
-
- <style>
- aside .uk-nav .uk-parent > a::after {
- background-image: url('data:image/svg+xml;base64;utf8,PHN2ZyB3aWR0aD0iMTQiIGhlaWdodD0iMTQiIHZpZXdCb3g9IjAgMCAyNCAyNCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCBmaWxsPSIjRkZGIiBkPSJNMTIuNzI3MDAwNiwzLjY4NjYzNjc5IEMxMy4xMDYyMTk3LDMuMjg1MTI1NDMgMTMuMDg4MTQ4MiwyLjY1MjIxODQgMTIuNjg2NjM2OCwyLjI3Mjk5OTM3IEMxMi4yODUxMjU0LDEuODkzNzgwMzQgMTEuNjUyMjE4NCwxLjkxMTg1MTg1IDExLjI3Mjk5OTQsMi4zMTMzNjMyMSBMMi43NzI2ODg4NiwxMS4zMTMzNjMyIEMyLjQwODcxMDk5LDExLjY5ODczNzUgMi40MDg2ODY4LDEyLjMwMT [...]
- }
-
- aside .uk-nav .uk-parent.uk-open > a::after {
- background-image: url('data:image/svg+xml;base64;utf8,PHN2ZyB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIHZpZXdCb3g9IjAgMCAyNS45MyAyNS45MyIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCBmaWxsPSIjRkZGIiBkPSJNMjUuMzk3LDQuNTU0aC0yLjA0MmwtOS45NzQsMTIuNjQ0Yy0wLjEwMSwwLjEyNC0wLjI1NiwwLjE5Ny0wLjQxNiwwLjE5N2MtMC4xNjQsMC0wLjMxNS0wLjA3My0wLjQxOS0wLjE5N0wyLjU3NSw0LjU1NCAgICAgICAgSDAuNTMyYy0wLjIwNiwwLTAuMzkyLDAuMTE1LTAuNDc5LDAuMjk5Yy0wLjA5LDAuMTg0LTAuMDY0LDAuNDAzLDAuMDYsMC41NjFsMTIuNDM1LDE1Ljc2 [...]
- }
-
- aside .uk-nav .uk-nav-sub .uk-parent > a::after {
- background-image: url('data:image/svg+xml;base64;utf8,PHN2ZyB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIHZpZXdCb3g9IjAgMCAyNS45MyAyNS45MyIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCBmaWxsPSIjRkZGIiBkPSJNMjUuMzk3LDQuNTU0aC0yLjA0MmwtOS45NzQsMTIuNjQ0Yy0wLjEwMSwwLjEyNC0wLjI1NiwwLjE5Ny0wLjQxNiwwLjE5N2MtMC4xNjQsMC0wLjMxNS0wLjA3My0wLjQxOS0wLjE5N0wyLjU3NSw0LjU1NCAgICAgICAgSDAuNTMyYy0wLjIwNiwwLTAuMzkyLDAuMTE1LTAuNDc5LDAuMjk5Yy0wLjA5LDAuMTg0LTAuMDY0LDAuNDAzLDAuMDYsMC41NjFsMTIuNDM1LDE1Ljc2 [...]
- }
-
- div.search {
- color: #fff !important;
- }
-
- span.uk-icon {
- color: #fff !important;
- }
-
- input {
- color: #fff !important;
- }
-
- .uk-search-input::placeholder { /* Chrome, Firefox, Opera, Safari 10.1+ */
- color: #eee;
- opacity: 1; /* Firefox */
- }
-
- .uk-search-input::-ms-input-placeholder { /* Internet Explorer 10-11 */
- color: #eee;
- }
-
- .uk-search-input::-ms-input-placeholder { /* Microsoft Edge */
- color: #eee;
- }
- </style>
-</head>
-
-<!--
-==================\/\/\/\/\/\/\/\/\/==================
--->
-
-<body>
- <div class="main-loader">
- <img src="https://cdn.jsdelivr.net/npm/api-html@1.1.6/themes/compact/assets/img/loader.gif" />
- </div>
- <header>
- <!-- Left Hamburger menu, only visible in small devices -->
- <a class="btn-left-menu" uk-icon="menu"></a>
-
- <!-- Header links started -->
- <div class="links">
-
-
- </div>
- <!-- Header links ended -->
-
- <!-- Search started -->
- <div class="search">
- <!-- Search input form -->
- <form class="uk-search uk-search-default">
- <span class="uk-search-icon-flip" uk-search-icon></span>
- <input class="uk-search-input" type="search" placeholder="Search ...">
- </form>
-
- <!-- Search result started -->
- <div class="search-result"><div></div></div>
- <!-- Search result ended -->
- </div>
- <!-- Search ended -->
-
- <!-- Right side hamburger menu used, only visible in small screens -->
- <a class="btn-right-menu" style="color: #fff;" uk-icon="more-vertical"></a>
- <div uk-dropdown="mode: click; pos: bottom-right">
- <ul class="uk-nav uk-dropdown-nav main-menu-items"></ul>
- </div>
- </header>
-
- <!-- Left sidebar started -->
- <aside>
-
- <!-- Sidebar top section navigation started -->
- <div class="nav-top">
- <ul class="uk-nav-default uk-nav-parent-icon" uk-nav uk-scrollspy-nav="closest: li; scroll: false; offset: 80;">
- <!-- Multi-items left sidebar menu item -->
-
- <li class="uk-parent">
- <a>Authentication</a>
- <ul class="uk-nav-sub">
-
- <li>
- <a href="#signinpost-gGQk1"><span class="api-method api-method-post">post</span> Signs in and obtains new access token.</a>
- </li>
-
- <li>
- <a href="#signoutpost-ITW8o"><span class="api-method api-method-post">post</span> Signs out and releases access token.</a>
- </li>
-
- </ul>
- </li>
-
- <li class="uk-parent">
- <a>User</a>
- <ul class="uk-nav-sub">
-
- <li>
- <a href="#user-getpost-Bi8JE"><span class="api-method api-method-post">post</span> Gets current user information.</a>
- </li>
-
- <li>
- <a href="#user-allpost-eiPsw"><span class="api-method api-method-post">post</span> Gets all users.</a>
- </li>
-
- <li>
- <a href="#user-updatepost-rAkgf"><span class="api-method api-method-post">post</span> Updates regular user.</a>
- </li>
-
- <li>
- <a href="#user-deletepost-B4cL4"><span class="api-method api-method-post">post</span> Deletes user.</a>
- </li>
-
- <li>
- <a href="#user-adminpost-82M3T"><span class="api-method api-method-post">post</span> Updates user admin permissions.</a>
- </li>
-
- <li>
- <a href="#user-passwd-resetpost-5Tfuc"><span class="api-method api-method-post">post</span> Resets password for the user.</a>
- </li>
-
- <li>
- <a href="#user-addpost-0Whaz"><span class="api-method api-method-post">post</span> Adds new user.</a>
- </li>
-
- </ul>
- </li>
-
- <li class="uk-parent">
- <a>Company</a>
- <ul class="uk-nav-sub">
-
- <li>
- <a href="#company-getpost-urb8g"><span class="api-method api-method-post">post</span> Gets current user company information.</a>
- </li>
-
- <li>
- <a href="#company-addpost-ICtdN"><span class="api-method api-method-post">post</span> Adds new company.</a>
- </li>
-
- <li>
- <a href="#company-updatepost-yvd0g"><span class="api-method api-method-post">post</span> Updates company data.</a>
- </li>
-
- <li>
- <a href="#company-deletepost-ETfp1"><span class="api-method api-method-post">post</span> Deletes company.</a>
- </li>
-
- <li>
- <a href="#company-token-resetpost-j8zLx"><span class="api-method api-method-post">post</span> Resets company probe authentication token.</a>
- </li>
-
- </ul>
- </li>
-
- <li class="uk-parent">
- <a>Feedback</a>
- <ul class="uk-nav-sub">
-
- <li>
- <a href="#feedback-addpost-PeKOL"><span class="api-method api-method-post">post</span> Adds feedback.</a>
- </li>
-
- <li>
- <a href="#feedback-deletepost-hd2it"><span class="api-method api-method-post">post</span> Deletes feedback.</a>
- </li>
-
- <li>
- <a href="#feedback-allpost-xVhwK"><span class="api-method api-method-post">post</span> Gets feedback.</a>
- </li>
-
- </ul>
- </li>
-
- <li class="uk-parent">
- <a>Probe</a>
- <ul class="uk-nav-sub">
-
- <li>
- <a href="#probe-allpost-YocJO"><span class="api-method api-method-post">post</span> Gets all probes.</a>
- </li>
-
- </ul>
- </li>
-
- <li class="uk-parent">
- <a>Asking</a>
- <ul class="uk-nav-sub">
-
- <li>
- <a href="#clear-conversationpost-NOTIz"><span class="api-method api-method-post">post</span> Clears conversation STM.</a>
- </li>
-
- <li>
- <a href="#clear-dialogpost-ceth8"><span class="api-method api-method-post">post</span> Clears dialog flow.</a>
- </li>
-
- <li>
- <a href="#checkpost-lG213"><span class="api-method api-method-post">post</span> Gets status and result of submitted requests.</a>
- </li>
-
- <li>
- <a href="#cancelpost-FvCib"><span class="api-method api-method-post">post</span> Cancels a question.</a>
- </li>
-
- <li>
- <a href="#askpost-pJxZW"><span class="api-method api-method-post">post</span> Asks a question.</a>
- </li>
-
- <li>
- <a href="#ask-syncpost-Y4k6v"><span class="api-method api-method-post">post</span> Asks a question in synchronous mode.</a>
- </li>
-
- </ul>
- </li>
-
- <li class="uk-parent">
- <a>Tools</a>
- <ul class="uk-nav-sub">
-
- <li>
- <a href="#healthget-Oc3oL"><span class="api-method api-method-get">get</span> Health ping.</a>
- </li>
-
- <li>
- <a href="#model-sugsynpost-JjSHY"><span class="api-method api-method-post">post</span> Runs model synonym suggestion tool.</a>
- </li>
-
- </ul>
- </li>
-
- </ul>
- </div>
- <!-- Sidebar top section navigation ended -->
-
- <!-- -->
- </aside>
- <!-- Left sidebar ended -->
-
- <main>
- <!-- Tag name or apis chunk header name -->
- <h1 id="project-name"><a href="#project-name">Apache NLPCraft API (0.7.2)</a></h1>
- <p class="project-details">REST API for <a href="https://nlpcraft.apache.org">Apache NLPCraft</a> - an open source library for adding Natural Language Interface to any applications. For Data Model APIs see <a href="https://nlpcraft.apache.org/apis/latest/index.html">Javadoc</a> documentation.</p>
- <div class="encoding-type">
- <a class="encoding-type-name">openapi 2</a>
- <a class="encoding-type-file" href="https://raw.githubusercontent.com/apache/incubator-nlpcraft/master/openapi/nlpcraft_swagger.yml" title="https://raw.githubusercontent.com/apache/incubator-nlpcraft/master/openapi/nlpcraft_swagger.yml" target="_blank">Source url</a>
- </div>
- <hr class="api-divider uk-divider-icon" />
-
-
- <h2 style="margin-bottom: 40px;"><a href="#">Authentication</a></h2>
-
- <div class="path">
- <h3 id="signinpost-gGQk1"><a href="#signinpost-gGQk1">Signs in and obtains new access token.</a></h3>
- <p>Accepts user's email and password and returns a new access token that should be used in all subsequent API calls. An access token can expire or be invalidated on the server side and this call should be used to obtain it again in such cases.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/signin" uk-tooltip="Click to copy">/signin</span>
- <a class="api-path-try-btn" data-id="signinpost-gGQk1">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "email": "",
- "passwd": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>email</b>
- <i class="object-type">String</i>
-
- <i>Description: User sign in email.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>passwd</b>
- <i class="object-type">String</i>
-
- <i>Description: User password.</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "acsTok": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Temporary (session) access token that should be used for further REST calls</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/signin \
- --body '{"email":"","passwd":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/signin', {
- method: 'POST',
- body: {
- "email": "",
- "passwd": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/signin',
- body: {
- "email": "",
- "passwd": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/signin"
-
-headers = {
-
-}
-
-body = {
- "email": "",
- "passwd": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="signoutpost-ITW8o"><a href="#signoutpost-ITW8o">Signs out and releases access token.</a></h3>
- <p>Releases previously obtained access token. After this call given access token is no longer valid for authentication.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/signout" uk-tooltip="Click to copy">/signout</span>
- <a class="api-path-try-btn" data-id="signoutpost-ITW8o">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Previously obtained access token to release.</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/signout \
- --body '{"acsTok":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/signout', {
- method: 'POST',
- body: {
- "acsTok": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/signout',
- body: {
- "acsTok": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/signout"
-
-headers = {
-
-}
-
-body = {
- "acsTok": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
-
- <hr class="api-divider uk-divider-icon" />
-
- <h2 style="margin-bottom: 40px;"><a href="#">User</a></h2>
-
- <div class="path">
- <h3 id="user-getpost-Bi8JE"><a href="#user-getpost-Bi8JE">Gets current user information.</a></h3>
- <p>Gets current user information.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/user/get" uk-tooltip="Click to copy">/user/get</span>
- <a class="api-path-try-btn" data-id="user-getpost-Bi8JE">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "id": "",
- "usrExtId": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: ID of the user. Optional, caller user ID used by default. Getting information about other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: External 'on-behalf-of' ID of the user. Optional, caller user ID used by default. Getting information for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "id": "",
- "email": "",
- "usrExtId": "",
- "firstName": "",
- "lastName": "",
- "avatarUrl": "",
- "isAdmin": "",
- "properties": {}
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: User ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>email</b>
- <i class="object-type">String</i>
-
- <i>Description: User email</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: User external 'on-behalf-of' ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>firstName</b>
- <i class="object-type">String</i>
-
- <i>Description: User first or given name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>lastName</b>
- <i class="object-type">String</i>
-
- <i>Description: User last name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>avatarUrl</b>
- <i class="object-type">String</i>
-
- <i>Description: User avatar URL</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>isAdmin</b>
- <i class="object-type">Boolean</i>
-
- <i>Description: Whether or not user has Administrative privileges</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>properties</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/user/get \
- --body '{"acsTok":"","id":"","usrExtId":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/user/get', {
- method: 'POST',
- body: {
- "acsTok": "",
- "id": "",
- "usrExtId": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/user/get',
- body: {
- "acsTok": "",
- "id": "",
- "usrExtId": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/user/get"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "id": "",
- "usrExtId": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="user-allpost-eiPsw"><a href="#user-allpost-eiPsw">Gets all users.</a></h3>
- <p>Gets all users for the current user company. Administrative privileges required.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/user/all" uk-tooltip="Click to copy">/user/all</span>
- <a class="api-path-try-btn" data-id="user-allpost-eiPsw">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "users": {
- "id": "",
- "email": "",
- "usrExtId": "",
- "firstName": "",
- "lastName": "",
- "avatarUrl": "",
- "isAdmin": "",
- "properties": {}
- }
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>users</b>
- <i class="object-type">Array</i>
- </span>
-
- <ul>
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: User ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>email</b>
- <i class="object-type">String</i>
-
- <i>Description: User email</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: User external 'on-behalf-of' ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>firstName</b>
- <i class="object-type">String</i>
-
- <i>Description: User first or given name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>lastName</b>
- <i class="object-type">String</i>
-
- <i>Description: User last name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>avatarUrl</b>
- <i class="object-type">String</i>
-
- <i>Description: User avatar URL</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>isAdmin</b>
- <i class="object-type">Boolean</i>
-
- <i>Description: Whether or not user has Administrative privileges</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>properties</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
- </ul>
-
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/user/all \
- --body '{"acsTok":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/user/all', {
- method: 'POST',
- body: {
- "acsTok": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/user/all',
- body: {
- "acsTok": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/user/all"
-
-headers = {
-
-}
-
-body = {
- "acsTok": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="user-updatepost-rAkgf"><a href="#user-updatepost-rAkgf">Updates regular user.</a></h3>
- <p>Updates user with given ID or the current user with given parameters. Administrative privileges required for updating other user.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/user/update" uk-tooltip="Click to copy">/user/update</span>
- <a class="api-path-try-btn" data-id="user-updatepost-rAkgf">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "id": "",
- "firstName": "",
- "lastName": "",
- "avatarUrl": "",
- "properties": {}
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Optional ID of the user to update. Only administrators can provide this parameter. Current user ID is used by default.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>firstName</b>
- <i class="object-type">String</i>
-
- <i>Description: User first or given name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>lastName</b>
- <i class="object-type">String</i>
-
- <i>Description: User last name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>avatarUrl</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional user avatar URL</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>properties</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/user/update \
- --body '{"acsTok":"","id":"","firstName":"","lastName":"","avatarUrl":"","properties":{}}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/user/update', {
- method: 'POST',
- body: {
- "acsTok": "",
- "id": "",
- "firstName": "",
- "lastName": "",
- "avatarUrl": "",
- "properties": {}
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/user/update',
- body: {
- "acsTok": "",
- "id": "",
- "firstName": "",
- "lastName": "",
- "avatarUrl": "",
- "properties": {}
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/user/update"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "id": "",
- "firstName": "",
- "lastName": "",
- "avatarUrl": "",
- "properties": {}
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="user-deletepost-B4cL4"><a href="#user-deletepost-B4cL4">Deletes user.</a></h3>
- <p>Deletes user with given ID or the current user. Administrative privileges required for deleting other user.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/user/delete" uk-tooltip="Click to copy">/user/delete</span>
- <a class="api-path-try-btn" data-id="user-deletepost-B4cL4">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "id": "",
- "usrExtId": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Optional ID of the user to delete. Only administrators can provide this parameter. Current user ID is used by default. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: External 'on-behalf-of' ID of the user to delete. Optional, caller user ID used by default. Administrative privileges are required to delete other users from the same company. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/user/delete \
- --body '{"acsTok":"","id":"","usrExtId":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/user/delete', {
- method: 'POST',
- body: {
- "acsTok": "",
- "id": "",
- "usrExtId": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/user/delete',
- body: {
- "acsTok": "",
- "id": "",
- "usrExtId": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/user/delete"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "id": "",
- "usrExtId": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="user-adminpost-82M3T"><a href="#user-adminpost-82M3T">Updates user admin permissions.</a></h3>
- <p>Updates user's permissions with given ID or the current user. Administrative privileges required for this operation.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/user/admin" uk-tooltip="Click to copy">/user/admin</span>
- <a class="api-path-try-btn" data-id="user-adminpost-82M3T">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "id": "",
- "isAdmin": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Optional ID of the user to update - current user ID is used by default.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>isAdmin</b>
- <i class="object-type">Boolean</i>
-
- <i>Description: Administrative privileges flag to update to</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/user/admin \
- --body '{"acsTok":"","id":"","isAdmin":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/user/admin', {
- method: 'POST',
- body: {
- "acsTok": "",
- "id": "",
- "isAdmin": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/user/admin',
- body: {
- "acsTok": "",
- "id": "",
- "isAdmin": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/user/admin"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "id": "",
- "isAdmin": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="user-passwd-resetpost-5Tfuc"><a href="#user-passwd-resetpost-5Tfuc">Resets password for the user.</a></h3>
- <p>Resets the password for the user. Note that NLPCraft doesn't store password in reversible way and there is no way to retrieve the current password - user can only reset the password.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/user/passwd/reset" uk-tooltip="Click to copy">/user/passwd/reset</span>
- <a class="api-path-try-btn" data-id="user-passwd-resetpost-5Tfuc">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "id": "",
- "newPasswd": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Previously obtained access token to release.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Optional ID of the user to reset password. Only admins can provide this parameter. Current user ID is used by default.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>newPasswd</b>
- <i class="object-type">String</i>
-
- <i>Description: New user password</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/user/passwd/reset \
- --body '{"acsTok":"","id":"","newPasswd":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/user/passwd/reset', {
- method: 'POST',
- body: {
- "acsTok": "",
- "id": "",
- "newPasswd": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/user/passwd/reset',
- body: {
- "acsTok": "",
- "id": "",
- "newPasswd": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/user/passwd/reset"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "id": "",
- "newPasswd": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="user-addpost-0Whaz"><a href="#user-addpost-0Whaz">Adds new user.</a></h3>
- <p>Adds new user with given parameters to the company of the admin caller. Administrative privileges required.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/user/add" uk-tooltip="Click to copy">/user/add</span>
- <a class="api-path-try-btn" data-id="user-addpost-0Whaz">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "email": "",
- "passwd": "",
- "firstName": "",
- "lastName": "",
- "avatarUrl": "",
- "isAdmin": "",
- "properties": {},
- "usrExtId": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>email</b>
- <i class="object-type">String</i>
-
- <i>Description: User email</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>passwd</b>
- <i class="object-type">String</i>
-
- <i>Description: User password</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>firstName</b>
- <i class="object-type">String</i>
-
- <i>Description: User first or given name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>lastName</b>
- <i class="object-type">String</i>
-
- <i>Description: User last name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>avatarUrl</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional user avatar URL</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>isAdmin</b>
- <i class="object-type">Boolean</i>
-
- <i>Description: Admin flag</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>properties</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional user external 'on-behalf-of' ID. If this field defined, method tries to find and update existing user.</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "id": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: ID of the newly created user</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/user/add \
- --body '{"acsTok":"","email":"","passwd":"","firstName":"","lastName":"","avatarUrl":"","isAdmin":"","properties":{},"usrExtId":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/user/add', {
- method: 'POST',
- body: {
- "acsTok": "",
- "email": "",
- "passwd": "",
- "firstName": "",
- "lastName": "",
- "avatarUrl": "",
- "isAdmin": "",
- "properties": {},
- "usrExtId": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/user/add',
- body: {
- "acsTok": "",
- "email": "",
- "passwd": "",
- "firstName": "",
- "lastName": "",
- "avatarUrl": "",
- "isAdmin": "",
- "properties": {},
- "usrExtId": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/user/add"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "email": "",
- "passwd": "",
- "firstName": "",
- "lastName": "",
- "avatarUrl": "",
- "isAdmin": "",
- "properties": {},
- "usrExtId": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
-
- <hr class="api-divider uk-divider-icon" />
-
- <h2 style="margin-bottom: 40px;"><a href="#">Company</a></h2>
-
- <div class="path">
- <h3 id="company-getpost-urb8g"><a href="#company-getpost-urb8g">Gets current user company information.</a></h3>
- <p>Gets current user company information.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/company/get" uk-tooltip="Click to copy">/company/get</span>
- <a class="api-path-try-btn" data-id="company-getpost-urb8g">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "id": "",
- "name": "",
- "website": "",
- "country": "",
- "region": "",
- "city": "",
- "address": "",
- "postalCode": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Company ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>name</b>
- <i class="object-type">String</i>
-
- <i>Description: Company name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>website</b>
- <i class="object-type">String</i>
-
- <i>Description: Copmany website</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>country</b>
- <i class="object-type">String</i>
-
- <i>Description: Company country</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>region</b>
- <i class="object-type">String</i>
-
- <i>Description: Company region</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>city</b>
- <i class="object-type">String</i>
-
- <i>Description: Company city</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>address</b>
- <i class="object-type">String</i>
-
- <i>Description: Company address</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>postalCode</b>
- <i class="object-type">String</i>
-
- <i>Description: Company postal code</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/company/get \
- --body '{"acsTok":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/company/get', {
- method: 'POST',
- body: {
- "acsTok": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/company/get',
- body: {
- "acsTok": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/company/get"
-
-headers = {
-
-}
-
-body = {
- "acsTok": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="company-addpost-ICtdN"><a href="#company-addpost-ICtdN">Adds new company.</a></h3>
- <p>Adds new company with given parameters. Administrative privileges required.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/company/add" uk-tooltip="Click to copy">/company/add</span>
- <a class="api-path-try-btn" data-id="company-addpost-ICtdN">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "name": "",
- "website": "",
- "country": "",
- "region": "",
- "city": "",
- "address": "",
- "postalCode": "",
- "adminEmail": "",
- "adminPasswd": "",
- "adminFirstName": "",
- "adminLastName": "",
- "adminAvatarUrl": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>name</b>
- <i class="object-type">String</i>
-
- <i>Description: Company name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>website</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company website address</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>country</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company country</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>region</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company region</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>city</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company city</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>address</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company address</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>postalCode</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company postal code</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>adminEmail</b>
- <i class="object-type">String</i>
-
- <i>Description: Admin user email</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>adminPasswd</b>
- <i class="object-type">String</i>
-
- <i>Description: Admin user password</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>adminFirstName</b>
- <i class="object-type">String</i>
-
- <i>Description: Admin user first or given name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>adminLastName</b>
- <i class="object-type">String</i>
-
- <i>Description: Admin user last name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>adminAvatarUrl</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional admin user avatar URL</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "token": "",
- "adminId": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>token</b>
- <i class="object-type">String</i>
-
- <i>Description: Company probes authentication token</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>adminId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: ID of the newly created admin user</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/company/add \
- --body '{"acsTok":"","name":"","website":"","country":"","region":"","city":"","address":"","postalCode":"","adminEmail":"","adminPasswd":"","adminFirstName":"","adminLastName":"","adminAvatarUrl":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/company/add', {
- method: 'POST',
- body: {
- "acsTok": "",
- "name": "",
- "website": "",
- "country": "",
- "region": "",
- "city": "",
- "address": "",
- "postalCode": "",
- "adminEmail": "",
- "adminPasswd": "",
- "adminFirstName": "",
- "adminLastName": "",
- "adminAvatarUrl": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/company/add',
- body: {
- "acsTok": "",
- "name": "",
- "website": "",
- "country": "",
- "region": "",
- "city": "",
- "address": "",
- "postalCode": "",
- "adminEmail": "",
- "adminPasswd": "",
- "adminFirstName": "",
- "adminLastName": "",
- "adminAvatarUrl": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/company/add"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "name": "",
- "website": "",
- "country": "",
- "region": "",
- "city": "",
- "address": "",
- "postalCode": "",
- "adminEmail": "",
- "adminPasswd": "",
- "adminFirstName": "",
- "adminLastName": "",
- "adminAvatarUrl": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="company-updatepost-yvd0g"><a href="#company-updatepost-yvd0g">Updates company data.</a></h3>
- <p>Updates company data with given parameters. Administrative privileges required.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/company/update" uk-tooltip="Click to copy">/company/update</span>
- <a class="api-path-try-btn" data-id="company-updatepost-yvd0g">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "name": "",
- "website": "",
- "country": "",
- "region": "",
- "city": "",
- "address": "",
- "postalCode": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>name</b>
- <i class="object-type">String</i>
-
- <i>Description: Company name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>website</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company website address</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>country</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company country</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>region</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company region</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>city</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company city</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>address</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company address</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>postalCode</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company postal code</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/company/update \
- --body '{"acsTok":"","name":"","website":"","country":"","region":"","city":"","address":"","postalCode":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/company/update', {
- method: 'POST',
- body: {
- "acsTok": "",
- "name": "",
- "website": "",
- "country": "",
- "region": "",
- "city": "",
- "address": "",
- "postalCode": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/company/update',
- body: {
- "acsTok": "",
- "name": "",
- "website": "",
- "country": "",
- "region": "",
- "city": "",
- "address": "",
- "postalCode": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/company/update"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "name": "",
- "website": "",
- "country": "",
- "region": "",
- "city": "",
- "address": "",
- "postalCode": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="company-deletepost-ETfp1"><a href="#company-deletepost-ETfp1">Deletes company.</a></h3>
- <p>Deletes company. Administrative privileges required.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/company/delete" uk-tooltip="Click to copy">/company/delete</span>
- <a class="api-path-try-btn" data-id="company-deletepost-ETfp1">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/company/delete \
- --body '{"acsTok":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/company/delete', {
- method: 'POST',
- body: {
- "acsTok": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/company/delete',
- body: {
- "acsTok": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/company/delete"
-
-headers = {
-
-}
-
-body = {
- "acsTok": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="company-token-resetpost-j8zLx"><a href="#company-token-resetpost-j8zLx">Resets company probe authentication token.</a></h3>
- <p>Sets and returns new company probe authentication token. Administrative privileges required for resetting company token.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/company/token/reset" uk-tooltip="Click to copy">/company/token/reset</span>
- <a class="api-path-try-btn" data-id="company-token-resetpost-j8zLx">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "token": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>token</b>
- <i class="object-type">String</i>
-
- <i>Description: Newly reset company probes authentication token</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/company/token/reset \
- --body '{"acsTok":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/company/token/reset', {
- method: 'POST',
- body: {
- "acsTok": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/company/token/reset',
- body: {
- "acsTok": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/company/token/reset"
-
-headers = {
-
-}
-
-body = {
- "acsTok": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
-
- <hr class="api-divider uk-divider-icon" />
-
- <h2 style="margin-bottom: 40px;"><a href="#">Feedback</a></h2>
-
- <div class="path">
- <h3 id="feedback-addpost-PeKOL"><a href="#feedback-addpost-PeKOL">Adds feedback.</a></h3>
- <p>Adds feedback for processed user request.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/feedback/add" uk-tooltip="Click to copy">/feedback/add</span>
- <a class="api-path-try-btn" data-id="feedback-addpost-PeKOL">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqId": "",
- "score": "",
- "comment": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: User ID.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: External user ID. Note user with given ID will be created if missing</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>srvReqId</b>
- <i class="object-type">String</i>
-
- <i>Description: Server request ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>score</b>
- <i class="object-type">Number</i>
-
- <i>Description: Score. Valid range is between 0 and 1, inclusive</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>comment</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional feedback comment</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "id": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: ID of the newly created feedback record</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/feedback/add \
- --body '{"acsTok":"","usrId":"","usrExtId":"","srvReqId":"","score":"","comment":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/feedback/add', {
- method: 'POST',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqId": "",
- "score": "",
- "comment": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/feedback/add',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqId": "",
- "score": "",
- "comment": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/feedback/add"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqId": "",
- "score": "",
- "comment": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="feedback-deletepost-hd2it"><a href="#feedback-deletepost-hd2it">Deletes feedback.</a></h3>
- <p>Deletes feedback for given record ID. Administrative privileges required for deleting feedback from other users.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/feedback/delete" uk-tooltip="Click to copy">/feedback/delete</span>
- <a class="api-path-try-btn" data-id="feedback-deletepost-hd2it">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "id": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Feedback record ID to delete.</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/feedback/delete \
- --body '{"acsTok":"","id":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/feedback/delete', {
- method: 'POST',
- body: {
- "acsTok": "",
- "id": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/feedback/delete',
- body: {
- "acsTok": "",
- "id": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/feedback/delete"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "id": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="feedback-allpost-xVhwK"><a href="#feedback-allpost-xVhwK">Gets feedback.</a></h3>
- <p>Gets all request feedback records. Administrative privileges required for getting feedback from other users.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/feedback/all" uk-tooltip="Click to copy">/feedback/all</span>
- <a class="api-path-try-btn" data-id="feedback-allpost-xVhwK">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqId": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: ID of the user to get feedback records for. Optional, caller user ID used by default. Getting feedback for other users requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: External 'on-behalf-of' ID of the user to get feedback records for. Optional, caller user ID used by default. Getting feedback for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user. Note that if only external 'on-behalf-of' user ID is provided and such user doesn't yet exist in NLPCraft - it will be created with this ID.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>srvReqId</b>
- <i class="object-type">String</i>
-
- <i>Description: Server request ID</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "feedbacks": {
- "id": "",
- "srvReqId": "",
- "usrId": "",
- "score": "",
- "comment": "",
- "createTstamp": ""
- }
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>feedbacks</b>
- <i class="object-type">Array</i>
- </span>
-
- <ul>
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Feedback ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>srvReqId</b>
- <i class="object-type">String</i>
-
- <i>Description: Server request ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: User ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>score</b>
- <i class="object-type">Number</i>
-
- <i>Description: Feedback score</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>comment</b>
- <i class="object-type">String</i>
-
- <i>Description: Feedback comment</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>createTstamp</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Creation UTC/GMT timestamp of the request</i>
-
- </span>
- </li>
- </ul>
-
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/feedback/all \
- --body '{"acsTok":"","usrId":"","usrExtId":"","srvReqId":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/feedback/all', {
- method: 'POST',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqId": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/feedback/all',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqId": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/feedback/all"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqId": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
-
- <hr class="api-divider uk-divider-icon" />
-
- <h2 style="margin-bottom: 40px;"><a href="#">Probe</a></h2>
-
- <div class="path">
- <h3 id="probe-allpost-YocJO"><a href="#probe-allpost-YocJO">Gets all probes.</a></h3>
- <p>Gets metadata for all active (currently connected) probes. Administrative privileges required.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/probe/all" uk-tooltip="Click to copy">/probe/all</span>
- <a class="api-path-try-btn" data-id="probe-allpost-YocJO">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "probes": {
- "probeToken": "",
- "probeId": "",
- "probeGuid": "",
- "probeApiVersion": "",
- "probeApiDate": "",
- "osVersion": "",
- "osName": "",
- "osArch": "",
- "startTstamp": "",
- "tmzId": "",
- "tmzAbbr": "",
- "tmzName": "",
- "userName": "",
- "javaVersion": "",
- "javaVendor": "",
- "hostName": "",
- "hostAddr": "",
- "macAddr": "",
- "models": {
- "id": "",
- "name": "",
- "version": "",
- "enabledBuiltInTokens": []
- }
- }
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>probes</b>
- <i class="object-type">Array</i>
- </span>
-
- <ul>
- <li>
- <span>
- <b>probeToken</b>
- <i class="object-type">String</i>
-
- <i>Description: Probe token</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>probeId</b>
- <i class="object-type">String</i>
-
- <i>Description: Probe ID (user defined ID)</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>probeGuid</b>
- <i class="object-type">String</i>
-
- <i>Description: Probe GUID (globally unique internal ID)</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>probeApiVersion</b>
- <i class="object-type">String</i>
-
- <i>Description: Probe API version</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>probeApiDate</b>
- <i class="object-type">String</i>
-
- <i>Description: Probe API date</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>osVersion</b>
- <i class="object-type">String</i>
-
- <i>Description: OS version</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>osName</b>
- <i class="object-type">String</i>
-
- <i>Description: OS name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>osArch</b>
- <i class="object-type">String</i>
-
- <i>Description: OS architecture</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>startTstamp</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Start time in UTC.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>tmzId</b>
- <i class="object-type">String</i>
-
- <i>Description: Timezone ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>tmzAbbr</b>
- <i class="object-type">String</i>
-
- <i>Description: Timezone abbreviation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>tmzName</b>
- <i class="object-type">String</i>
-
- <i>Description: Timezone name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>userName</b>
- <i class="object-type">String</i>
-
- <i>Description: User name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>javaVersion</b>
- <i class="object-type">String</i>
-
- <i>Description: Java version</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>javaVendor</b>
- <i class="object-type">String</i>
-
- <i>Description: Java vendor</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>hostName</b>
- <i class="object-type">String</i>
-
- <i>Description: Host name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>hostAddr</b>
- <i class="object-type">String</i>
-
- <i>Description: Host address</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>macAddr</b>
- <i class="object-type">String</i>
-
- <i>Description: MAC address</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>models</b>
- <i class="object-type">Array</i>
- </span>
-
- <ul>
- <li>
- <span>
- <b>id</b>
- <i class="object-type">String</i>
-
- <i>Description: Model ID (unique, immutable ID)</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>name</b>
- <i class="object-type">String</i>
-
- <i>Description: Model name (descriptive name of this model)</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>version</b>
- <i class="object-type">String</i>
-
- <i>Description: Model version</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>enabledBuiltInTokens</b>
- <i class="object-type">Array</i>
- </span>
-
- <ul></ul>
-
- </li>
- </ul>
-
- </li>
- </ul>
-
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/probe/all \
- --body '{"acsTok":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/probe/all', {
- method: 'POST',
- body: {
- "acsTok": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/probe/all',
- body: {
- "acsTok": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/probe/all"
-
-headers = {
-
-}
-
-body = {
- "acsTok": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
-
- <hr class="api-divider uk-divider-icon" />
-
- <h2 style="margin-bottom: 40px;"><a href="#">Asking</a></h2>
-
- <div class="path">
- <h3 id="clear-conversationpost-NOTIz"><a href="#clear-conversationpost-NOTIz">Clears conversation STM.</a></h3>
- <p>Clears conversation for given user and data model. Essentially makes NLPCraft forget about previously stored sentences and the next request will be processed as if at the start of the new conversation.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/clear/conversation" uk-tooltip="Click to copy">/clear/conversation</span>
- <a class="api-path-try-btn" data-id="clear-conversationpost-NOTIz">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "mdlId": "",
- "usrId": "",
- "usrExtId": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>mdlId</b>
- <i class="object-type">String</i>
-
- <i>Description: Data model ID for which to clear conversation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: User ID for which to clear conversation. Optional, caller user ID used by default. Clearing conversation for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: External 'on-behalf-of' user ID for which to clear conversation. Optional, caller user ID used by default. Clearing conversation for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user. Note that if only external 'on-behalf-of' user ID is provided and such user doesn't yet exist in NLPCraft - it will be created with this ID.</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/clear/conversation \
- --body '{"acsTok":"","mdlId":"","usrId":"","usrExtId":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/clear/conversation', {
- method: 'POST',
- body: {
- "acsTok": "",
- "mdlId": "",
- "usrId": "",
- "usrExtId": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/clear/conversation',
- body: {
- "acsTok": "",
- "mdlId": "",
- "usrId": "",
- "usrExtId": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/clear/conversation"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "mdlId": "",
- "usrId": "",
- "usrExtId": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="clear-dialogpost-ceth8"><a href="#clear-dialogpost-ceth8">Clears dialog flow.</a></h3>
- <p>Clears dialog flow for given user and data model by forgetting all previously matched intents. It is an important operation for intents that use dialog flow in their matching logic.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/clear/dialog" uk-tooltip="Click to copy">/clear/dialog</span>
- <a class="api-path-try-btn" data-id="clear-dialogpost-ceth8">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "mdlId": "",
- "usrId": "",
- "usrExtId": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>mdlId</b>
- <i class="object-type">String</i>
-
- <i>Description: Data model ID for which to clear dialog flow</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: User ID for which to clear dialog flow. Optional, caller user ID used by default. Clearing dialog flow for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: External 'on-behalf-of' user ID for which to clear dialog flow. Optional, caller user ID used by default. Clearing dialog flow for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user. Note that if only external 'on-behalf-of' user ID is provided and such user doesn't yet exist in NLPCraft - it will be created with this ID.</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/clear/dialog \
- --body '{"acsTok":"","mdlId":"","usrId":"","usrExtId":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/clear/dialog', {
- method: 'POST',
- body: {
- "acsTok": "",
- "mdlId": "",
- "usrId": "",
- "usrExtId": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/clear/dialog',
- body: {
- "acsTok": "",
- "mdlId": "",
- "usrId": "",
- "usrExtId": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/clear/dialog"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "mdlId": "",
- "usrId": "",
- "usrExtId": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="checkpost-lG213"><a href="#checkpost-lG213">Gets status and result of submitted requests.</a></h3>
- <p>Gets the status and result (OK or failure) of the previously submitted requests. Request statuses returned sorted by their registration time, starting from newest.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/check" uk-tooltip="Click to copy">/check</span>
- <a class="api-path-try-btn" data-id="checkpost-lG213">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqIds": [],
- "maxRows": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: User ID for which to check the results. Optional, caller user ID used by default. Checking results for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: External 'on-behalf-of' user ID for which to check the results. Optional, caller user ID used by default. Checking results for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user. Note that if only external 'on-behalf-of' user ID is provided and such user doesn't yet exist in NLPCraft - it will be created with this ID.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>srvReqIds</b>
- <i class="object-type">Array</i>
- </span>
-
- <ul></ul>
-
- </li>
-
- <li>
- <span>
- <b>maxRows</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Optional maximum number of returned items - by default all items will be returned</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "states": {
- "srvReqId": "",
- "txt": "",
- "usrId": "",
- "intentId": "",
- "mdlId": "",
- "probeId": "",
- "status": "",
- "resType": "",
- "resBody": {},
- "error": "",
- "errorCode": "",
- "logHolder": {}
- }
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>states</b>
- <i class="object-type">Array</i>
- </span>
-
- <ul>
- <li>
- <span>
- <b>srvReqId</b>
- <i class="object-type">String</i>
-
- <i>Description: Server request ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>txt</b>
- <i class="object-type">String</i>
-
- <i>Description: Original request text</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: ID of the user that submitted the request</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>intentId</b>
- <i class="object-type">String</i>
-
- <i>Description: ID of the intent</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>mdlId</b>
- <i class="object-type">String</i>
-
- <i>Description: ID of the model</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>probeId</b>
- <i class="object-type">String</i>
-
- <i>Description: ID of the data probe</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Current status of this request (QRY_READY indicates that result - error or ok - is ready)</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>resType</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional result type if returned by model (provided only if status is QRY_READY and processing was not rejected or terminated due to an exception)</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>resBody</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
-
- <li>
- <span>
- <b>error</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional error if returned by model (provided only if status is QRY_READY and processing was rejected or terminated due to an exception)</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>errorCode</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Optional error code indicating a type of error. Only present of 'error' field is present. One of the following values: 1 - Rejection by the data model. 100 - Unexpected system error. 101 - Model's result is too big. 102 - Recoverable system error. 10001 - Too many unknown words. 10002 - Sentence is too complex (too many free words). 10003 - Too many suspicious or unrelated words. 10004 - Swear words found and are not allowed. 10005 - Sentence contains no nou [...]
-
- </span>
- </li>
-
- <li>
- <span>
- <b>logHolder</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
- </ul>
-
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/check \
- --body '{"acsTok":"","usrId":"","usrExtId":"","srvReqIds":[],"maxRows":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/check', {
- method: 'POST',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqIds": [],
- "maxRows": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/check',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqIds": [],
- "maxRows": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/check"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqIds": [],
- "maxRows": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="cancelpost-FvCib"><a href="#cancelpost-FvCib">Cancels a question.</a></h3>
- <p>Cancels the previously submitted sentence and removes its result, if any, from the server storage. Must be called when query result is no longer needed (i.e. downloaded by all client apps) to release the server memory. Note that query results will auto-expire on server after a certain period of time. Note also that even when the embedded probe is used the results are still stored on the server and have to be cancelled or otherwise will be timed out.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/cancel" uk-tooltip="Click to copy">/cancel</span>
- <a class="api-path-try-btn" data-id="cancelpost-FvCib">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqIds": []
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: ID of the user whose requests to cancel. Optional, caller user ID used by default. Cancelling requests for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: External 'on-behalf-of' ID of the user whose requests to cancel. Optional, caller user ID used by default. Cancelling requests for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user. Note that if only external 'on-behalf-of' user ID is provided and such user doesn't yet exist in NLPCraft - it will be created with this ID.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>srvReqIds</b>
- <i class="object-type">Array</i>
- </span>
-
- <ul></ul>
-
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/cancel \
- --body '{"acsTok":"","usrId":"","usrExtId":"","srvReqIds":[]}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/cancel', {
- method: 'POST',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqIds": []
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/cancel',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqIds": []
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/cancel"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqIds": []
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="askpost-pJxZW"><a href="#askpost-pJxZW">Asks a question.</a></h3>
- <p>Submits the sentence to be processed asynchronously. Use '/check' call to get status and result, and '/cancel' call to discard the result from the server storage without waiting for auto-expiration.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/ask" uk-tooltip="Click to copy">/ask</span>
- <a class="api-path-try-btn" data-id="askpost-pJxZW">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "txt": "",
- "mdlId": "",
- "data": {},
- "enableLog": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: ID of the user submitting the question. Optional, caller user ID used by default. Submitting questions for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: External 'on-behalf-of' ID of the user submitting the question. Optional, caller user ID used by default. Submitting questions for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user. Note that if only external 'on-behalf-of' user ID is provided and such user doesn't yet exist in NLPCraft - it will be created with this ID.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>txt</b>
- <i class="object-type">String</i>
-
- <i>Description: Text of the question</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>mdlId</b>
- <i class="object-type">String</i>
-
- <i>Description: Model ID.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>data</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
-
- <li>
- <span>
- <b>enableLog</b>
- <i class="object-type">Boolean</i>
-
- <i>Description: Flag to enable detailed processing log to be returned with the result</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "srvReqId": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>srvReqId</b>
- <i class="object-type">String</i>
-
- <i>Description: Server ID assigned to the new processing request</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/ask \
- --body '{"acsTok":"","usrId":"","usrExtId":"","txt":"","mdlId":"","data":{},"enableLog":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/ask', {
- method: 'POST',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "txt": "",
- "mdlId": "",
- "data": {},
- "enableLog": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/ask',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "txt": "",
- "mdlId": "",
- "data": {},
- "enableLog": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/ask"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "txt": "",
- "mdlId": "",
- "data": {},
- "enableLog": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="ask-syncpost-Y4k6v"><a href="#ask-syncpost-Y4k6v">Asks a question in synchronous mode.</a></h3>
- <p>Submits the sentence to be processed synchronously and returns the result immediately. This call will block until the result is ready or the waiting is timed out.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/ask/sync" uk-tooltip="Click to copy">/ask/sync</span>
- <a class="api-path-try-btn" data-id="ask-syncpost-Y4k6v">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "txt": "",
- "mdlId": "",
- "data": {},
- "enableLog": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: ID of the user submitting the question. Optional, caller user ID used by default. Submitting questions for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: External 'on-behalf-of' ID of the user submitting the question. Optional, caller user ID used by default. Submitting questions for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user. Note that if only external 'on-behalf-of' user ID is provided and such user doesn't yet exist in NLPCraft - it will be created with this ID.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>txt</b>
- <i class="object-type">String</i>
-
- <i>Description: Text of the question</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>mdlId</b>
- <i class="object-type">String</i>
-
- <i>Description: Model ID.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>data</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
-
- <li>
- <span>
- <b>enableLog</b>
- <i class="object-type">Boolean</i>
-
- <i>Description: Flag to enable detailed processing log to be returned with the result</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "state": {
- "srvReqId": "",
- "txt": "",
- "usrId": "",
- "intentId": "",
- "mdlId": "",
- "probeId": "",
- "status": "",
- "resType": "",
- "resBody": {},
- "error": "",
- "errorCode": "",
- "logHolder": {}
- }
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>state</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul>
- <li>
- <span>
- <b>srvReqId</b>
- <i class="object-type">String</i>
-
- <i>Description: Server request ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>txt</b>
- <i class="object-type">String</i>
-
- <i>Description: Original request text</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: ID of the user that submitted the request</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>intentId</b>
- <i class="object-type">String</i>
-
- <i>Description: ID of the intent</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>mdlId</b>
- <i class="object-type">String</i>
-
- <i>Description: ID of the model</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>probeId</b>
- <i class="object-type">String</i>
-
- <i>Description: ID of the data probe</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Current status of this request (QRY_READY indicates that result - error or ok - is ready)</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>resType</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional result type if returned by model (provided only if status is QRY_READY and processing was not rejected or terminated due to an exception)</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>resBody</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
-
- <li>
- <span>
- <b>error</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional error if returned by model (provided only if status is QRY_READY and processing was rejected or terminated due to an exception)</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>errorCode</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Optional error code indicating a type of error. Only present of 'error' field is present.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>logHolder</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
- </ul>
-
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/ask/sync \
- --body '{"acsTok":"","usrId":"","usrExtId":"","txt":"","mdlId":"","data":{},"enableLog":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/ask/sync', {
- method: 'POST',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "txt": "",
- "mdlId": "",
- "data": {},
- "enableLog": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/ask/sync',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "txt": "",
- "mdlId": "",
- "data": {},
- "enableLog": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/ask/sync"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "txt": "",
- "mdlId": "",
- "data": {},
- "enableLog": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
-
- <hr class="api-divider uk-divider-icon" />
-
- <h2 style="margin-bottom: 40px;"><a href="#">Tools</a></h2>
-
- <div class="path">
- <h3 id="healthget-Oc3oL"><a href="#healthget-Oc3oL">Health ping.</a></h3>
- <p>Pings server for HTTP 200 code.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-get uk-label">get</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/health" uk-tooltip="Click to copy">/health</span>
- <a class="api-path-try-btn" data-id="healthget-Oc3oL">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request GET \
- --url http://localhost:8081/api/v1/health</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/health', {
- method: 'GET',
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'GET',
- url: 'http://localhost:8081/api/v1/health',
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/health"
-
-headers = {
-
-}
-
-response = requests.GET(url, headers=headers)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="model-sugsynpost-JjSHY"><a href="#model-sugsynpost-JjSHY">Runs model synonym suggestion tool.</a></h3>
- <p>Runs model synonym suggestion tool that is based on BERT models and uses @NCIntentSample annotation. Administrative privileges required.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/model/sugsyn" uk-tooltip="Click to copy">/model/sugsyn</span>
- <a class="api-path-try-btn" data-id="model-sugsynpost-JjSHY">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "mdlId": "",
- "minScore": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>mdlId</b>
- <i class="object-type">String</i>
-
- <i>Description: ID of the model to run synonym suggestion on</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>minScore</b>
- <i class="object-type">Number</i>
-
- <i>Description: Minimal score to include into the result (from 0 to 1, default is 0)</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "result": {}
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>result</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/model/sugsyn \
- --body '{"acsTok":"","mdlId":"","minScore":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/model/sugsyn', {
- method: 'POST',
- body: {
- "acsTok": "",
- "mdlId": "",
- "minScore": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/model/sugsyn',
- body: {
- "acsTok": "",
- "mdlId": "",
- "minScore": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/model/sugsyn"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "mdlId": "",
- "minScore": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
-
- <hr class="api-divider uk-divider-icon" />
-
- </main>
-
- <style>.api-path-try-btn{display: none;}</style>
-
-
-
- <script>window.color = {base: '#4298fc', text: '#FFF'};</script>
- <script id="pathsObjectScript">window.pathsObject = {"auths":[],"rootUrl":"http://localhost:8081/api/v1","paths":[{"requests":[{"items":[{"name":"Payload body","description":"JSON request.","required":true,"modelExample":"{\n \"email\": \"\",\n \"passwd\": \"\"\n}"}],"title":"body"}],"responses":[{"name":"200","description":"Successful operation.","headers":[],"modelExample":"{\n \"status\": \"\",\n \"acsTok\": \"\"\n}"},{"name":"400","description":"Failed operation.","he [...]
- <script src="https://cdn.jsdelivr.net/npm/api-html@1.1.6/themes/compact/assets/js/bundle.min.js"></script>
- <script src="https://cdn.jsdelivr.net/npm/api-html@1.1.6/themes/compact/assets/js/scripts.js"></script>
- <script src="https://cdn.jsdelivr.net/npm/api-html@1.1.6/themes/compact/assets/js/single.api.js"></script>
- <script src="https://cdn.jsdelivr.net/npm/api-html@1.1.6/themes/compact/assets/js/popup.api.js" id="popupScript"></script>
-
-</body>
-</html>
diff --git a/using-rest.html b/using-rest.html
index 3d6a589..903e647 100644
--- a/using-rest.html
+++ b/using-rest.html
@@ -26,7 +26,7 @@ id: rest
<section>
<h2 class="section-title">TL;DR;</h2>
<p>
- View <a target="openapi" href="/openapi.html">Open API Specification</a> in a separate window. 👌
+ View <a target="swaggerhub" href="https://app.swaggerhub.com/apis-docs/Apache-NLPCraft/apache-nlpcraft/{{site.latest_version}}">Open API Specification</a> in a separate window. 👌
</p>
</section>
<section id="overview">
@@ -44,7 +44,7 @@ id: rest
</p>
<div class="bq info">
<p>
- If you downloaded ZIP archive the <a target="openapi" href="/openapi.html">REST API specification</a> is also available in
+ If you downloaded ZIP archive the <a target="swaggerhub" href="https://app.swaggerhub.com/apis-docs/Apache-NLPCraft/apache-nlpcraft/{{site.latest_version}}">REST API specification</a> is also available in
<code>openapi/nlpcraft_swagger.yml</code> file
or on <a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml">GitHub</a>.
</p>