Creating Annotations - ACS - Reference Guides

ACS Integration Guide

Product
ACS
Platform
7.9
Category
Reference Guides
Language
English
Target Audience
public

To add an annotation to a book, a user, a group, or any knowledge item, a CKS user must use the POST method on the annotation list resource relative to this item.

WADL file

Resource

Method

annotation.wadl

{entity_reference}/
annotation

POST

The following example shows how to create an annotation for the book cks/instance/<service_id>-${Service_Status}/book/13 named pertinence.

The request line is:

POST /cks/instance/<service_id>-${Service_Status}/book/13/annotation?afs:login=login://aeinstein:albert@CKS/<service_id>-${Service_Status}

The request body is:

<result xsi:type="common.annotation.number" xmlns="antidot:cks:input"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<name>pertinence </name>
<values>
<value xsi:type="number">10</value>
</values>
</result>

The reply body is:

<value xsi:type="ws.response" xmlns="antidot:cks:output"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<result xsi:type="common.annotation.number">
<name> pertinence </name>
<values>
<value xsi:type="number">10</value>
</values>
</result>
</value>