Content

The process for creating Tagged Content through the dialogportal™ REST API is as follows:

  1. Use endpoint 9001: Create content to create a content item, marked with 1 or more tags. The new content is unpublished - it cannot be accessed yet.
  2. Entities may now optionally be connected to the content using endpoint 9002: Connect entity. If any entities are connected to the content, then it can only be accessed privately (using a dp-key or ext-key/ext-type). If no entities are connected to the content then it can be accessed publicly.
  3. Publish the content using endpoint 9003: Publish content.

Entities may be connected to content after it is published, but it is a good idea to connect at least one entity to private content before publishing - otherwise there is the possibility of the content being read as public content before the first entity is connected (as soon as the first entity is connected the content becomes private, so can no longer be read as public content).

Once content is published, it can be retrieved using endpoints 9004: Private content search and 9005: Public content search. These search endpoints are very similar, the difference is that endpoint 9004 includes private content for an entity, where endpoint 9005 returns only public content. If the entity has no private content, the 2 endpoints will return exactly the same results.

9001: Create content

Add tagged content to the system. The content must be published using endpoint 9003: Publish content before it can be accessed.

9002: Connect entity

Connect an entity to content. Once content has been connected to at least one entity, it is considered "private", and can only be accessed by entities that have been connected to it.

9002: Connect multiple entities

Connect an array of entities to content.

9003: Publish content

Publish content, making it available to be used in search results.

9004: Private content search

Search for content available to a specific entity. The result may also include public content.

9005: Public content search

Search for publicly available content

9006: Enumerate tags

Fetch a list of all tags

9007: Remove content

Remove a tagged content item. Individual content items may be removed from the system, when they can be uniquely matched on tags and data.

9008: Reconnect entities

Replace the currently connected entities with a new array of entities. All previous connections will be removed for the content and the new array of entities connected instead.