DataBag
DataBag provides storage for decentralized identity based self-hosting apps.
It is intended to support sharing of personal data and hosting group
conversations.
Version: 0.0.1
Apache 2.0
http://www.apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
(addAccount)
Add a new account. Basic auth will be used for the accounts username and password. Access granted to valid create account token.
Return type
Example data
Content-Type: application/json
{
"image" : "image",
"node" : "node",
"name" : "name",
"description" : "description",
"handle" : "handle",
"location" : "location",
"version" : "version",
"did" : "did",
"revision" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
successful operation
Profile
400
invalid handle or password
401
invalid bearer token
500
internal server error
(addAccountApp)
Generate token to attach an app to the account. Access granted to account's username and password.
Return type
String
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
generated
String
401
invalid password
500
internal server error
(addAccountAuthentication)
Generate token to reset authentication. Access granted to account's login and password.
Return type
String
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
generated
String
401
invalid password
500
internal server error
(getAccountApps)
Get list of attached apps to account. Access granted to account's username and password.
Return type
Example data
Content-Type: application/json
[ {
"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"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
401
permission denied
500
internal server error
Up
get /account/profile/image
(getAccountImage)
Get profile image. Access granted to account's username and password
Return type
byte[]
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
byte[]
401
permission denied
405
invalid image
500
internal server error
(getAccountProfile)
Get account profile. Access granted to account's username and password.
Return type
Example data
Content-Type: application/json
{
"image" : "image",
"node" : "node",
"name" : "name",
"description" : "description",
"handle" : "handle",
"location" : "location",
"version" : "version",
"did" : "did",
"revision" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Profile
401
authentication error
500
internal server error
(getAccountToken)
Check if account reset token or account create token is valid. Access granted to valid create or reset token.
Responses
200
success
401
permission denied
500
internal server error
Up
get /account/claimable
(getAccountUsername)
Check if username is available. Access granted account reset token or account create token.
Query parameters
username (required)
Query Parameter — username to check
Responses
200
success
401
permission denied
406
username already claimed
500
internal server error
Up
delete /account/apps/{appId}
(removeAccountApp)
Get list of attached apps. Access granted to account's username and password.
Path parameters
appId (required)
Path Parameter — specified app id
Responses
200
successful operation
401
invalid password
404
app not found
500
internal server error
(setAccountApp)
Apply the token to attach an app to the account. Access granted to valid attach token.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
String
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
generated
String
401
invalid token
406
app limit reached
500
internal server error
(setAccountAuthentication)
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.
Responses
201
success
401
permission denied
500
internal server error
(addNodeAccount)
Gernerate a url for creating a new account. Access granted to admin username and password.
Return type
String
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
generated
String
401
invalid password
500
internal server error
Up
get /admin/accounts/{accountId}/image
(getNodeAccountImage)
Get profile image of specified account. Access granted to admin username and password
Path parameters
accountId (required)
Path Parameter — id of specified account
Return type
byte[]
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
byte[]
401
permission denied
405
invalid image
500
internal server error
(getNodeAccounts)
Get list of accounts hosted on node. Access granted to admin username and password.
Return type
Example data
Content-Type: application/json
[ {
"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
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
401
invalid password
404
handle not found
500
internal server error
(getNodeClaimable)
Check if portal params have been set
Responses
200
success
406
node already claimed
500
internal server error
Up
delete /admin/accounts/{accountId}
(removeNodeAccount)
Remove account from node. Access granted to admin username and password.
Path parameters
accountId (required)
Path Parameter — id of account to delete
Responses
200
successful operation
401
invalid authentication
404
account not found
500
internal server error
Up
put /admin/accounts/{accountId}/reset
(setNodeAccount)
Generate a password reset url for specified account. Access granted to admin username and password.
Path parameters
accountId (required)
Path Parameter — id of profile to access
Return type
String
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
generated
String
401
invalid password
404
unknown portal
500
internal server error
(setNodeConfig)
Set admin password and node domain
Query parameters
domain (required)
Query Parameter — domain of node
Responses
200
success
401
permission denied
500
internal server error
Up
put /admin/config/domain
(setNodeConfigDomain)
Set portal domain to be set in profile queries. Access granted to admin username and password.
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
success
401
permission denide
500
internal server error
(authenticate)
Retrieve an authenticate data messaging verifying the account holder is accepting the action referenced by the token.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"messageType" : "Connect",
"signature" : "signature",
"publicKey" : "publicKey",
"message" : "message",
"keyType" : "RSA4096"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
DataMessage
401
permission denied
500
internal server error
(addCard)
Add a contact card. Access granted to app tokens of account holder.
Return type
Example data
Content-Type: application/json
{
"messageType" : "Connect",
"signature" : "signature",
"publicKey" : "publicKey",
"message" : "message",
"keyType" : "RSA4096"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
DataMessage
400
invalid data message
401
permission denied
500
internal server error
Up
delete /contact/cards/{cardId}/groups/{groupId}
(clearCardGroup)
Clear sharing group for card. Access granted to app tokens for account holder.
Path parameters
cardId (required)
Path Parameter — specified card id
groupId (required)
Path Parameter — specified share id
Return type
Example data
Content-Type: application/json
{
"notes" : "notes",
"groups" : [ "groups", "groups" ],
"revision" : 6,
"status" : "pending",
"token" : "token"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
CardData
401
permission denied
404
card or group not found
500
internal server error
Up
delete /contact/cards/{cardId}/notes
(clearCardNotes)
Clear notes for specified card. Access granted to app tokens of account holder.
Path parameters
cardId (required)
Path Parameter — specified card id
Return type
Example data
Content-Type: application/json
{
"notes" : "notes",
"groups" : [ "groups", "groups" ],
"revision" : 6,
"status" : "pending",
"token" : "token"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
CardData
401
permission denied
404
card not found
500
internal server error
Up
get /contact/cards/{cardId}
(getCard)
Retieve card entry. Permission granted to app tokens for account holder.
Path parameters
cardId (required)
Path Parameter — specified card id
Return type
Example data
Content-Type: application/json
{
"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
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Card
401
permission denied
404
card not found
500
internal server error
Up
get /contact/cards/{cardId}/data
(getCardData)
Get specified card data. Access granted to app tokens for account holder.
Path parameters
cardId (required)
Path Parameter — specified card id
Return type
Example data
Content-Type: application/json
{
"notes" : "notes",
"groups" : [ "groups", "groups" ],
"revision" : 6,
"status" : "pending",
"token" : "token"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
CardData
401
permission denied
404
card not found
500
internal server error
Up
get /contact/cards/{cardId}/profile
(getCardProfile)
Get profile of card entry. Access granted to app tokens of account holder.
Path parameters
cardId (required)
Path Parameter — specified card id
Return type
Example data
Content-Type: application/json
{
"node" : "node",
"imageSet" : true,
"name" : "name",
"description" : "description",
"handle" : "handle",
"location" : "location",
"revision" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
CardProfile
401
permission denied
404
not found
500
internal server error
Up
get /contact/cards/{cardId}/profile/image
(getCardProfileImage)
Get image of card profile. Access granted to app tokens of account holder.
Path parameters
cardId (required)
Path Parameter — specified card id
Return type
byte[]
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
byte[]
401
permission denied
404
card not found
405
invalid image
500
internal server error
Up
get /contact/cards/view
(getCardView)
Get list of card views. Access granted to app tokens of account holder.
Return type
Example data
Content-Type: application/json
[ {
"cardRevision" : 0,
"profileRevision" : 6,
"cardId" : "cardId",
"converstaionRevision" : 5,
"contentRevision" : 1
}, {
"cardRevision" : 0,
"profileRevision" : 6,
"cardId" : "cardId",
"converstaionRevision" : 5,
"contentRevision" : 1
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
401
permission denied
500
internal server error
Up
get /contact/cards/{cardId}/closeMessage
(getCloseMessage)
Get message for closing connection with contact. Access granted to app tokens for account holder.
Path parameters
cardId (required)
Path Parameter — specified card id
Return type
Example data
Content-Type: application/json
{
"messageType" : "Connect",
"signature" : "signature",
"publicKey" : "publicKey",
"message" : "message",
"keyType" : "RSA4096"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
DataMessage
401
permission denied
404
card not found
500
internal server error
Up
get /contact/cards/{cardId}/openMessage
(getOpenMessage)
Get message for connecting to other contacts. Access granted to app tokens for account holder.
Path parameters
cardId (required)
Path Parameter — specified card id
Return type
Example data
Content-Type: application/json
{
"messageType" : "Connect",
"signature" : "signature",
"publicKey" : "publicKey",
"message" : "message",
"keyType" : "RSA4096"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
DataMessage
401
permission denied
404
card not found
500
internal server error
Up
delete /contact/cards/{cardId}
(removeCard)
Remove card entry. Access granted to app tokens of account holder.
Path parameters
cardId (required)
Path Parameter — specified card id
Responses
200
success
401
permission denied
404
card not found
500
internal server error
Up
put /contact/cards/{cardId}/groups/{groupId}
(setCardGroup)
Set sharing group for contact. Access granted to app tokens for account holder.
Path parameters
cardId (required)
Path Parameter — specified card id
groupId (required)
Path Parameter — specified group id
Return type
Example data
Content-Type: application/json
{
"notes" : "notes",
"groups" : [ "groups", "groups" ],
"revision" : 6,
"status" : "pending",
"token" : "token"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
CardData
401
permission denied
404
card or group not found
500
internal server error
Up
put /contact/cards/{cardId}/notes
(setCardNotes)
Update card notes for specified card. Access granted to app tokens for account holder.
Path parameters
cardId (required)
Path Parameter — specified card id
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"notes" : "notes",
"groups" : [ "groups", "groups" ],
"revision" : 6,
"status" : "pending",
"token" : "token"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
CardData
401
permission denied
404
card not found
500
internal server error
Up
put /contact/cards/{cardId}/profile
(setCardProfile)
Set profile of card entry. Access granted to app tokens of account holder.
Path parameters
cardId (required)
Path Parameter — specified card id
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"messageType" : "Connect",
"signature" : "signature",
"publicKey" : "publicKey",
"message" : "message",
"keyType" : "RSA4096"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
DataMessage
401
permission denied
404
card not found
500
internal server error
Up
put /contact/cards/{cardId}/status
(setCardStatus)
Updated connected status of contact. Access granted to app tokens of account holder.
Path parameters
cardId (required)
Path Parameter — specified card id
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
token (optional)
Query Parameter — token for accessing card
Return type
Example data
Content-Type: application/json
{
"notes" : "notes",
"groups" : [ "groups", "groups" ],
"revision" : 6,
"status" : "pending",
"token" : "token"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
CardData
401
permission denied
404
card not found
500
internal server error
Up
put /contact/closeMessage
(setCloseMessage)
Set message for closing card connection. Access granted to public.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"token" : "token",
"status" : "pending"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
inline_response_200
400
invalid data message
500
internal server error
Up
put /contact/content/revision
(setContentRevision)
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.
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
revision set
401
not authorized
500
internal server error
Up
put /contact/openMessage
(setOpenMessage)
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.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"token" : "token",
"status" : "pending"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
inline_response_200
400
invalid data message
500
internal server error
Up
put /contact/profile/revision
(setProfileRevision)
Set profile revision for contact. This is intend to be invoked automatically anytime a contact updates their profile. Access granted to contact tokens.
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
revision set
401
not authorized
500
internal server error
Up
post /content/articles
(addArticle)
Add a content article. Access granted to app token of the account holder.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"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" ]
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
entry created
inline_response_201
401
permission denied
500
internal server error
Up
post /content/articles/{articleId}/assets
(addArticleAsset)
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.
Path parameters
articleId (required)
Path Parameter — specified article id
Consumes
This API call consumes the following media types via the request header:
Query parameters
transforms (optional)
Query Parameter — transforms to apply
Form parameters
fileName (optional)
Form Parameter — format: binary
Return type
Example data
Content-Type: application/json
{
"transform" : "transform",
"assetId" : "assetId",
"status" : "pending"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
success
Asset
401
permission denied
404
article not found
406
storage limit reached
500
internal server error
Up
post /content/articles/{articleId}/tags
(addArticleTag)
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.
Path parameters
articleId (required)
Path Parameter — specified article id
Return type
Example data
Content-Type: application/json
{
"blockId" : "blockId",
"tag" : {
"subject" : {
"data" : "data",
"created" : 6,
"type" : "type",
"subjectId" : "subjectId",
"revision" : 0
},
"cardId" : "cardId"
},
"blockRevision" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
inline_response_200_2
401
permission denied
404
article not found
500
internal server error
(addLabel)
Add a new label for organizing the articles. Access granted to the app tokens of the account holder.
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
success
401
permission denied
500
internal server error
Up
delete /content/articles/{articleId}/groups/{groupId}
(clearArticleGroup)
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.
Path parameters
articleId (required)
Path Parameter — specified article id
groupId (required)
Path Parameter — specified share id
Responses
200
success
401
permission denied
404
group or article not found
500
internal server error
Up
delete /content/articles/{articleId}/labels/{labelId}
(clearArticleLabel)
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.
Path parameters
articleId (required)
Path Parameter — specified article id
labelId (required)
Path Parameter — specified label id
Responses
200
success
401
permission denied
404
label or article not found
500
internal server error
Up
delete /content/labels/{labelId}/groups/{groupId}
(clearLabelGroup)
Clear a sharing group from a label. Access granted to app tokens of the account holder.
Path parameters
labelId (required)
Path Parameter — specified label id
groupId (required)
Path Parameter — specified group id
Responses
200
success
401
permission denied
404
group or label not found
500
internal server error
Up
get /content/articles/{articleId}
(getArticle)
Get specified article. Access granted to app token of account holder or contact token of account the article is shared with.
Path parameters
articleId (required)
Path Parameter — specified article id
Return type
Example data
Content-Type: application/json
{
"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" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
Article
401
permission denied
404
article not found
500
internal server error
Up
get /content/articles/{articleId}/assets/{assetId}
(getArticleAsset)
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.
Path parameters
articleId (required)
Path Parameter — specified article id
assetId (required)
Path Parameter — specified asset id
Return type
byte[]
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
byte[]
401
permission denied
404
asset or article not found
500
internal server error
Up
get /content/articles/{articleId}/assets
(getArticleAssets)
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.
Path parameters
articleId (required)
Path Parameter — specified article id
Return type
Example data
Content-Type: application/json
[ {
"transform" : "transform",
"assetId" : "assetId",
"status" : "pending"
}, {
"transform" : "transform",
"assetId" : "assetId",
"status" : "pending"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
entry created
401
invalid token
500
internal server error
Up
get /content/articleBlocks/view
(getArticleBlockView)
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.
Return type
Example data
Content-Type: application/json
[ {
"id" : "id",
"revision" : 0
}, {
"id" : "id",
"revision" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
401
permission denied
500
internal server error
Up
get /content/articles/{articleId}/subject/{field}
(getArticleSubjectField)
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.
Path parameters
articleId (required)
Path Parameter — specified article id
field (required)
Path Parameter — field from subject to base64 decode and download
Return type
Example data
Content-Type: application/json
{
"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" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
Article
401
permission denied
404
field, article not found
405
invalid field
500
internal server error
Up
get /content/articles/{articleId}/tags/{tagId}
(getArticleTag)
Get specified tag. Access granted to app tokens of account holder and contact tokens of accounts with which the article is shared.
Path parameters
articleId (required)
Path Parameter — specified article id
tagId (required)
Path Parameter — specified tag id
Return type
Example data
Content-Type: application/json
{
"subject" : {
"data" : "data",
"created" : 6,
"type" : "type",
"subjectId" : "subjectId",
"revision" : 0
},
"cardId" : "cardId"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
Tag
401
permission denied
404
tag or article not found
500
internal server error
Up
get /content/articles/{articleId}/tagBlocks/view
(getArticleTagBlockView)
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.
Path parameters
articleId (required)
Path Parameter — specified article id
Query parameters
types (optional)
Query Parameter — limit results to tags of types
Return type
Example data
Content-Type: application/json
[ {
"id" : "id",
"revision" : 0
}, {
"id" : "id",
"revision" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
401
permission denied
404
article not found
500
internal server error
Up
get /content/articles/{articleId}/tags/{tagId}/subject/{field}
(getArticleTagSubjectField)
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.
Path parameters
articleId (required)
Path Parameter — specified article id
tagId (required)
Path Parameter — specified tag id
field (required)
Path Parameter — field to base64 decode and transfer
Return type
Example data
Content-Type: application/json
{
"subject" : {
"data" : "data",
"created" : 6,
"type" : "type",
"subjectId" : "subjectId",
"revision" : 0
},
"cardId" : "cardId"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
Tag
401
permission denied
404
field, tag or article not found
405
invalid field
500
internal server error
Up
get /content/articles/{articleId}/tagBlocks/{blockId}/view
(getArticleTagView)
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.
Path parameters
articleId (required)
Path Parameter — specified article id
blockId (required)
Path Parameter — specified block id
Query parameters
types (optional)
Query Parameter — limit results to tags of types
Return type
Example data
Content-Type: application/json
[ {
"id" : "id",
"revision" : 0
}, {
"id" : "id",
"revision" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
401
permission denied
404
block or article not found
500
internal server error
Up
get /content/articles/{articleId}/tagBlocks/{blockId}
(getArticleTags)
Get tags within specified block. Access granted to app tokens of account holder and contact tokens of accounts with which the article is shared.
Path parameters
articleId (required)
Path Parameter — specified article id
blockId (required)
Path Parameter — specified block id
Query parameters
types (optional)
Query Parameter — limit results to tags of types
Return type
Example data
Content-Type: application/json
[ {
"id" : "id",
"revision" : 0
}, {
"id" : "id",
"revision" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
401
permission denied
404
block or article not found
500
internal server error
Up
get /content/articleBlocks/{blockId}/view
(getArticleViews)
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.
Path parameters
blockId (required)
Path Parameter — specified group id
Return type
Example data
Content-Type: application/json
[ {
"id" : "id",
"revision" : 0
}, {
"id" : "id",
"revision" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
401
permission denied
404
block not found
500
internal server error
Up
get /content/articleBlocks/{blockId}
(getArticles)
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.
Path parameters
blockId (required)
Path Parameter — specified group id
Return type
Example data
Content-Type: application/json
[ {
"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" ]
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
401
permission denied
404
block not found
500
internal server error
(getLabels)
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.
Return type
Example data
Content-Type: application/json
[ {
"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" ]
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
401
invalid token
500
internal server error
Up
delete /content/articles/{articleId}
(removeArticle)
Remove specified article. Access granted to app token of account holder.
Path parameters
articleId (required)
Path Parameter — specified article id
Responses
200
success
401
invalid password
404
article not found
500
internal server error
Up
delete /content/articles/{articleId}/assets/{assetId}
(removeArticleAsset)
Remove an asset from an article. Access granted to app tokens of the account holder.
Path parameters
articleId (required)
Path Parameter — specified article id
assetId (required)
Path Parameter — specified asset id
Responses
200
success
401
permission denied
404
asset or article not found
500
internal server error
Up
delete /content/articles/{articleId}/tags/{tagId}
(removeArticleTag)
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.
Path parameters
articleId (required)
Path Parameter — specified article id
tagId (required)
Path Parameter — specified tag id
Responses
200
success
401
permission denied
404
tag or article not found
500
internal server error
Up
delete /content/labels/{labelId}
(removeLabel)
Remove specified label. Access granted the the app tokens of the account holder.
Path parameters
labelId (required)
Path Parameter — specified label id
Responses
200
success
401
permission denied
404
label not found
500
internal server error
Up
put /content/articles/{articleId}/confirmed
(setArticleConfirmed)
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.
Path parameters
articleId (required)
Path Parameter — specified article id
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
success
401
permission denied
404
article not found
500
internal server error
Up
post /content/articles/{articleId}/groups/{groupId}
(setArticleGroup)
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.
Path parameters
articleId (required)
Path Parameter — specified article id
groupId (required)
Path Parameter — specified share group id
Responses
200
success
401
permission denied
404
group or article not found
500
internal server error
Up
post /content/articles/{articleId}/labels/{labelId}
(setArticleLabel)
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.
Path parameters
articleId (required)
Path Parameter — specified article id
labelId (required)
Path Parameter — specified label id
Responses
200
success
401
permission denied
404
label or article not found
500
internal server error
Up
put /content/articles/{articleId}/subject
(setArticleSubject)
Set subject for article. Access granted to app token of account holder.
Path parameters
articleId (required)
Path Parameter — specified article id
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
success
401
permission denied
404
article not found
500
internal server error
Up
post /content/labels/{labelId}/groups/{groupId}
(setLabelGroup)
Set a sharing group for the label and articles assigned to the label. Access granted to app tokens of the account holder.
Path parameters
labelId (required)
Path Parameter — specified label id
groupId (required)
Path Parameter — specified group id
Responses
200
success
401
permission denied
404
group or label not found
500
internal server error
Up
put /content/labels/{labelId}
(updateLabel)
Update specified label. Access granted to app tokens of the account holder.
Path parameters
labelId (required)
Path Parameter — specified group id
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
successful operation
401
invalid token
500
internal server error
Up
post /conversation/dialogues
(addDialogue)
Create and host a new dialogue. Authroization granted to an app token of the account holder.
Return type
Example data
Content-Type: application/json
[ {
"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
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
401
permission denied
500
internal server error
Up
put /conversation/dialogues/{dialogueId}/cards/{cardId}
(addDialogueInsight)
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.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
cardId (required)
Path Parameter — specified card id
Responses
200
success
401
permission denied
404
cardId or dialogue not found
500
internal server error
Up
post /conversation/dialogues/{dialogueId}/topics
(addDialogueTopic)
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.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
Return type
Example data
Content-Type: application/json
{
"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
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
entry created
inline_response_201_1
401
permission denied
403
inactive dialogue
404
dialogue not found
500
internal server error
Up
post /conversation/insights/{dialogueId}
(addInsightDialogue)
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.
Path parameters
dialogueId (required)
Path Parameter — dialogue with insight id to update
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
String
Example data
Content-Type: application/json
"active"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
String
401
permission denied
404
dialogue not found
500
internal server error
Up
post /conversation/dialogues/{dialogueId}/topics/{topicId}/assets
(addTopicAsset)
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.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
topicId (required)
Path Parameter — specified topic id
Consumes
This API call consumes the following media types via the request header:
Query parameters
transforms (optional)
Query Parameter — transforms to apply
Form parameters
fileName (optional)
Form Parameter — format: binary
Return type
Example data
Content-Type: application/json
{
"transform" : "transform",
"assetId" : "assetId",
"status" : "pending"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
success
Asset
401
permission denied
403
inactive dialogue
404
topic or dialogue not found
500
internal server error
Up
post /conversation/dialogues/{dialogueId}/topics/{topicId}/tags
(addTopicTag)
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.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
topicId (required)
Path Parameter — specified topic id
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"blockId" : "blockId",
"tag" : {
"subject" : {
"data" : "data",
"created" : 6,
"type" : "type",
"subjectId" : "subjectId",
"revision" : 0
},
"cardId" : "cardId"
},
"blockRevision" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
entry created
inline_response_200_2
401
permission denied
403
inactive dialogue
404
topic or dialogue not found
500
internal server error
Up
put /conversation/dialogues/{dialogueId}/topics/{topicId}/confirmed
(conversationDialoguesDialogueIdTopicsTopicIdConfirmedPut)
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.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
topicId (required)
Path Parameter — specified topic id
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
success
401
permission denied
403
inactive dialogue
404
topic or dialogue not found
500
internal server error
Up
get /conversation/dialogues/{dialogueId}/topics/{topicId}
(getDialogueTopic)
Retrieve a specified dialogue topic. Authorization granted to account holder app token or dialogue member contact token who is a member of the dialogue.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
topicId (required)
Path Parameter — specified topic id
Return type
Example data
Content-Type: application/json
{
"subject" : {
"data" : "data",
"created" : 6,
"type" : "type",
"subjectId" : "subjectId",
"revision" : 0
},
"articleId" : "articleId",
"tagUpdate" : 1,
"tagCount" : 6,
"tagRevision" : 5,
"revision" : 0,
"status" : "unconfirmed"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Topic
401
permission denied
404
topic or dialogue not found
500
internal server error
Up
get /conversation/dialogues/{dialogueId}/topics/{topicId}/subject/{field}
(getDialogueTopicSubjectField)
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.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
topicId (required)
Path Parameter — specified topic id
field (required)
Path Parameter — field to base64 decode and retrieve
Return type
byte[]
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
byte[]
401
permission denied
404
field, topic or dialogue not found
405
invalid field
500
internal server error
Up
get /conversation/dialogues
(getDialogues)
Retrieve all dialogues.
Return type
Example data
Content-Type: application/json
[ {
"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
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
401
permission denied
500
internal server error
Up
get /conversation/insights
(getInsights)
Retrieve all insights. Access granted to app token for the account holder.
Query parameters
dismissed (optional)
Query Parameter — if dismissed insights should be included
Return type
Example data
Content-Type: application/json
[ {
"cardId" : "cardId",
"insightId" : "insightId",
"revision" : 0,
"status" : "active"
}, {
"cardId" : "cardId",
"insightId" : "insightId",
"revision" : 0,
"status" : "active"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
401
permission denied
500
internal server error
Up
get /conversation/dialogues/{dialogueId}/topics/{topicId}/assets/{assetId}
(getTopicAsset)
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.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
topicId (required)
Path Parameter — specified topic id
assetId (required)
Path Parameter — specified asset id
Return type
byte[]
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
byte[]
401
permission denied
404
asset, topic or dialogue not found
500
internal server error
Up
get /conversation/dialogues/{dialogueId}/topics/{topicId}/assets
(getTopicAssets)
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.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
topicId (required)
Path Parameter — specified topic id
Return type
Example data
Content-Type: application/json
[ {
"transform" : "transform",
"assetId" : "assetId",
"status" : "pending"
}, {
"transform" : "transform",
"assetId" : "assetId",
"status" : "pending"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
success
401
permission denied
404
topic or dialogue not found
500
internal server error
Up
get /conversation/dialogues/{dialogueId}/topicBlocks/{blockId}
(getTopicBlock)
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
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
blockId (required)
Path Parameter — specified group id
Query parameters
types (optional)
Query Parameter — limit results to topics of types
Return type
Example data
Content-Type: application/json
[ {
"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"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
401
permission denied
404
block or dialogue not found
500
internal server error
Up
get /conversation/dialogues/{dialogueId}/topicBlocks/view
(getTopicBlockView)
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
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
Query parameters
types (optional)
Query Parameter — limit results to topics of types
Return type
Example data
Content-Type: application/json
[ {
"id" : "id",
"revision" : 0
}, {
"id" : "id",
"revision" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
401
permission denied
404
dialogue not found
500
internal server error
Up
get /conversation/dialogues/{dialogueId}/topics/{topicId}/tags/{tagId}
(getTopicTag)
Retrieve specified tag on the topic. Authorization granted to account holder app token or dialogue member contact token who has access to the topic.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
topicId (required)
Path Parameter — specified topic id
tagId (required)
Path Parameter — specified tag id
Return type
Example data
Content-Type: application/json
{
"subject" : {
"data" : "data",
"created" : 6,
"type" : "type",
"subjectId" : "subjectId",
"revision" : 0
},
"cardId" : "cardId"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
success
Tag
401
permission denied
404
tag, topic, or dialogue not found
500
internal server error
Up
get /conversation/dialogues/{dialogueId}/topics/{topicId}/tagBlocks/view
(getTopicTagBlockView)
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.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
topicId (required)
Path Parameter — specified topic id
Query parameters
types (optional)
Query Parameter — limit results to articles of types
Return type
Example data
Content-Type: application/json
[ {
"id" : "id",
"revision" : 0
}, {
"id" : "id",
"revision" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
401
permission denied
404
topic or dialogue not found
500
internal server error
Up
get /conversation/dialogues/{dialogueId}/topics/{topicId}/tags/{tagId}/subject/{field}
(getTopicTagSubjectField)
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.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
topicId (required)
Path Parameter — specified topic id
tagId (required)
Path Parameter — specified tag id
field (required)
Path Parameter — field to base64 decode and download
Return type
Example data
Content-Type: application/json
{
"subject" : {
"data" : "data",
"created" : 6,
"type" : "type",
"subjectId" : "subjectId",
"revision" : 0
},
"cardId" : "cardId"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
success
Tag
401
permission denied
404
field, tag, topic, or dialogue not found
405
invalid field
500
internal server error
Up
get /conversation/dialogues/{dialogueId}/topics/{topicId}/tagBlocks/{blockId}/view
(getTopicTagView)
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.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
topicId (required)
Path Parameter — specified topic id
blockId (required)
Path Parameter — specified block id
Query parameters
types (optional)
Query Parameter — limit results to tags of types
Return type
Example data
Content-Type: application/json
[ {
"id" : "id",
"revision" : 0
}, {
"id" : "id",
"revision" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
401
permission denied
404
block, topic or dialogue not found
500
internal server error
Up
get /conversation/dialogues/{dialogueId}/topics/{topicId}/tagBlocks/{blockId}
(getTopicTags)
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.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
topicId (required)
Path Parameter — specified topic id
blockId (required)
Path Parameter — specified block id
Query parameters
types (optional)
Query Parameter — limit results to tags of types
Return type
Example data
Content-Type: application/json
[ {
"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"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
401
permission denied
404
block, topic, or dialogue not found
500
internal server error
Up
get /conversation/dialogues/{dialogueId}/topicBlocks/{blockId}/view
(getTopicViews)
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.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
blockId (required)
Path Parameter — specified group id
Query parameters
types (optional)
Query Parameter — limit results to topics of types
Return type
Example data
Content-Type: application/json
[ {
"id" : "id",
"revision" : 0
}, {
"id" : "id",
"revision" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
401
permission denied
404
block or dialogue not found
500
internal server error
Up
delete /conversation/dialogues/{dialogueId}
(removeDialogue)
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.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
Responses
200
success
401
permission denied
404
dialogue not found
500
internal server error
Up
delete /conversation/dialogues/{dialogueId}/cards/{cardId}
(removeDialogueInsight)
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.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
cardId (required)
Path Parameter — specified contact id
Responses
200
success
401
permission denied
404
cardId or dialogue not found
500
internal server error
Up
delete /conversation/dialogues/{dialogueId}/topics/{topicId}
(removeDialogueTopic)
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.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
topicId (required)
Path Parameter — specified topic id
Responses
200
successful operation
401
permission denied
403
inactive dialogue
404
topic or dilaogue not found
500
internal server error
Up
delete /conversation/dialogues/{dialogueId}/topics/{topicId}/assets/{assetId}
(removeTopicAsset)
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.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
topicId (required)
Path Parameter — specified topic id
assetId (required)
Path Parameter — specified asset id
Responses
200
success
401
permission denied
403
inactive dialogue
404
asset, topic or dialogue not found
500
internal server error
Up
delete /conversation/dialogues/{dialogueId}/topics/{topicId}/tags/{tagId}
(removeTopicTag)
Remove specified tag from the topic. Authorization granted to account holder app token or dialogue member contact token who has access to the topic.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
topicId (required)
Path Parameter — specified topic id
tagId (required)
Path Parameter — specified tag id
Responses
200
success
401
permission denied
403
inactive dialogue
404
tag, topic, or dialogue not found
500
internal server error
Up
put /conversation/dialogues/{dialogueId}/active
(setDialogueActive)
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.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
success
401
permission denied
404
dialogue not found
500
internal server error
Up
put /conversation/dialogues/{dialogueId}/status
(setDialogueInsightStatus)
Set active status for contact on the host node. Access is granted to a contact token for an account with the specified contact
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
success
401
permission denied
404
dialogue not found
500
internal server error
Up
put /conversation/dialogues/{dialogueId}/subject
(setDialogueSubject)
Set the subject for a dialogue. Authorization granted the an app token for the account holder.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
201
success
401
permission denied
404
dialogue not found
500
internal server error
Up
delete /conversation/insights/{dialogueId}
(setInsightDialogue)
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.
Path parameters
dialogueId (required)
Path Parameter — insight id to update
Responses
200
success
401
permission denied
404
dialogue not found
500
internal server error
Up
put /conversation/insights/{insightId}/status
(setInsightStatus)
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.
Path parameters
insightId (required)
Path Parameter — dialogue with insight id to update
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
success
401
permission denied
403
invalid state
404
insight not found
500
internal server error
Up
put /conversation/dialogues/{dialogueId}/topics/{topicId}/subject
(setTopicSubject)
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.
Path parameters
dialogueId (required)
Path Parameter — specified dialogue id
topicId (required)
Path Parameter — specified topic id
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
201
entry created
401
invalid token
403
inactive dialogue
404
topic or dialogue not found
500
internal server error
(getProfile)
Get profile of accunt. Access granted to app token of account holder.
Return type
Example data
Content-Type: application/json
{
"image" : "image",
"node" : "node",
"name" : "name",
"description" : "description",
"handle" : "handle",
"location" : "location",
"version" : "version",
"did" : "did",
"revision" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
Profile
401
permission denied
500
internal server error
(getProfileImage)
Download base64 decoded data of profile image. Access granted to app tokens of account holder.
Return type
byte[]
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
byte[]
401
permission denied
405
invalid image
500
internal server error
(getProfileMessage)
Get a profile data message. Access granted to app token of account holder or contact token of connected contact.
Return type
Example data
Content-Type: application/json
{
"messageType" : "Connect",
"signature" : "signature",
"publicKey" : "publicKey",
"message" : "message",
"keyType" : "RSA4096"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
DataMessage
401
permission denied
500
internal server error
(setProfile)
Set profile data. Access granted to app tokens of account holder.
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
success
401
permission denied
500
internal server error
(addGroup)
Add a group for sharing. Access granted to app tokens of account holder.
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
entry created
401
permission denied
500
internal server error
(getGroups)
Get groups for sharing. Access granted to app tokens of the account holder.
Return type
Example data
Content-Type: application/json
[ {
"subject" : {
"data" : "data",
"created" : 6,
"type" : "type",
"subjectId" : "subjectId",
"revision" : 0
}
}, {
"subject" : {
"data" : "data",
"created" : 6,
"type" : "type",
"subjectId" : "subjectId",
"revision" : 0
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
401
invalid token
500
internal server error
Up
delete /share/groups/{groupId}
(removeGroup)
Remove sharing group
Path parameters
groupId (required)
Path Parameter — specified group id
Responses
200
success
401
permission denied
404
group not found
500
internal server error
Up
put /share/groups/{groupId}
(updateGroup)
Update group description for sharing. Access granted to app tokens of account holder.
Path parameters
groupId (required)
Path Parameter — specified group id
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
success
401
permission denied
404
group not found
500
internal server error
(status)
Websocket placeholder endpoint for receiving account status updates
Responses
200
Awaiting announce
[ Jump to Methods ]
Table of Contents
AccountAnnounceAppAppDataArticleAssetAuthenticateCardCardDataCardProfileCardViewConnectDataMessageDialogueDialogue_insightsDisconnectGroupInsightLabelProfileProfileDataStatusSubjectTagTopicTunnelarticleId_assets_bodyarticleId_subject_bodycontent_articles_bodycontent_labels_bodydialogueId_subject_bodygroups_groupId_bodyinline_response_200inline_response_200_1inline_response_200_2inline_response_201inline_response_201_1labels_labelId_bodyshare_groups_bodytopicId_assets_bodytopicId_subject_bodytopicId_tags_body
name (optional)
description (optional)
url (optional)
image (optional)
String format: base64 encoded image
articleId
revision
status
unconfirmed
confirmed
complete
error
subject
labels
groups (optional)
tagCount
tagUpdate (optional)
tagRevision
assetId
transform (optional)
status (optional)
pending
processing
ready
error
cardId
cardProfile
cardData
contentRevision
converstaionRevision (optional)
revision (optional)
status
pending
confirmed
requested
connecting
connected
notes (optional)
token (optional)
groups (optional)
handle (optional)
name (optional)
description (optional)
location (optional)
revision (optional)
imageSet (optional)
node
cardId
cardRevision
profileRevision
contentRevision
converstaionRevision (optional)
requestorcardId (optional)
requestedcardId (optional)
timestamp
profile
token
contentRevision
messageType
Connect
Disconnect
Profile
Authenticate
message
String format: base64 encoded object
keyType
RSA4096
RSA2048
publicKey
String format: base64 encoding of account key
signature
String format: base64 encoding of message signature
dialogueId
revision
active
subject
insights
cardId (optional)
status (optional)
active
offsync
inactive
dismissed
requestorId
requestedId
timestamp
insightId
revision
cardId
status
active
inactive
dismissed
subject
groups (optional)
did
handle (optional)
name (optional)
description (optional)
location (optional)
image (optional)
String format: base64 encoded data
revision
version (optional)
node
handle (optional)
name (optional)
description (optional)
location (optional)
image (optional)
profile
content
label
share
card
dialogue
insight
subjectId
revision
type
data
created
articleId (optional)
revision
status
unconfirmed
confirmed
complete
error
subject
tagCount
tagUpdate (optional)
tagRevision
cardId
type
data (optional)
token (optional)
status
pending
confirmed
requested
connecting
connected
id (optional)
revision (optional)
blockId (optional)
blockRevision (optional)
tag (optional)
blockId (optional)
blockRevision (optional)
article (optional)
blockId (optional)
blockRevision (optional)
topic (optional)