Listing Annotations - ACS - Reference Guides

ACS Integration Guide

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

To list annotations of a book, a user, a group, or any knowledge item, a CKS user must use the GET method on the annotation list resource relative to this item.

WADL file

Resource

Method

annotation.wadl

{entity_reference}/
annotation

GET

The following example shows how to list all the annotations for the book /cks/instance/<service_id>-${Service_Status}/book/13.

The request line is:

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

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="ws.filtering.result">
<count>1</count>
<totalCount>1</totalCount>
<values>
<item xsi:type="common.annotation.number">
<name>pertinence </name>
<values>
<value xsi:type="number">10</value>
</values>
</item>
</values>
</result>
</value>