mirror of
https://github.com/balzack/databag.git
synced 2025-02-12 03:29:16 +00:00
6783 lines
260 KiB
HTML
6783 lines
260 KiB
HTML
<!doctype html>
|
|
<html>
|
|
<head>
|
|
<title>DataBag</title>
|
|
<style type="text/css">
|
|
body {
|
|
font-family: Trebuchet MS, sans-serif;
|
|
font-size: 15px;
|
|
color: #444;
|
|
margin-right: 24px;
|
|
}
|
|
|
|
h1 {
|
|
font-size: 25px;
|
|
}
|
|
h2 {
|
|
font-size: 20px;
|
|
}
|
|
h3 {
|
|
font-size: 16px;
|
|
font-weight: bold;
|
|
}
|
|
hr {
|
|
height: 1px;
|
|
border: 0;
|
|
color: #ddd;
|
|
background-color: #ddd;
|
|
}
|
|
|
|
.app-desc {
|
|
clear: both;
|
|
margin-left: 20px;
|
|
}
|
|
.param-name {
|
|
width: 100%;
|
|
}
|
|
.license-info {
|
|
margin-left: 20px;
|
|
}
|
|
|
|
.license-url {
|
|
margin-left: 20px;
|
|
}
|
|
|
|
.model {
|
|
margin: 0 0 0px 20px;
|
|
}
|
|
|
|
.method {
|
|
margin-left: 20px;
|
|
}
|
|
|
|
.method-notes {
|
|
margin: 10px 0 20px 0;
|
|
font-size: 90%;
|
|
color: #555;
|
|
}
|
|
|
|
pre {
|
|
padding: 10px;
|
|
margin-bottom: 2px;
|
|
}
|
|
|
|
.http-method {
|
|
text-transform: uppercase;
|
|
}
|
|
|
|
pre.get {
|
|
background-color: #0f6ab4;
|
|
}
|
|
|
|
pre.post {
|
|
background-color: #10a54a;
|
|
}
|
|
|
|
pre.put {
|
|
background-color: #c5862b;
|
|
}
|
|
|
|
pre.delete {
|
|
background-color: #a41e22;
|
|
}
|
|
|
|
.huge {
|
|
color: #fff;
|
|
}
|
|
|
|
pre.example {
|
|
background-color: #f3f3f3;
|
|
padding: 10px;
|
|
border: 1px solid #ddd;
|
|
}
|
|
|
|
code {
|
|
white-space: pre;
|
|
}
|
|
|
|
.nickname {
|
|
font-weight: bold;
|
|
}
|
|
|
|
.method-path {
|
|
font-size: 1.5em;
|
|
background-color: #0f6ab4;
|
|
}
|
|
|
|
.up {
|
|
float:right;
|
|
}
|
|
|
|
.parameter {
|
|
width: 500px;
|
|
}
|
|
|
|
.param {
|
|
width: 500px;
|
|
padding: 10px 0 0 20px;
|
|
font-weight: bold;
|
|
}
|
|
|
|
.param-desc {
|
|
width: 700px;
|
|
padding: 0 0 0 20px;
|
|
color: #777;
|
|
}
|
|
|
|
.param-type {
|
|
font-style: italic;
|
|
}
|
|
|
|
.param-enum-header {
|
|
width: 700px;
|
|
padding: 0 0 0 60px;
|
|
color: #777;
|
|
font-weight: bold;
|
|
}
|
|
|
|
.param-enum {
|
|
width: 700px;
|
|
padding: 0 0 0 80px;
|
|
color: #777;
|
|
font-style: italic;
|
|
}
|
|
|
|
.field-label {
|
|
padding: 0;
|
|
margin: 0;
|
|
clear: both;
|
|
}
|
|
|
|
.field-items {
|
|
padding: 0 0 15px 0;
|
|
margin-bottom: 15px;
|
|
}
|
|
|
|
.return-type {
|
|
clear: both;
|
|
padding-bottom: 10px;
|
|
}
|
|
|
|
.param-header {
|
|
font-weight: bold;
|
|
}
|
|
|
|
.method-tags {
|
|
text-align: right;
|
|
}
|
|
|
|
.method-tag {
|
|
background: none repeat scroll 0% 0% #24A600;
|
|
border-radius: 3px;
|
|
padding: 2px 10px;
|
|
margin: 2px;
|
|
color: #FFF;
|
|
display: inline-block;
|
|
text-decoration: none;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<h1>DataBag</h1>
|
|
<div class="app-desc">DataBag provides storage for decentralized identity based self-hosting apps.
|
|
It is intended to support sharing of personal data and hosting group
|
|
conversations.</div>
|
|
<div class="app-desc">More information: <a href="https://helloreverb.com">https://helloreverb.com</a></div>
|
|
<div class="app-desc">Contact Info: <a href="roland.osborne@gmail.com">roland.osborne@gmail.com</a></div>
|
|
<div class="app-desc">Version: 0.0.1</div>
|
|
|
|
<div class="license-info">Apache 2.0</div>
|
|
<div class="license-url">http://www.apache.org/licenses/LICENSE-2.0.html</div>
|
|
<h2>Access</h2>
|
|
<ol>
|
|
<li>HTTP Basic Authentication</li>
|
|
<li></li>
|
|
</ol>
|
|
|
|
<h2><a name="__Methods">Methods</a></h2>
|
|
[ Jump to <a href="#__Models">Models</a> ]
|
|
|
|
<h3>Table of Contents </h3>
|
|
<div class="method-summary"></div>
|
|
<h4><a href="#Account">Account</a></h4>
|
|
<ul>
|
|
<li><a href="#addAccount"><code><span class="http-method">post</span> /account/profile</code></a></li>
|
|
<li><a href="#addAccountApp"><code><span class="http-method">post</span> /account/apps</code></a></li>
|
|
<li><a href="#addAccountAuthentication"><code><span class="http-method">post</span> /account/auth</code></a></li>
|
|
<li><a href="#getAccountApps"><code><span class="http-method">get</span> /account/apps</code></a></li>
|
|
<li><a href="#getAccountImage"><code><span class="http-method">get</span> /account/profile/image</code></a></li>
|
|
<li><a href="#getAccountProfile"><code><span class="http-method">get</span> /account/profile</code></a></li>
|
|
<li><a href="#getAccountToken"><code><span class="http-method">get</span> /account/token</code></a></li>
|
|
<li><a href="#getAccountUsername"><code><span class="http-method">get</span> /account/claimable</code></a></li>
|
|
<li><a href="#removeAccountApp"><code><span class="http-method">delete</span> /account/apps/{appId}</code></a></li>
|
|
<li><a href="#setAccountApp"><code><span class="http-method">put</span> /account/apps</code></a></li>
|
|
<li><a href="#setAccountAuthentication"><code><span class="http-method">put</span> /account/auth</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Admin">Admin</a></h4>
|
|
<ul>
|
|
<li><a href="#addNodeAccount"><code><span class="http-method">post</span> /admin/accounts</code></a></li>
|
|
<li><a href="#getNodeAccountImage"><code><span class="http-method">get</span> /admin/accounts/{accountId}/image</code></a></li>
|
|
<li><a href="#getNodeAccounts"><code><span class="http-method">get</span> /admin/accounts</code></a></li>
|
|
<li><a href="#getNodeClaimable"><code><span class="http-method">get</span> /admin/claimable</code></a></li>
|
|
<li><a href="#removeNodeAccount"><code><span class="http-method">delete</span> /admin/accounts/{accountId}</code></a></li>
|
|
<li><a href="#setNodeAccount"><code><span class="http-method">put</span> /admin/accounts/{accountId}/reset</code></a></li>
|
|
<li><a href="#setNodeConfig"><code><span class="http-method">post</span> /admin/config</code></a></li>
|
|
<li><a href="#setNodeConfigDomain"><code><span class="http-method">put</span> /admin/config/domain</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Authenticate">Authenticate</a></h4>
|
|
<ul>
|
|
<li><a href="#authenticate"><code><span class="http-method">put</span> /authenticate</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Contact">Contact</a></h4>
|
|
<ul>
|
|
<li><a href="#addCard"><code><span class="http-method">post</span> /contact/cards</code></a></li>
|
|
<li><a href="#clearCardGroup"><code><span class="http-method">delete</span> /contact/cards/{cardId}/groups/{groupId}</code></a></li>
|
|
<li><a href="#clearCardNotes"><code><span class="http-method">delete</span> /contact/cards/{cardId}/notes</code></a></li>
|
|
<li><a href="#getCard"><code><span class="http-method">get</span> /contact/cards/{cardId}</code></a></li>
|
|
<li><a href="#getCardData"><code><span class="http-method">get</span> /contact/cards/{cardId}/data</code></a></li>
|
|
<li><a href="#getCardProfile"><code><span class="http-method">get</span> /contact/cards/{cardId}/profile</code></a></li>
|
|
<li><a href="#getCardProfileImage"><code><span class="http-method">get</span> /contact/cards/{cardId}/profile/image</code></a></li>
|
|
<li><a href="#getCardView"><code><span class="http-method">get</span> /contact/cards/view</code></a></li>
|
|
<li><a href="#getCloseMessage"><code><span class="http-method">get</span> /contact/cards/{cardId}/closeMessage</code></a></li>
|
|
<li><a href="#getOpenMessage"><code><span class="http-method">get</span> /contact/cards/{cardId}/openMessage</code></a></li>
|
|
<li><a href="#removeCard"><code><span class="http-method">delete</span> /contact/cards/{cardId}</code></a></li>
|
|
<li><a href="#setCardGroup"><code><span class="http-method">put</span> /contact/cards/{cardId}/groups/{groupId}</code></a></li>
|
|
<li><a href="#setCardNotes"><code><span class="http-method">put</span> /contact/cards/{cardId}/notes</code></a></li>
|
|
<li><a href="#setCardProfile"><code><span class="http-method">put</span> /contact/cards/{cardId}/profile</code></a></li>
|
|
<li><a href="#setCardStatus"><code><span class="http-method">put</span> /contact/cards/{cardId}/status</code></a></li>
|
|
<li><a href="#setCloseMessage"><code><span class="http-method">put</span> /contact/closeMessage</code></a></li>
|
|
<li><a href="#setContentRevision"><code><span class="http-method">put</span> /contact/content/revision</code></a></li>
|
|
<li><a href="#setOpenMessage"><code><span class="http-method">put</span> /contact/openMessage</code></a></li>
|
|
<li><a href="#setProfileRevision"><code><span class="http-method">put</span> /contact/profile/revision</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Content">Content</a></h4>
|
|
<ul>
|
|
<li><a href="#addArticle"><code><span class="http-method">post</span> /content/articles</code></a></li>
|
|
<li><a href="#addArticleAsset"><code><span class="http-method">post</span> /content/articles/{articleId}/assets</code></a></li>
|
|
<li><a href="#addArticleTag"><code><span class="http-method">post</span> /content/articles/{articleId}/tags</code></a></li>
|
|
<li><a href="#addLabel"><code><span class="http-method">post</span> /content/labels</code></a></li>
|
|
<li><a href="#clearArticleGroup"><code><span class="http-method">delete</span> /content/articles/{articleId}/groups/{groupId}</code></a></li>
|
|
<li><a href="#clearArticleLabel"><code><span class="http-method">delete</span> /content/articles/{articleId}/labels/{labelId}</code></a></li>
|
|
<li><a href="#clearLabelGroup"><code><span class="http-method">delete</span> /content/labels/{labelId}/groups/{groupId}</code></a></li>
|
|
<li><a href="#getArticle"><code><span class="http-method">get</span> /content/articles/{articleId}</code></a></li>
|
|
<li><a href="#getArticleAsset"><code><span class="http-method">get</span> /content/articles/{articleId}/assets/{assetId}</code></a></li>
|
|
<li><a href="#getArticleAssets"><code><span class="http-method">get</span> /content/articles/{articleId}/assets</code></a></li>
|
|
<li><a href="#getArticleBlockView"><code><span class="http-method">get</span> /content/articleBlocks/view</code></a></li>
|
|
<li><a href="#getArticleSubjectField"><code><span class="http-method">get</span> /content/articles/{articleId}/subject/{field}</code></a></li>
|
|
<li><a href="#getArticleTag"><code><span class="http-method">get</span> /content/articles/{articleId}/tags/{tagId}</code></a></li>
|
|
<li><a href="#getArticleTagBlockView"><code><span class="http-method">get</span> /content/articles/{articleId}/tagBlocks/view</code></a></li>
|
|
<li><a href="#getArticleTagSubjectField"><code><span class="http-method">get</span> /content/articles/{articleId}/tags/{tagId}/subject/{field}</code></a></li>
|
|
<li><a href="#getArticleTagView"><code><span class="http-method">get</span> /content/articles/{articleId}/tagBlocks/{blockId}/view</code></a></li>
|
|
<li><a href="#getArticleTags"><code><span class="http-method">get</span> /content/articles/{articleId}/tagBlocks/{blockId}</code></a></li>
|
|
<li><a href="#getArticleViews"><code><span class="http-method">get</span> /content/articleBlocks/{blockId}/view</code></a></li>
|
|
<li><a href="#getArticles"><code><span class="http-method">get</span> /content/articleBlocks/{blockId}</code></a></li>
|
|
<li><a href="#getLabels"><code><span class="http-method">get</span> /content/labels</code></a></li>
|
|
<li><a href="#removeArticle"><code><span class="http-method">delete</span> /content/articles/{articleId}</code></a></li>
|
|
<li><a href="#removeArticleAsset"><code><span class="http-method">delete</span> /content/articles/{articleId}/assets/{assetId}</code></a></li>
|
|
<li><a href="#removeArticleTag"><code><span class="http-method">delete</span> /content/articles/{articleId}/tags/{tagId}</code></a></li>
|
|
<li><a href="#removeLabel"><code><span class="http-method">delete</span> /content/labels/{labelId}</code></a></li>
|
|
<li><a href="#setArticleConfirmed"><code><span class="http-method">put</span> /content/articles/{articleId}/confirmed</code></a></li>
|
|
<li><a href="#setArticleGroup"><code><span class="http-method">post</span> /content/articles/{articleId}/groups/{groupId}</code></a></li>
|
|
<li><a href="#setArticleLabel"><code><span class="http-method">post</span> /content/articles/{articleId}/labels/{labelId}</code></a></li>
|
|
<li><a href="#setArticleSubject"><code><span class="http-method">put</span> /content/articles/{articleId}/subject</code></a></li>
|
|
<li><a href="#setLabelGroup"><code><span class="http-method">post</span> /content/labels/{labelId}/groups/{groupId}</code></a></li>
|
|
<li><a href="#updateLabel"><code><span class="http-method">put</span> /content/labels/{labelId}</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Conversation">Conversation</a></h4>
|
|
<ul>
|
|
<li><a href="#addDialogue"><code><span class="http-method">post</span> /conversation/dialogues</code></a></li>
|
|
<li><a href="#addDialogueInsight"><code><span class="http-method">put</span> /conversation/dialogues/{dialogueId}/cards/{cardId}</code></a></li>
|
|
<li><a href="#addDialogueTopic"><code><span class="http-method">post</span> /conversation/dialogues/{dialogueId}/topics</code></a></li>
|
|
<li><a href="#addInsightDialogue"><code><span class="http-method">post</span> /conversation/insights/{dialogueId}</code></a></li>
|
|
<li><a href="#addTopicAsset"><code><span class="http-method">post</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/assets</code></a></li>
|
|
<li><a href="#addTopicTag"><code><span class="http-method">post</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/tags</code></a></li>
|
|
<li><a href="#conversationDialoguesDialogueIdTopicsTopicIdConfirmedPut"><code><span class="http-method">put</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/confirmed</code></a></li>
|
|
<li><a href="#getDialogueTopic"><code><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topics/{topicId}</code></a></li>
|
|
<li><a href="#getDialogueTopicSubjectField"><code><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/subject/{field}</code></a></li>
|
|
<li><a href="#getDialogues"><code><span class="http-method">get</span> /conversation/dialogues</code></a></li>
|
|
<li><a href="#getInsights"><code><span class="http-method">get</span> /conversation/insights</code></a></li>
|
|
<li><a href="#getTopicAsset"><code><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/assets/{assetId}</code></a></li>
|
|
<li><a href="#getTopicAssets"><code><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/assets</code></a></li>
|
|
<li><a href="#getTopicBlock"><code><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topicBlocks/{blockId}</code></a></li>
|
|
<li><a href="#getTopicBlockView"><code><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topicBlocks/view</code></a></li>
|
|
<li><a href="#getTopicTag"><code><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/tags/{tagId}</code></a></li>
|
|
<li><a href="#getTopicTagBlockView"><code><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/tagBlocks/view</code></a></li>
|
|
<li><a href="#getTopicTagSubjectField"><code><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/tags/{tagId}/subject/{field}</code></a></li>
|
|
<li><a href="#getTopicTagView"><code><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/tagBlocks/{blockId}/view</code></a></li>
|
|
<li><a href="#getTopicTags"><code><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/tagBlocks/{blockId}</code></a></li>
|
|
<li><a href="#getTopicViews"><code><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topicBlocks/{blockId}/view</code></a></li>
|
|
<li><a href="#removeDialogue"><code><span class="http-method">delete</span> /conversation/dialogues/{dialogueId}</code></a></li>
|
|
<li><a href="#removeDialogueInsight"><code><span class="http-method">delete</span> /conversation/dialogues/{dialogueId}/cards/{cardId}</code></a></li>
|
|
<li><a href="#removeDialogueTopic"><code><span class="http-method">delete</span> /conversation/dialogues/{dialogueId}/topics/{topicId}</code></a></li>
|
|
<li><a href="#removeTopicAsset"><code><span class="http-method">delete</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/assets/{assetId}</code></a></li>
|
|
<li><a href="#removeTopicTag"><code><span class="http-method">delete</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/tags/{tagId}</code></a></li>
|
|
<li><a href="#setDialogueActive"><code><span class="http-method">put</span> /conversation/dialogues/{dialogueId}/active</code></a></li>
|
|
<li><a href="#setDialogueInsightStatus"><code><span class="http-method">put</span> /conversation/dialogues/{dialogueId}/status</code></a></li>
|
|
<li><a href="#setDialogueSubject"><code><span class="http-method">put</span> /conversation/dialogues/{dialogueId}/subject</code></a></li>
|
|
<li><a href="#setInsightDialogue"><code><span class="http-method">delete</span> /conversation/insights/{dialogueId}</code></a></li>
|
|
<li><a href="#setInsightStatus"><code><span class="http-method">put</span> /conversation/insights/{insightId}/status</code></a></li>
|
|
<li><a href="#setTopicSubject"><code><span class="http-method">put</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/subject</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Profile">Profile</a></h4>
|
|
<ul>
|
|
<li><a href="#getProfile"><code><span class="http-method">get</span> /profile</code></a></li>
|
|
<li><a href="#getProfileImage"><code><span class="http-method">get</span> /profile/image</code></a></li>
|
|
<li><a href="#getProfileMessage"><code><span class="http-method">get</span> /profile/message</code></a></li>
|
|
<li><a href="#setProfile"><code><span class="http-method">put</span> /profile</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Share">Share</a></h4>
|
|
<ul>
|
|
<li><a href="#addGroup"><code><span class="http-method">post</span> /share/groups</code></a></li>
|
|
<li><a href="#getGroups"><code><span class="http-method">get</span> /share/groups</code></a></li>
|
|
<li><a href="#removeGroup"><code><span class="http-method">delete</span> /share/groups/{groupId}</code></a></li>
|
|
<li><a href="#updateGroup"><code><span class="http-method">put</span> /share/groups/{groupId}</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Status">Status</a></h4>
|
|
<ul>
|
|
<li><a href="#status"><code><span class="http-method">get</span> /status</code></a></li>
|
|
</ul>
|
|
|
|
<h1><a name="Account">Account</a></h1>
|
|
<div class="method"><a name="addAccount"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /account/profile</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">addAccount</span>)</div>
|
|
<div class="method-notes">Add a new account. Basic auth will be used for the accounts username and password. Access granted to valid create account token.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#Profile">Profile</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"image" : "image",
|
|
"node" : "node",
|
|
"name" : "name",
|
|
"description" : "description",
|
|
"handle" : "handle",
|
|
"location" : "location",
|
|
"version" : "version",
|
|
"did" : "did",
|
|
"revision" : 0
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">201</h4>
|
|
successful operation
|
|
<a href="#Profile">Profile</a>
|
|
<h4 class="field-label">400</h4>
|
|
invalid handle or password
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
invalid bearer token
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="addAccountApp"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /account/apps</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">addAccountApp</span>)</div>
|
|
<div class="method-notes">Generate token to attach an app to the account. Access granted to account's username and password.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
String
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>""</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">201</h4>
|
|
generated
|
|
<a href="#String">String</a>
|
|
<h4 class="field-label">401</h4>
|
|
invalid password
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="addAccountAuthentication"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /account/auth</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">addAccountAuthentication</span>)</div>
|
|
<div class="method-notes">Generate token to reset authentication. Access granted to account's login and password.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
String
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>""</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">201</h4>
|
|
generated
|
|
<a href="#String">String</a>
|
|
<h4 class="field-label">401</h4>
|
|
invalid password
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getAccountApps"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /account/apps</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getAccountApps</span>)</div>
|
|
<div class="method-notes">Get list of attached apps to account. Access granted to account's username and password.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#App">App</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"appId" : "appId",
|
|
"attached" : 0,
|
|
"appData" : {
|
|
"image" : "image",
|
|
"name" : "name",
|
|
"description" : "description",
|
|
"url" : "url"
|
|
}
|
|
}, {
|
|
"appId" : "appId",
|
|
"attached" : 0,
|
|
"appData" : {
|
|
"image" : "image",
|
|
"name" : "name",
|
|
"description" : "description",
|
|
"url" : "url"
|
|
}
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getAccountImage"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /account/profile/image</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getAccountImage</span>)</div>
|
|
<div class="method-notes">Get profile image. Access granted to account's username and password</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
byte[]
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>""</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/octet-stream</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#byte[]">byte[]</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">405</h4>
|
|
invalid image
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getAccountProfile"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /account/profile</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getAccountProfile</span>)</div>
|
|
<div class="method-notes">Get account profile. Access granted to account's username and password.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#Profile">Profile</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"image" : "image",
|
|
"node" : "node",
|
|
"name" : "name",
|
|
"description" : "description",
|
|
"handle" : "handle",
|
|
"location" : "location",
|
|
"version" : "version",
|
|
"did" : "did",
|
|
"revision" : 0
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
<a href="#Profile">Profile</a>
|
|
<h4 class="field-label">401</h4>
|
|
authentication error
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getAccountToken"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /account/token</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getAccountToken</span>)</div>
|
|
<div class="method-notes">Check if account reset token or account create token is valid. Access granted to valid create or reset token.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getAccountUsername"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /account/claimable</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getAccountUsername</span>)</div>
|
|
<div class="method-notes">Check if username is available. Access granted account reset token or account create token.</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">username (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — username to check </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">406</h4>
|
|
username already claimed
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="removeAccountApp"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /account/apps/{appId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">removeAccountApp</span>)</div>
|
|
<div class="method-notes">Get list of attached apps. Access granted to account's username and password.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">appId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified app id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
invalid password
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
app not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setAccountApp"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /account/apps</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setAccountApp</span>)</div>
|
|
<div class="method-notes">Apply the token to attach an app to the account. Access granted to valid attach token.</div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#AppData">AppData</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
String
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>""</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">201</h4>
|
|
generated
|
|
<a href="#String">String</a>
|
|
<h4 class="field-label">401</h4>
|
|
invalid token
|
|
<a href="#"></a>
|
|
<h4 class="field-label">406</h4>
|
|
app limit reached
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setAccountAuthentication"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /account/auth</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setAccountAuthentication</span>)</div>
|
|
<div class="method-notes">Apply account reset token to set handle and password. Basic auth will be used for new login and password. Access granted to valid reset token.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">201</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Admin">Admin</a></h1>
|
|
<div class="method"><a name="addNodeAccount"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /admin/accounts</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">addNodeAccount</span>)</div>
|
|
<div class="method-notes">Gernerate a url for creating a new account. Access granted to admin username and password.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
String
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>""</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">201</h4>
|
|
generated
|
|
<a href="#String">String</a>
|
|
<h4 class="field-label">401</h4>
|
|
invalid password
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getNodeAccountImage"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /admin/accounts/{accountId}/image</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getNodeAccountImage</span>)</div>
|
|
<div class="method-notes">Get profile image of specified account. Access granted to admin username and password</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">accountId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — id of specified account </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
byte[]
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>""</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/octet-stream</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#byte[]">byte[]</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">405</h4>
|
|
invalid image
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getNodeAccounts"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /admin/accounts</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getNodeAccounts</span>)</div>
|
|
<div class="method-notes">Get list of accounts hosted on node. Access granted to admin username and password.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#Account">Account</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"accountId" : "accountId",
|
|
"profile" : {
|
|
"image" : "image",
|
|
"node" : "node",
|
|
"name" : "name",
|
|
"description" : "description",
|
|
"handle" : "handle",
|
|
"location" : "location",
|
|
"version" : "version",
|
|
"did" : "did",
|
|
"revision" : 0
|
|
}
|
|
}, {
|
|
"accountId" : "accountId",
|
|
"profile" : {
|
|
"image" : "image",
|
|
"node" : "node",
|
|
"name" : "name",
|
|
"description" : "description",
|
|
"handle" : "handle",
|
|
"location" : "location",
|
|
"version" : "version",
|
|
"did" : "did",
|
|
"revision" : 0
|
|
}
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
|
|
<h4 class="field-label">401</h4>
|
|
invalid password
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
handle not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getNodeClaimable"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /admin/claimable</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getNodeClaimable</span>)</div>
|
|
<div class="method-notes">Check if portal params have been set</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">406</h4>
|
|
node already claimed
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="removeNodeAccount"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /admin/accounts/{accountId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">removeNodeAccount</span>)</div>
|
|
<div class="method-notes">Remove account from node. Access granted to admin username and password.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">accountId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — id of account to delete </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
invalid authentication
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
account not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setNodeAccount"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /admin/accounts/{accountId}/reset</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setNodeAccount</span>)</div>
|
|
<div class="method-notes">Generate a password reset url for specified account. Access granted to admin username and password.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">accountId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — id of profile to access </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
String
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>""</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">201</h4>
|
|
generated
|
|
<a href="#String">String</a>
|
|
<h4 class="field-label">401</h4>
|
|
invalid password
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
unknown portal
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setNodeConfig"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /admin/config</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setNodeConfig</span>)</div>
|
|
<div class="method-notes">Set admin password and node domain</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">domain (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — domain of node </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setNodeConfigDomain"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /admin/config/domain</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setNodeConfigDomain</span>)</div>
|
|
<div class="method-notes">Set portal domain to be set in profile queries. Access granted to admin username and password.</div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#string">string</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denide
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Authenticate">Authenticate</a></h1>
|
|
<div class="method"><a name="authenticate"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /authenticate</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">authenticate</span>)</div>
|
|
<div class="method-notes">Retrieve an authenticate data messaging verifying the account holder is accepting the action referenced by the token.</div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#string">string</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#DataMessage">DataMessage</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"messageType" : "Connect",
|
|
"signature" : "signature",
|
|
"publicKey" : "publicKey",
|
|
"message" : "message",
|
|
"keyType" : "RSA4096"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#DataMessage">DataMessage</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Contact">Contact</a></h1>
|
|
<div class="method"><a name="addCard"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /contact/cards</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">addCard</span>)</div>
|
|
<div class="method-notes">Add a contact card. Access granted to app tokens of account holder.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#DataMessage">DataMessage</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"messageType" : "Connect",
|
|
"signature" : "signature",
|
|
"publicKey" : "publicKey",
|
|
"message" : "message",
|
|
"keyType" : "RSA4096"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#DataMessage">DataMessage</a>
|
|
<h4 class="field-label">400</h4>
|
|
invalid data message
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="clearCardGroup"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /contact/cards/{cardId}/groups/{groupId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">clearCardGroup</span>)</div>
|
|
<div class="method-notes">Clear sharing group for card. Access granted to app tokens for account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">cardId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified card id </div> <div class="param">groupId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified share id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#CardData">CardData</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"notes" : "notes",
|
|
"groups" : [ "groups", "groups" ],
|
|
"revision" : 6,
|
|
"status" : "pending",
|
|
"token" : "token"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#CardData">CardData</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
card or group not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="clearCardNotes"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /contact/cards/{cardId}/notes</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">clearCardNotes</span>)</div>
|
|
<div class="method-notes">Clear notes for specified card. Access granted to app tokens of account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">cardId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified card id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#CardData">CardData</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"notes" : "notes",
|
|
"groups" : [ "groups", "groups" ],
|
|
"revision" : 6,
|
|
"status" : "pending",
|
|
"token" : "token"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#CardData">CardData</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
card not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getCard"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /contact/cards/{cardId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getCard</span>)</div>
|
|
<div class="method-notes">Retieve card entry. Permission granted to app tokens for account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">cardId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified card id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#Card">Card</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"cardData" : {
|
|
"notes" : "notes",
|
|
"groups" : [ "groups", "groups" ],
|
|
"revision" : 6,
|
|
"status" : "pending",
|
|
"token" : "token"
|
|
},
|
|
"cardProfile" : {
|
|
"node" : "node",
|
|
"imageSet" : true,
|
|
"name" : "name",
|
|
"description" : "description",
|
|
"handle" : "handle",
|
|
"location" : "location",
|
|
"revision" : 0
|
|
},
|
|
"cardId" : "cardId",
|
|
"converstaionRevision" : 5,
|
|
"contentRevision" : 1
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
<a href="#Card">Card</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
card not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getCardData"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /contact/cards/{cardId}/data</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getCardData</span>)</div>
|
|
<div class="method-notes">Get specified card data. Access granted to app tokens for account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">cardId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified card id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#CardData">CardData</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"notes" : "notes",
|
|
"groups" : [ "groups", "groups" ],
|
|
"revision" : 6,
|
|
"status" : "pending",
|
|
"token" : "token"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#CardData">CardData</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
card not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getCardProfile"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /contact/cards/{cardId}/profile</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getCardProfile</span>)</div>
|
|
<div class="method-notes">Get profile of card entry. Access granted to app tokens of account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">cardId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified card id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#CardProfile">CardProfile</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"node" : "node",
|
|
"imageSet" : true,
|
|
"name" : "name",
|
|
"description" : "description",
|
|
"handle" : "handle",
|
|
"location" : "location",
|
|
"revision" : 0
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
<a href="#CardProfile">CardProfile</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getCardProfileImage"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /contact/cards/{cardId}/profile/image</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getCardProfileImage</span>)</div>
|
|
<div class="method-notes">Get image of card profile. Access granted to app tokens of account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">cardId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified card id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
byte[]
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>""</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/octet-stream</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#byte[]">byte[]</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
card not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">405</h4>
|
|
invalid image
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getCardView"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /contact/cards/view</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getCardView</span>)</div>
|
|
<div class="method-notes">Get list of card views. Access granted to app tokens of account holder.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#CardView">CardView</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"cardRevision" : 0,
|
|
"profileRevision" : 6,
|
|
"cardId" : "cardId",
|
|
"converstaionRevision" : 5,
|
|
"contentRevision" : 1
|
|
}, {
|
|
"cardRevision" : 0,
|
|
"profileRevision" : 6,
|
|
"cardId" : "cardId",
|
|
"converstaionRevision" : 5,
|
|
"contentRevision" : 1
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getCloseMessage"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /contact/cards/{cardId}/closeMessage</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getCloseMessage</span>)</div>
|
|
<div class="method-notes">Get message for closing connection with contact. Access granted to app tokens for account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">cardId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified card id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#DataMessage">DataMessage</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"messageType" : "Connect",
|
|
"signature" : "signature",
|
|
"publicKey" : "publicKey",
|
|
"message" : "message",
|
|
"keyType" : "RSA4096"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
<a href="#DataMessage">DataMessage</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
card not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getOpenMessage"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /contact/cards/{cardId}/openMessage</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getOpenMessage</span>)</div>
|
|
<div class="method-notes">Get message for connecting to other contacts. Access granted to app tokens for account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">cardId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified card id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#DataMessage">DataMessage</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"messageType" : "Connect",
|
|
"signature" : "signature",
|
|
"publicKey" : "publicKey",
|
|
"message" : "message",
|
|
"keyType" : "RSA4096"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#DataMessage">DataMessage</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
card not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="removeCard"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /contact/cards/{cardId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">removeCard</span>)</div>
|
|
<div class="method-notes">Remove card entry. Access granted to app tokens of account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">cardId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified card id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
card not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setCardGroup"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /contact/cards/{cardId}/groups/{groupId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setCardGroup</span>)</div>
|
|
<div class="method-notes">Set sharing group for contact. Access granted to app tokens for account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">cardId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified card id </div> <div class="param">groupId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified group id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#CardData">CardData</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"notes" : "notes",
|
|
"groups" : [ "groups", "groups" ],
|
|
"revision" : 6,
|
|
"status" : "pending",
|
|
"token" : "token"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#CardData">CardData</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
card or group not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setCardNotes"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /contact/cards/{cardId}/notes</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setCardNotes</span>)</div>
|
|
<div class="method-notes">Update card notes for specified card. Access granted to app tokens for account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">cardId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified card id </div> </div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#string">string</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#CardData">CardData</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"notes" : "notes",
|
|
"groups" : [ "groups", "groups" ],
|
|
"revision" : 6,
|
|
"status" : "pending",
|
|
"token" : "token"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#CardData">CardData</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
card not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setCardProfile"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /contact/cards/{cardId}/profile</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setCardProfile</span>)</div>
|
|
<div class="method-notes">Set profile of card entry. Access granted to app tokens of account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">cardId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified card id </div> </div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#Profile">Profile</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#DataMessage">DataMessage</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"messageType" : "Connect",
|
|
"signature" : "signature",
|
|
"publicKey" : "publicKey",
|
|
"message" : "message",
|
|
"keyType" : "RSA4096"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#DataMessage">DataMessage</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
card not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setCardStatus"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /contact/cards/{cardId}/status</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setCardStatus</span>)</div>
|
|
<div class="method-notes">Updated connected status of contact. Access granted to app tokens of account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">cardId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified card id </div> </div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#string">string</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">token (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — token for accessing card </div> </div> <!-- field-items -->
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#CardData">CardData</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"notes" : "notes",
|
|
"groups" : [ "groups", "groups" ],
|
|
"revision" : 6,
|
|
"status" : "pending",
|
|
"token" : "token"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#CardData">CardData</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
card not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setCloseMessage"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /contact/closeMessage</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setCloseMessage</span>)</div>
|
|
<div class="method-notes">Set message for closing card connection. Access granted to public.</div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#DataMessage">DataMessage</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200">inline_response_200</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"token" : "token",
|
|
"status" : "pending"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
<a href="#inline_response_200">inline_response_200</a>
|
|
<h4 class="field-label">400</h4>
|
|
invalid data message
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setContentRevision"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /contact/content/revision</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setContentRevision</span>)</div>
|
|
<div class="method-notes">Set content revision for contact. This is intend to be invoked automatically anytime a contact updates their content or sharing. Access granted to contact tokens.</div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#long">long</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
revision set
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
not authorized
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setOpenMessage"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /contact/openMessage</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setOpenMessage</span>)</div>
|
|
<div class="method-notes">Set message for connecting to a contact. If card has not already been added, the card will be created in the pending state. Access granted to public.</div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#DataMessage">DataMessage</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200">inline_response_200</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"token" : "token",
|
|
"status" : "pending"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
<a href="#inline_response_200">inline_response_200</a>
|
|
<h4 class="field-label">400</h4>
|
|
invalid data message
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setProfileRevision"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /contact/profile/revision</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setProfileRevision</span>)</div>
|
|
<div class="method-notes">Set profile revision for contact. This is intend to be invoked automatically anytime a contact updates their profile. Access granted to contact tokens.</div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#long">long</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
revision set
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
not authorized
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Content">Content</a></h1>
|
|
<div class="method"><a name="addArticle"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /content/articles</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">addArticle</span>)</div>
|
|
<div class="method-notes">Add a content article. Access granted to app token of the account holder.</div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#content_articles_body">content_articles_body</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_201">inline_response_201</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"blockId" : "blockId",
|
|
"blockRevision" : 0,
|
|
"article" : {
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"articleId" : "articleId",
|
|
"tagUpdate" : 1,
|
|
"groups" : [ "groups", "groups" ],
|
|
"tagCount" : 6,
|
|
"tagRevision" : 5,
|
|
"revision" : 0,
|
|
"status" : "unconfirmed",
|
|
"labels" : [ "labels", "labels" ]
|
|
}
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">201</h4>
|
|
entry created
|
|
<a href="#inline_response_201">inline_response_201</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="addArticleAsset"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /content/articles/{articleId}/assets</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">addArticleAsset</span>)</div>
|
|
<div class="method-notes">Add an an asset to the to an article. The original posted asset is referenced in the asset list with a null transform. The transformed assets are referenced accordingly. Transforming the asset strips it of metadata and transcodes it into a specified format. Access is granted to the app token of the account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">articleId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified article id </div> </div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>multipart/form-data</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">transforms (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — transforms to apply </div> </div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Form parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fileName (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Form Parameter</span> — format: binary</div> </div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#Asset">Asset</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"transform" : "transform",
|
|
"assetId" : "assetId",
|
|
"status" : "pending"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">201</h4>
|
|
success
|
|
<a href="#Asset">Asset</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
article not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">406</h4>
|
|
storage limit reached
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="addArticleTag"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /content/articles/{articleId}/tags</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">addArticleTag</span>)</div>
|
|
<div class="method-notes">Add a tag to an article. Access granted to app tokens of the account holder and contact tokens of accounts with which the article is shared.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">articleId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified article id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200_2">inline_response_200_2</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"blockId" : "blockId",
|
|
"tag" : {
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"cardId" : "cardId"
|
|
},
|
|
"blockRevision" : 0
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#inline_response_200_2">inline_response_200_2</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
article not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="addLabel"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /content/labels</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">addLabel</span>)</div>
|
|
<div class="method-notes">Add a new label for organizing the articles. Access granted to the app tokens of the account holder.</div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#content_labels_body">content_labels_body</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="clearArticleGroup"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /content/articles/{articleId}/groups/{groupId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">clearArticleGroup</span>)</div>
|
|
<div class="method-notes">Remove article from sharing group. Unless the article is shared through other groups or labels contacts within that group will no longer have access to the article. Access granted to app tokens of the account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">articleId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified article id </div> <div class="param">groupId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified share id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
group or article not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="clearArticleLabel"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /content/articles/{articleId}/labels/{labelId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">clearArticleLabel</span>)</div>
|
|
<div class="method-notes">Remove a label from an article. If the label has been assigned a sharing group the article and the article is not shared in another way, the article will no longer be accessible to that group's contacts. Access is granted to app tokens of the account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">articleId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified article id </div> <div class="param">labelId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified label id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
label or article not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="clearLabelGroup"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /content/labels/{labelId}/groups/{groupId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">clearLabelGroup</span>)</div>
|
|
<div class="method-notes">Clear a sharing group from a label. Access granted to app tokens of the account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">labelId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified label id </div> <div class="param">groupId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified group id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
group or label not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getArticle"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /content/articles/{articleId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getArticle</span>)</div>
|
|
<div class="method-notes">Get specified article. Access granted to app token of account holder or contact token of account the article is shared with.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">articleId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified article id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#Article">Article</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"articleId" : "articleId",
|
|
"tagUpdate" : 1,
|
|
"groups" : [ "groups", "groups" ],
|
|
"tagCount" : 6,
|
|
"tagRevision" : 5,
|
|
"revision" : 0,
|
|
"status" : "unconfirmed",
|
|
"labels" : [ "labels", "labels" ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#Article">Article</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
article not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getArticleAsset"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /content/articles/{articleId}/assets/{assetId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getArticleAsset</span>)</div>
|
|
<div class="method-notes">Get asset assigned to an article. The endpoint supports byte-range requests and responds with the content-type set appropriatly. Access granted to the app tokens of the account holder and in the case of non-original assets, the contact token for accounts with which the article is shared.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">articleId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified article id </div> <div class="param">assetId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified asset id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
byte[]
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>""</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/octet-stream</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#byte[]">byte[]</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
asset or article not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getArticleAssets"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /content/articles/{articleId}/assets</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getArticleAssets</span>)</div>
|
|
<div class="method-notes">Get list of assets assigned to an article. The original assets will only be available to the account holder to provent the accidental sharing of content metadata. Access is granted to the app token of the account holder and the contact token of accounts the article has been shared with.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">articleId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified article id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#Asset">Asset</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"transform" : "transform",
|
|
"assetId" : "assetId",
|
|
"status" : "pending"
|
|
}, {
|
|
"transform" : "transform",
|
|
"assetId" : "assetId",
|
|
"status" : "pending"
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">201</h4>
|
|
entry created
|
|
|
|
<h4 class="field-label">401</h4>
|
|
invalid token
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getArticleBlockView"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /content/articleBlocks/view</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getArticleBlockView</span>)</div>
|
|
<div class="method-notes">Get article block views. Acess granted to account token or contact token. When the request is made with a contact token the account view revision will be added to the block revision.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#inline_response_200_1">inline_response_200_1</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"id" : "id",
|
|
"revision" : 0
|
|
}, {
|
|
"id" : "id",
|
|
"revision" : 0
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getArticleSubjectField"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /content/articles/{articleId}/subject/{field}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getArticleSubjectField</span>)</div>
|
|
<div class="method-notes">Base64 decode and download specified field from the article's subject. Access granted to app token of account holder or contact token of account the article is shared with.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">articleId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified article id </div> <div class="param">field (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — field from subject to base64 decode and download </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#Article">Article</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"articleId" : "articleId",
|
|
"tagUpdate" : 1,
|
|
"groups" : [ "groups", "groups" ],
|
|
"tagCount" : 6,
|
|
"tagRevision" : 5,
|
|
"revision" : 0,
|
|
"status" : "unconfirmed",
|
|
"labels" : [ "labels", "labels" ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#Article">Article</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
field, article not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">405</h4>
|
|
invalid field
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getArticleTag"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /content/articles/{articleId}/tags/{tagId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getArticleTag</span>)</div>
|
|
<div class="method-notes">Get specified tag. Access granted to app tokens of account holder and contact tokens of accounts with which the article is shared.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">articleId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified article id </div> <div class="param">tagId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified tag id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#Tag">Tag</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"cardId" : "cardId"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#Tag">Tag</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
tag or article not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getArticleTagBlockView"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /content/articles/{articleId}/tagBlocks/view</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getArticleTagBlockView</span>)</div>
|
|
<div class="method-notes">Get view of tag blocks associated with specified article. Access granted to app tokens of account holder and contact tokens of account with which the article is shared.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">articleId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified article id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">types (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — limit results to tags of types </div> </div> <!-- field-items -->
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#inline_response_200_1">inline_response_200_1</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"id" : "id",
|
|
"revision" : 0
|
|
}, {
|
|
"id" : "id",
|
|
"revision" : 0
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
article not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getArticleTagSubjectField"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /content/articles/{articleId}/tags/{tagId}/subject/{field}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getArticleTagSubjectField</span>)</div>
|
|
<div class="method-notes">Base64 decode and retrieve specified tag on the article. Access granted to app tokens of account holder and contact tokens of accounts with which the article is shared.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">articleId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified article id </div> <div class="param">tagId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified tag id </div> <div class="param">field (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — field to base64 decode and transfer </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#Tag">Tag</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"cardId" : "cardId"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#Tag">Tag</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
field, tag or article not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">405</h4>
|
|
invalid field
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getArticleTagView"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /content/articles/{articleId}/tagBlocks/{blockId}/view</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getArticleTagView</span>)</div>
|
|
<div class="method-notes">Get view of tags within speicified block. Access granted to app tokens of account holder and contact token of accounts with which the article is shared.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">articleId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified article id </div> <div class="param">blockId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified block id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">types (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — limit results to tags of types </div> </div> <!-- field-items -->
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#inline_response_200_1">inline_response_200_1</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"id" : "id",
|
|
"revision" : 0
|
|
}, {
|
|
"id" : "id",
|
|
"revision" : 0
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
block or article not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getArticleTags"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /content/articles/{articleId}/tagBlocks/{blockId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getArticleTags</span>)</div>
|
|
<div class="method-notes">Get tags within specified block. Access granted to app tokens of account holder and contact tokens of accounts with which the article is shared.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">articleId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified article id </div> <div class="param">blockId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified block id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">types (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — limit results to tags of types </div> </div> <!-- field-items -->
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#inline_response_200_1">inline_response_200_1</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"id" : "id",
|
|
"revision" : 0
|
|
}, {
|
|
"id" : "id",
|
|
"revision" : 0
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
block or article not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getArticleViews"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /content/articleBlocks/{blockId}/view</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getArticleViews</span>)</div>
|
|
<div class="method-notes">Get the article views within specified block. Access granted for app token or contact token. All of the articles are returned for the app token, but only the shared articles are returned for the contact token. An article is shared by assigning a common group to an article or assigning a label to an article that has assigned a common group.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">blockId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified group id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#inline_response_200_1">inline_response_200_1</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"id" : "id",
|
|
"revision" : 0
|
|
}, {
|
|
"id" : "id",
|
|
"revision" : 0
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
block not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getArticles"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /content/articleBlocks/{blockId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getArticles</span>)</div>
|
|
<div class="method-notes">Get the articles within specified block. Access granted for app token or contact token. All of the articles are returned for the app token, but only the shared articles are returned for the contact token. An article is shared by assigning a common group to an article or assigning a label to an article that has assigned a common group.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">blockId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified group id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#Article">Article</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"articleId" : "articleId",
|
|
"tagUpdate" : 1,
|
|
"groups" : [ "groups", "groups" ],
|
|
"tagCount" : 6,
|
|
"tagRevision" : 5,
|
|
"revision" : 0,
|
|
"status" : "unconfirmed",
|
|
"labels" : [ "labels", "labels" ]
|
|
}, {
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"articleId" : "articleId",
|
|
"tagUpdate" : 1,
|
|
"groups" : [ "groups", "groups" ],
|
|
"tagCount" : 6,
|
|
"tagRevision" : 5,
|
|
"revision" : 0,
|
|
"status" : "unconfirmed",
|
|
"labels" : [ "labels", "labels" ]
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
block not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getLabels"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /content/labels</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getLabels</span>)</div>
|
|
<div class="method-notes">Get labels with which to organize the articles. Contacts requesting the labels will only retrieve the labels with which they are shared. Access granted to the app tokens of the account holder and connected contact tokens.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#Label">Label</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"groups" : [ "groups", "groups" ]
|
|
}, {
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"groups" : [ "groups", "groups" ]
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
|
|
<h4 class="field-label">401</h4>
|
|
invalid token
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="removeArticle"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /content/articles/{articleId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">removeArticle</span>)</div>
|
|
<div class="method-notes">Remove specified article. Access granted to app token of account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">articleId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified article id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
invalid password
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
article not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="removeArticleAsset"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /content/articles/{articleId}/assets/{assetId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">removeArticleAsset</span>)</div>
|
|
<div class="method-notes">Remove an asset from an article. Access granted to app tokens of the account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">articleId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified article id </div> <div class="param">assetId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified asset id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
asset or article not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="removeArticleTag"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /content/articles/{articleId}/tags/{tagId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">removeArticleTag</span>)</div>
|
|
<div class="method-notes">Remove a tag from an article. Access granted to app tokens of account holder and the contact tokens of the account that created the tag.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">articleId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified article id </div> <div class="param">tagId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified tag id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
tag or article not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="removeLabel"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /content/labels/{labelId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">removeLabel</span>)</div>
|
|
<div class="method-notes">Remove specified label. Access granted the the app tokens of the account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">labelId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified label id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
label not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setArticleConfirmed"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /content/articles/{articleId}/confirmed</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setArticleConfirmed</span>)</div>
|
|
<div class="method-notes">Set confirmed state of the article. Until the confirmed state has been set to true, the article will not be visible to contacts with which the article is shared. Access granted to the app tokens of the acocunt holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">articleId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified article id </div> </div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#boolean">boolean</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
article not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setArticleGroup"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /content/articles/{articleId}/groups/{groupId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setArticleGroup</span>)</div>
|
|
<div class="method-notes">Assign a sharing group for the specified article. Contacts with the same sharing group will have access to the article. Access granted to app token of account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">articleId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified article id </div> <div class="param">groupId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified share group id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
group or article not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setArticleLabel"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /content/articles/{articleId}/labels/{labelId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setArticleLabel</span>)</div>
|
|
<div class="method-notes">Assign a label to an article. If the label has been assigned a sharing group the article will be accessible by contacts within that group. Access is granted to app tokens of the account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">articleId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified article id </div> <div class="param">labelId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified label id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
label or article not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setArticleSubject"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /content/articles/{articleId}/subject</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setArticleSubject</span>)</div>
|
|
<div class="method-notes">Set subject for article. Access granted to app token of account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">articleId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified article id </div> </div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#articleId_subject_body">articleId_subject_body</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
article not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setLabelGroup"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /content/labels/{labelId}/groups/{groupId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setLabelGroup</span>)</div>
|
|
<div class="method-notes">Set a sharing group for the label and articles assigned to the label. Access granted to app tokens of the account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">labelId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified label id </div> <div class="param">groupId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified group id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
group or label not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="updateLabel"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /content/labels/{labelId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">updateLabel</span>)</div>
|
|
<div class="method-notes">Update specified label. Access granted to app tokens of the account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">labelId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified group id </div> </div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#labels_labelId_body">labels_labelId_body</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
invalid token
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Conversation">Conversation</a></h1>
|
|
<div class="method"><a name="addDialogue"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /conversation/dialogues</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">addDialogue</span>)</div>
|
|
<div class="method-notes">Create and host a new dialogue. Authroization granted to an app token of the account holder.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#Dialogue">Dialogue</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"dialogueId" : "dialogueId",
|
|
"insights" : [ {
|
|
"cardId" : "cardId",
|
|
"status" : "active"
|
|
}, {
|
|
"cardId" : "cardId",
|
|
"status" : "active"
|
|
} ],
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"active" : true,
|
|
"revision" : 0
|
|
}, {
|
|
"dialogueId" : "dialogueId",
|
|
"insights" : [ {
|
|
"cardId" : "cardId",
|
|
"status" : "active"
|
|
}, {
|
|
"cardId" : "cardId",
|
|
"status" : "active"
|
|
} ],
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"active" : true,
|
|
"revision" : 0
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="addDialogueInsight"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /conversation/dialogues/{dialogueId}/cards/{cardId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">addDialogueInsight</span>)</div>
|
|
<div class="method-notes">Add insight to a dialogue. This endpoint will automatically invoke the add insight on the contact's node. Authorization is granted to the app token of the account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> <div class="param">cardId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified card id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
cardId or dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="addDialogueTopic"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /conversation/dialogues/{dialogueId}/topics</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">addDialogueTopic</span>)</div>
|
|
<div class="method-notes">Add a topic to a dialogue. The response contains the topicBlock ID and topicBlock revision to which the topic is assigned. Authorization granted to account holder app token or dialogue member contact token who is a member of the dialogue.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_201_1">inline_response_201_1</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"blockId" : "blockId",
|
|
"topic" : {
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"articleId" : "articleId",
|
|
"tagUpdate" : 1,
|
|
"tagCount" : 6,
|
|
"tagRevision" : 5,
|
|
"revision" : 0,
|
|
"status" : "unconfirmed"
|
|
},
|
|
"blockRevision" : 0
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">201</h4>
|
|
entry created
|
|
<a href="#inline_response_201_1">inline_response_201_1</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">403</h4>
|
|
inactive dialogue
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="addInsightDialogue"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /conversation/insights/{dialogueId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">addInsightDialogue</span>)</div>
|
|
<div class="method-notes">Create or update an insight. Because the insightId is not know by the contact, it is determined from the token and the dialogueId. Access granted to a connected contact token.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — dialogue with insight id to update </div> </div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#long">long</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
String
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>"active"</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#String">String</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="addTopicAsset"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/assets</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">addTopicAsset</span>)</div>
|
|
<div class="method-notes">Add an asset to a topic. The asset will be processed and transcoded according to the specified transformation. Authorization granted to account holder app token or dialogue member contact token who is also the creator of the topic.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> <div class="param">topicId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified topic id </div> </div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>multipart/form-data</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">transforms (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — transforms to apply </div> </div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Form parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fileName (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Form Parameter</span> — format: binary</div> </div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#Asset">Asset</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"transform" : "transform",
|
|
"assetId" : "assetId",
|
|
"status" : "pending"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">201</h4>
|
|
success
|
|
<a href="#Asset">Asset</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">403</h4>
|
|
inactive dialogue
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
topic or dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="addTopicTag"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/tags</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">addTopicTag</span>)</div>
|
|
<div class="method-notes">Add a tag to specified topic. Authorization granted to account holder app token or dialogue member contact token who has access to the topic. The body of the post contains the subject of the tag, which can have no associated assets.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> <div class="param">topicId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified topic id </div> </div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#topicId_tags_body">topicId_tags_body</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200_2">inline_response_200_2</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"blockId" : "blockId",
|
|
"tag" : {
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"cardId" : "cardId"
|
|
},
|
|
"blockRevision" : 0
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">201</h4>
|
|
entry created
|
|
<a href="#inline_response_200_2">inline_response_200_2</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">403</h4>
|
|
inactive dialogue
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
topic or dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="conversationDialoguesDialogueIdTopicsTopicIdConfirmedPut"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/confirmed</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">conversationDialoguesDialogueIdTopicsTopicIdConfirmedPut</span>)</div>
|
|
<div class="method-notes">After the assets have been uploaded and the subject has been set, the topic should be set to confirmed (true) to make the topic available to others. Authorization granted to account holder app token or dialogue member contact token who is also the creator of the topic.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> <div class="param">topicId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified topic id </div> </div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#boolean">boolean</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">403</h4>
|
|
inactive dialogue
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
topic or dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getDialogueTopic"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topics/{topicId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getDialogueTopic</span>)</div>
|
|
<div class="method-notes">Retrieve a specified dialogue topic. Authorization granted to account holder app token or dialogue member contact token who is a member of the dialogue.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> <div class="param">topicId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified topic id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#Topic">Topic</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"articleId" : "articleId",
|
|
"tagUpdate" : 1,
|
|
"tagCount" : 6,
|
|
"tagRevision" : 5,
|
|
"revision" : 0,
|
|
"status" : "unconfirmed"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
<a href="#Topic">Topic</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
topic or dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getDialogueTopicSubjectField"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/subject/{field}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getDialogueTopicSubjectField</span>)</div>
|
|
<div class="method-notes">Base64 decode and retrieve a specified field from subject of dialogue topic. Authorization granted to account holder app token or dialogue member contact token who is a member of the dialogue.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> <div class="param">topicId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified topic id </div> <div class="param">field (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — field to base64 decode and retrieve </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
byte[]
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>""</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/octet-stream</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#byte[]">byte[]</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
field, topic or dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">405</h4>
|
|
invalid field
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getDialogues"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /conversation/dialogues</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getDialogues</span>)</div>
|
|
<div class="method-notes">Retrieve all dialogues.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#Dialogue">Dialogue</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"dialogueId" : "dialogueId",
|
|
"insights" : [ {
|
|
"cardId" : "cardId",
|
|
"status" : "active"
|
|
}, {
|
|
"cardId" : "cardId",
|
|
"status" : "active"
|
|
} ],
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"active" : true,
|
|
"revision" : 0
|
|
}, {
|
|
"dialogueId" : "dialogueId",
|
|
"insights" : [ {
|
|
"cardId" : "cardId",
|
|
"status" : "active"
|
|
}, {
|
|
"cardId" : "cardId",
|
|
"status" : "active"
|
|
} ],
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"active" : true,
|
|
"revision" : 0
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getInsights"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /conversation/insights</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getInsights</span>)</div>
|
|
<div class="method-notes">Retrieve all insights. Access granted to app token for the account holder.</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dismissed (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — if dismissed insights should be included </div> </div> <!-- field-items -->
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#Insight">Insight</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"cardId" : "cardId",
|
|
"insightId" : "insightId",
|
|
"revision" : 0,
|
|
"status" : "active"
|
|
}, {
|
|
"cardId" : "cardId",
|
|
"insightId" : "insightId",
|
|
"revision" : 0,
|
|
"status" : "active"
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getTopicAsset"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/assets/{assetId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getTopicAsset</span>)</div>
|
|
<div class="method-notes">Retrieve an asset associated with a topic. All transformed assets can be retrieved by anyone with access to the topic, but the original asset can only be retrieved by the author of the topic. Authorization granted to account holder app token or dialogue member contact token who is also the creator of the topic.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> <div class="param">topicId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified topic id </div> <div class="param">assetId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified asset id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
byte[]
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>""</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/octet-stream</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#byte[]">byte[]</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
asset, topic or dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getTopicAssets"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/assets</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getTopicAssets</span>)</div>
|
|
<div class="method-notes">Get all assets associated with the specified topic. Authorization granted to account holder app token or dialogue member contact token who has access to the topic.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> <div class="param">topicId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified topic id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#Asset">Asset</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"transform" : "transform",
|
|
"assetId" : "assetId",
|
|
"status" : "pending"
|
|
}, {
|
|
"transform" : "transform",
|
|
"assetId" : "assetId",
|
|
"status" : "pending"
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">201</h4>
|
|
success
|
|
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
topic or dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getTopicBlock"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topicBlocks/{blockId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getTopicBlock</span>)</div>
|
|
<div class="method-notes">Get the topics within a topicBlock. Only the account holder and the topic creator will retrieve pending topics. Authorization granted to account holder app token or dialogue member contact token who is also a member of the dialogue</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> <div class="param">blockId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified group id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">types (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — limit results to topics of types </div> </div> <!-- field-items -->
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#Topic">Topic</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"articleId" : "articleId",
|
|
"tagUpdate" : 1,
|
|
"tagCount" : 6,
|
|
"tagRevision" : 5,
|
|
"revision" : 0,
|
|
"status" : "unconfirmed"
|
|
}, {
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"articleId" : "articleId",
|
|
"tagUpdate" : 1,
|
|
"tagCount" : 6,
|
|
"tagRevision" : 5,
|
|
"revision" : 0,
|
|
"status" : "unconfirmed"
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
block or dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getTopicBlockView"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topicBlocks/view</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getTopicBlockView</span>)</div>
|
|
<div class="method-notes">Get a view of the topicBlocks within a dialogue. Authorization granted to account holder app token or dialogue member contact token who is also a member of the dialogue</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">types (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — limit results to topics of types </div> </div> <!-- field-items -->
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#inline_response_200_1">inline_response_200_1</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"id" : "id",
|
|
"revision" : 0
|
|
}, {
|
|
"id" : "id",
|
|
"revision" : 0
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getTopicTag"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/tags/{tagId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getTopicTag</span>)</div>
|
|
<div class="method-notes">Retrieve specified tag on the topic. Authorization granted to account holder app token or dialogue member contact token who has access to the topic.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> <div class="param">topicId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified topic id </div> <div class="param">tagId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified tag id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#Tag">Tag</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"cardId" : "cardId"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">201</h4>
|
|
success
|
|
<a href="#Tag">Tag</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
tag, topic, or dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getTopicTagBlockView"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/tagBlocks/view</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getTopicTagBlockView</span>)</div>
|
|
<div class="method-notes">Get a view of all of all tagBlocks. Authorization granted to account holder app token or dialogue member contact token who has access to the topic.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> <div class="param">topicId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified topic id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">types (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — limit results to articles of types </div> </div> <!-- field-items -->
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#inline_response_200_1">inline_response_200_1</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"id" : "id",
|
|
"revision" : 0
|
|
}, {
|
|
"id" : "id",
|
|
"revision" : 0
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
topic or dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getTopicTagSubjectField"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/tags/{tagId}/subject/{field}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getTopicTagSubjectField</span>)</div>
|
|
<div class="method-notes">Base64 decode and retrieve specified field of tag subject on the topic. Authorization granted to account holder app token or dialogue member contact token who has access to the topic.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> <div class="param">topicId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified topic id </div> <div class="param">tagId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified tag id </div> <div class="param">field (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — field to base64 decode and download </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#Tag">Tag</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"cardId" : "cardId"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">201</h4>
|
|
success
|
|
<a href="#Tag">Tag</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
field, tag, topic, or dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">405</h4>
|
|
invalid field
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getTopicTagView"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/tagBlocks/{blockId}/view</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getTopicTagView</span>)</div>
|
|
<div class="method-notes">Get a view of all of the tags within a block. Authorization granted to account holder app token or dialogue member contact token who has access to the topic.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> <div class="param">topicId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified topic id </div> <div class="param">blockId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified block id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">types (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — limit results to tags of types </div> </div> <!-- field-items -->
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#inline_response_200_1">inline_response_200_1</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"id" : "id",
|
|
"revision" : 0
|
|
}, {
|
|
"id" : "id",
|
|
"revision" : 0
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
block, topic or dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getTopicTags"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/tagBlocks/{blockId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getTopicTags</span>)</div>
|
|
<div class="method-notes">Get all of the tags within a tag block. Authorization granted to account holder app token or dialogue member contact token who has access to the topic.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> <div class="param">topicId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified topic id </div> <div class="param">blockId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified block id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">types (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — limit results to tags of types </div> </div> <!-- field-items -->
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#Tag">Tag</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"cardId" : "cardId"
|
|
}, {
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
},
|
|
"cardId" : "cardId"
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
block, topic, or dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getTopicViews"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /conversation/dialogues/{dialogueId}/topicBlocks/{blockId}/view</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getTopicViews</span>)</div>
|
|
<div class="method-notes">Get a view of the topics within a topicBlock. Authorization granted to account holder app token or dialogue member contact token who is also a member of the dialogue.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> <div class="param">blockId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified group id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">types (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — limit results to topics of types </div> </div> <!-- field-items -->
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#inline_response_200_1">inline_response_200_1</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"id" : "id",
|
|
"revision" : 0
|
|
}, {
|
|
"id" : "id",
|
|
"revision" : 0
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
block or dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="removeDialogue"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /conversation/dialogues/{dialogueId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">removeDialogue</span>)</div>
|
|
<div class="method-notes">Remove specified dialogue. This endpoint will authomatically invoke the delete insight endpoint on all of the contacts' nodes. Access is granted to an app token for the account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="removeDialogueInsight"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /conversation/dialogues/{dialogueId}/cards/{cardId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">removeDialogueInsight</span>)</div>
|
|
<div class="method-notes">Remove an insight from a dialogue. This endpoint will authomatically invoke the delete insight endpoint on the contact's node. Authorization is granted to the app token of the accoun holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> <div class="param">cardId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified contact id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
cardId or dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="removeDialogueTopic"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /conversation/dialogues/{dialogueId}/topics/{topicId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">removeDialogueTopic</span>)</div>
|
|
<div class="method-notes">Remove a topic from a dialogue. Authorization granted to account holder app token or dialogue member contact token who is either the topic createor or the account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> <div class="param">topicId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified topic id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">403</h4>
|
|
inactive dialogue
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
topic or dilaogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="removeTopicAsset"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/assets/{assetId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">removeTopicAsset</span>)</div>
|
|
<div class="method-notes">Remove and delete an asset associated with a topic. Authorization granted to account holder app token or dialogue member contact token who is also the creator of the topic.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> <div class="param">topicId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified topic id </div> <div class="param">assetId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified asset id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">403</h4>
|
|
inactive dialogue
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
asset, topic or dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="removeTopicTag"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/tags/{tagId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">removeTopicTag</span>)</div>
|
|
<div class="method-notes">Remove specified tag from the topic. Authorization granted to account holder app token or dialogue member contact token who has access to the topic.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> <div class="param">topicId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified topic id </div> <div class="param">tagId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified tag id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">403</h4>
|
|
inactive dialogue
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
tag, topic, or dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setDialogueActive"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /conversation/dialogues/{dialogueId}/active</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setDialogueActive</span>)</div>
|
|
<div class="method-notes">Set active state of dialogue. If a dialogue is inactive any update to the topics will fail. Authorization is granted to an app token of the account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> </div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#boolean">boolean</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setDialogueInsightStatus"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /conversation/dialogues/{dialogueId}/status</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setDialogueInsightStatus</span>)</div>
|
|
<div class="method-notes">Set active status for contact on the host node. Access is granted to a contact token for an account with the specified contact</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> </div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#string">string</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setDialogueSubject"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /conversation/dialogues/{dialogueId}/subject</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setDialogueSubject</span>)</div>
|
|
<div class="method-notes">Set the subject for a dialogue. Authorization granted the an app token for the account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> </div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#dialogueId_subject_body">dialogueId_subject_body</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">201</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setInsightDialogue"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /conversation/insights/{dialogueId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setInsightDialogue</span>)</div>
|
|
<div class="method-notes">Remove a specified insight. If the referenced dialogue is still active, the insight will get recreated with the next hook receiver update. Access granted to contact token of a connected card.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — insight id to update </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setInsightStatus"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /conversation/insights/{insightId}/status</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setInsightStatus</span>)</div>
|
|
<div class="method-notes">Set the status of an insight. This will cause the hook receiver to return an inactive status. Access granted to app token of account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">insightId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — dialogue with insight id to update </div> </div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#string">string</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">403</h4>
|
|
invalid state
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
insight not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setTopicSubject"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /conversation/dialogues/{dialogueId}/topics/{topicId}/subject</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setTopicSubject</span>)</div>
|
|
<div class="method-notes">Set the subject for a topic. Authorization granted to account holder app token or dialogue member contact token who is also the creator of the topic.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">dialogueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified dialogue id </div> <div class="param">topicId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified topic id </div> </div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#topicId_subject_body">topicId_subject_body</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">201</h4>
|
|
entry created
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
invalid token
|
|
<a href="#"></a>
|
|
<h4 class="field-label">403</h4>
|
|
inactive dialogue
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
topic or dialogue not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Profile">Profile</a></h1>
|
|
<div class="method"><a name="getProfile"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /profile</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getProfile</span>)</div>
|
|
<div class="method-notes">Get profile of accunt. Access granted to app token of account holder.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#Profile">Profile</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"image" : "image",
|
|
"node" : "node",
|
|
"name" : "name",
|
|
"description" : "description",
|
|
"handle" : "handle",
|
|
"location" : "location",
|
|
"version" : "version",
|
|
"did" : "did",
|
|
"revision" : 0
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#Profile">Profile</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getProfileImage"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /profile/image</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getProfileImage</span>)</div>
|
|
<div class="method-notes">Download base64 decoded data of profile image. Access granted to app tokens of account holder.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
byte[]
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>""</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/octet-stream</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#byte[]">byte[]</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">405</h4>
|
|
invalid image
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getProfileMessage"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /profile/message</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getProfileMessage</span>)</div>
|
|
<div class="method-notes">Get a profile data message. Access granted to app token of account holder or contact token of connected contact.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#DataMessage">DataMessage</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"messageType" : "Connect",
|
|
"signature" : "signature",
|
|
"publicKey" : "publicKey",
|
|
"message" : "message",
|
|
"keyType" : "RSA4096"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#DataMessage">DataMessage</a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setProfile"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /profile</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">setProfile</span>)</div>
|
|
<div class="method-notes">Set profile data. Access granted to app tokens of account holder.</div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#ProfileData">ProfileData</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Share">Share</a></h1>
|
|
<div class="method"><a name="addGroup"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /share/groups</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">addGroup</span>)</div>
|
|
<div class="method-notes">Add a group for sharing. Access granted to app tokens of account holder.</div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#share_groups_body">share_groups_body</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
entry created
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getGroups"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /share/groups</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getGroups</span>)</div>
|
|
<div class="method-notes">Get groups for sharing. Access granted to app tokens of the account holder.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#Group">Group</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
}
|
|
}, {
|
|
"subject" : {
|
|
"data" : "data",
|
|
"created" : 6,
|
|
"type" : "type",
|
|
"subjectId" : "subjectId",
|
|
"revision" : 0
|
|
}
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
successful operation
|
|
|
|
<h4 class="field-label">401</h4>
|
|
invalid token
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="removeGroup"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /share/groups/{groupId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">removeGroup</span>)</div>
|
|
<div class="method-notes">Remove sharing group</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">groupId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified group id </div> </div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
group not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="updateGroup"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /share/groups/{groupId}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">updateGroup</span>)</div>
|
|
<div class="method-notes">Update group description for sharing. Access granted to app tokens of account holder.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">groupId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — specified group id </div> </div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#groups_groupId_body">groups_groupId_body</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
success
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
permission denied
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
group not found
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
internal server error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Status">Status</a></h1>
|
|
<div class="method"><a name="status"></a>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /status</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">status</span>)</div>
|
|
<div class="method-notes">Websocket placeholder endpoint for receiving account status updates</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Awaiting announce
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
<h2><a name="__Models">Models</a></h2>
|
|
[ Jump to <a href="#__Methods">Methods</a> ]
|
|
|
|
<h3>Table of Contents</h3>
|
|
<ol>
|
|
<li><a href="#Account"><code>Account</code></a></li>
|
|
<li><a href="#Announce"><code>Announce</code></a></li>
|
|
<li><a href="#App"><code>App</code></a></li>
|
|
<li><a href="#AppData"><code>AppData</code></a></li>
|
|
<li><a href="#Article"><code>Article</code></a></li>
|
|
<li><a href="#Asset"><code>Asset</code></a></li>
|
|
<li><a href="#Authenticate"><code>Authenticate</code></a></li>
|
|
<li><a href="#Card"><code>Card</code></a></li>
|
|
<li><a href="#CardData"><code>CardData</code></a></li>
|
|
<li><a href="#CardProfile"><code>CardProfile</code></a></li>
|
|
<li><a href="#CardView"><code>CardView</code></a></li>
|
|
<li><a href="#Connect"><code>Connect</code></a></li>
|
|
<li><a href="#DataMessage"><code>DataMessage</code></a></li>
|
|
<li><a href="#Dialogue"><code>Dialogue</code></a></li>
|
|
<li><a href="#Dialogue_insights"><code>Dialogue_insights</code></a></li>
|
|
<li><a href="#Disconnect"><code>Disconnect</code></a></li>
|
|
<li><a href="#Group"><code>Group</code></a></li>
|
|
<li><a href="#Insight"><code>Insight</code></a></li>
|
|
<li><a href="#Label"><code>Label</code></a></li>
|
|
<li><a href="#Profile"><code>Profile</code></a></li>
|
|
<li><a href="#ProfileData"><code>ProfileData</code></a></li>
|
|
<li><a href="#Status"><code>Status</code></a></li>
|
|
<li><a href="#Subject"><code>Subject</code></a></li>
|
|
<li><a href="#Tag"><code>Tag</code></a></li>
|
|
<li><a href="#Topic"><code>Topic</code></a></li>
|
|
<li><a href="#Tunnel"><code>Tunnel</code></a></li>
|
|
<li><a href="#articleId_assets_body"><code>articleId_assets_body</code></a></li>
|
|
<li><a href="#articleId_subject_body"><code>articleId_subject_body</code></a></li>
|
|
<li><a href="#content_articles_body"><code>content_articles_body</code></a></li>
|
|
<li><a href="#content_labels_body"><code>content_labels_body</code></a></li>
|
|
<li><a href="#dialogueId_subject_body"><code>dialogueId_subject_body</code></a></li>
|
|
<li><a href="#groups_groupId_body"><code>groups_groupId_body</code></a></li>
|
|
<li><a href="#inline_response_200"><code>inline_response_200</code></a></li>
|
|
<li><a href="#inline_response_200_1"><code>inline_response_200_1</code></a></li>
|
|
<li><a href="#inline_response_200_2"><code>inline_response_200_2</code></a></li>
|
|
<li><a href="#inline_response_201"><code>inline_response_201</code></a></li>
|
|
<li><a href="#inline_response_201_1"><code>inline_response_201_1</code></a></li>
|
|
<li><a href="#labels_labelId_body"><code>labels_labelId_body</code></a></li>
|
|
<li><a href="#share_groups_body"><code>share_groups_body</code></a></li>
|
|
<li><a href="#topicId_assets_body"><code>topicId_assets_body</code></a></li>
|
|
<li><a href="#topicId_subject_body"><code>topicId_subject_body</code></a></li>
|
|
<li><a href="#topicId_tags_body"><code>topicId_tags_body</code></a></li>
|
|
</ol>
|
|
|
|
<div class="model">
|
|
<h3><a name="Account"><code>Account</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">accountId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">profile </div><div class="param-desc"><span class="param-type"><a href="#Profile">Profile</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Announce"><code>Announce</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">appToken </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="App"><code>App</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">appId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">appData </div><div class="param-desc"><span class="param-type"><a href="#AppData">AppData</a></span> </div>
|
|
<div class="param">attached </div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="AppData"><code>AppData</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">url (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">image (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> format: base64 encoded image</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Article"><code>Article</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">articleId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">revision </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">status </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">unconfirmed</div><div class="param-enum">confirmed</div><div class="param-enum">complete</div><div class="param-enum">error</div>
|
|
<div class="param">subject </div><div class="param-desc"><span class="param-type"><a href="#Subject">Subject</a></span> </div>
|
|
<div class="param">labels </div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
|
|
<div class="param">groups (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
|
|
<div class="param">tagCount </div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
|
|
<div class="param">tagUpdate (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
|
|
<div class="param">tagRevision </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Asset"><code>Asset</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">assetId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">transform (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">status (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">pending</div><div class="param-enum">processing</div><div class="param-enum">ready</div><div class="param-enum">error</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Authenticate"><code>Authenticate</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">token </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">timestamp </div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Card"><code>Card</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">cardId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">cardProfile </div><div class="param-desc"><span class="param-type"><a href="#CardProfile">CardProfile</a></span> </div>
|
|
<div class="param">cardData </div><div class="param-desc"><span class="param-type"><a href="#CardData">CardData</a></span> </div>
|
|
<div class="param">contentRevision </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">converstaionRevision (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="CardData"><code>CardData</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">revision (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">status </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">pending</div><div class="param-enum">confirmed</div><div class="param-enum">requested</div><div class="param-enum">connecting</div><div class="param-enum">connected</div>
|
|
<div class="param">notes (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">token (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">groups (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="CardProfile"><code>CardProfile</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">handle (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">location (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">revision (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">imageSet (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">node </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="CardView"><code>CardView</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">cardId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">cardRevision </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">profileRevision </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">contentRevision </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">converstaionRevision (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Connect"><code>Connect</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">requestorcardId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">requestedcardId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">timestamp </div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
|
|
<div class="param">profile </div><div class="param-desc"><span class="param-type"><a href="#Profile">Profile</a></span> </div>
|
|
<div class="param">token </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">contentRevision </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="DataMessage"><code>DataMessage</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">messageType </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">Connect</div><div class="param-enum">Disconnect</div><div class="param-enum">Profile</div><div class="param-enum">Authenticate</div>
|
|
<div class="param">message </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> format: base64 encoded object</div>
|
|
<div class="param">keyType </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">RSA4096</div><div class="param-enum">RSA2048</div>
|
|
<div class="param">publicKey </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> format: base64 encoding of account key</div>
|
|
<div class="param">signature </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> format: base64 encoding of message signature</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Dialogue"><code>Dialogue</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">dialogueId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">revision </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">active </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">subject </div><div class="param-desc"><span class="param-type"><a href="#Subject">Subject</a></span> </div>
|
|
<div class="param">insights </div><div class="param-desc"><span class="param-type"><a href="#Dialogue_insights">array[Dialogue_insights]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Dialogue_insights"><code>Dialogue_insights</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">cardId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">status (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">active</div><div class="param-enum">offsync</div><div class="param-enum">inactive</div><div class="param-enum">dismissed</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Disconnect"><code>Disconnect</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">requestorId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">requestedId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">timestamp </div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Group"><code>Group</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">subject </div><div class="param-desc"><span class="param-type"><a href="#Subject">Subject</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Insight"><code>Insight</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">insightId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">revision </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">cardId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">status </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">active</div><div class="param-enum">inactive</div><div class="param-enum">dismissed</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Label"><code>Label</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">subject </div><div class="param-desc"><span class="param-type"><a href="#Subject">Subject</a></span> </div>
|
|
<div class="param">groups (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Profile"><code>Profile</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">did </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">handle (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">location (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">image (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> format: base64 encoded data</div>
|
|
<div class="param">revision </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">version (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">node </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="ProfileData"><code>ProfileData</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">handle (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">location (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">image (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Status"><code>Status</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">profile </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">content </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">label </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">share </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">card </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">dialogue </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">insight </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Subject"><code>Subject</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">subjectId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">revision </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">data </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">created </div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Tag"><code>Tag</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">cardId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">subject </div><div class="param-desc"><span class="param-type"><a href="#Subject">Subject</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Topic"><code>Topic</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">articleId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">revision </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">status </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">unconfirmed</div><div class="param-enum">confirmed</div><div class="param-enum">complete</div><div class="param-enum">error</div>
|
|
<div class="param">subject </div><div class="param-desc"><span class="param-type"><a href="#Subject">Subject</a></span> </div>
|
|
<div class="param">tagCount </div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
|
|
<div class="param">tagUpdate (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
|
|
<div class="param">tagRevision </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Tunnel"><code>Tunnel</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">cardId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">data (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="articleId_assets_body"><code>articleId_assets_body</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">fileName (optional)</div><div class="param-desc"><span class="param-type"><a href="#binary">byte[]</a></span> format: binary</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="articleId_subject_body"><code>articleId_subject_body</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">data </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="content_articles_body"><code>content_articles_body</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">labels </div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
|
|
<div class="param">groups </div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="content_labels_body"><code>content_labels_body</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">data </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="dialogueId_subject_body"><code>dialogueId_subject_body</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">data </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="groups_groupId_body"><code>groups_groupId_body</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">data </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="inline_response_200"><code>inline_response_200</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">token (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">status </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">pending</div><div class="param-enum">confirmed</div><div class="param-enum">requested</div><div class="param-enum">connecting</div><div class="param-enum">connected</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="inline_response_200_1"><code>inline_response_200_1</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">revision (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="inline_response_200_2"><code>inline_response_200_2</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">blockId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">blockRevision (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">tag (optional)</div><div class="param-desc"><span class="param-type"><a href="#Tag">Tag</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="inline_response_201"><code>inline_response_201</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">blockId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">blockRevision (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">article (optional)</div><div class="param-desc"><span class="param-type"><a href="#Article">Article</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="inline_response_201_1"><code>inline_response_201_1</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">blockId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">blockRevision (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">topic (optional)</div><div class="param-desc"><span class="param-type"><a href="#Topic">Topic</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="labels_labelId_body"><code>labels_labelId_body</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">data </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="share_groups_body"><code>share_groups_body</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">data </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="topicId_assets_body"><code>topicId_assets_body</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">fileName (optional)</div><div class="param-desc"><span class="param-type"><a href="#binary">byte[]</a></span> format: binary</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="topicId_subject_body"><code>topicId_subject_body</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">data </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="topicId_tags_body"><code>topicId_tags_body</code></a> <a class="up" href="#__Models">Up</a></h3>
|
|
|
|
<div class="field-items">
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">data </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
</body>
|
|
</html>
|