The Annotation service exhibits all the operations available around a document annotations.

Annotations recovery

The examples below show how to retrieve annotations using the various operations of get.

All annotations recovery

REST

GET {{core}}/rest/documents/{documentId}/annotations HTTP/1.1

-- URL parameters --
core: FlowerDocs core host
documentId: identifier of the document where are the annotations to retrieve

-- Headers --
token: {{token}}
Content-Type: application/json

JAVA

@Autowired
private AnnotationService service;

public List<Annotation> get() throws FunctionalException, TechnicalException

	Id documentId = new Id("documentId");
	return service.get(documentId);

Annotation creation

From a json

REST

POST {{core}}/rest/documents/{documentId}/annotations HTTP/1.1

-- URL parameters --
core: FlowerDocs core host
documentId: identifier of the document on which to create annotations

-- Headers --
token: {{token}}
Content-Type: application/json

-- Body (json) --
[

		"color": {
			"b": 0,
			"g": 0,
			"r": 0
		},
		"creationdate": "2025-08-25T12:21:18.497Z",
		"date": "2025-08-25T12:21:18.497Z",
		"document-id": {
			"id": "documentId"
		},
		"flags": {
			"hidden": false,
			"invisible": false,
			"locked": false,
			"norotate": false,
			"noview": false,
			"nozoom": false,
			"obfuscate": false,
			"print": false,
			"readonly": false,
			"togglenoview": false
		},
		"last-modifier": "string",
		"name": {
			"id": "string"
		},
		"opacity": 0,
		"page": 0,
		"rect": {
			"h": 0,
			"w": 0,
			"x": 0,
			"y": 0
		},
		"type": "com.arondor.viewer.annotation.api.CircleElemType",
		"title": "annotationTest"

]

JAVA

@Autowired
private AnnotationService service;

public void create() throws FunctionalException, TechnicalException

	Id documentId = new Id("documentId");

	List<Annotation> annotations = new ArrayList();
	Annotation annotation = new CircleElemType();
	annotation.setId(new AnnotationId(generateRandomString()));
	annotation.setDate(new Date());
	annotation.setSubject(generateRandomString());
	annotation.setDocumentId(new DocumentId("b64_xxx==/0/1"));
	AnnotationFlags flags = new AnnotationFlags();
	annotation.setFlags(flags);
	annotations.add(annotation);
	service.create(documentId, annotations);

From xml

Annotation modification

JAVA

@Autowired
private AnnotationService service;

public void update() throws FunctionalException, TechnicalException

	Id documentId = new Id("documentId");
	List<Annotation> updates = new ArrayList();

	List<Annotation> fetchedAnnotations = annotationService.get(created.getId());
	Annotation annotToUpdate = fetchedAnnotations.get(0);
	annotToUpdate.setColor(new Color(21, 9, 98));
	updates.add(annotToUpdate):

	annotationService.update(documentId, updates);

Annotation deletion

The examples below show how to delete annotations.

Part of annotations deletion

This operation allows to delete some of the annotations of a document

REST

DELETE {{core}}/rest/documents/{documentId}/annotations/{annotationIds} HTTP/1.1

-- URL parameters --
core: FlowerDocs core host
documentId: identifier of the document where are the annotations to delete
annotationIds: identifiers of annotations to delete

-- Header --
token: {{token}}
Content-Type: application/json

JAVA

@Autowired
private AnnotationService service;

public void delete() throws FunctionalException, TechnicalException

	Id documentId = new Id("documentId");

	List<Id> ids = Lists.newArrayList(new Id("annot1"));
	service.delete(documentId, ids);

All annotations deletion

This operation allows to delete all the annotations of a document.

REST

DELETE {{core}}/rest/documents/{documentId}/annotations/allAnnotations HTTP/1.1

-- URL parameters --
core: FlowerDocs core host
documentId: identifier of the document where are the annotations to delete

-- Headers --
token: {{token}}
Content-Type: application/json

JAVA

@Autowired
private AnnotationService service;

public void delete() throws FunctionalException, TechnicalException

	Id documentId = new Id("documentId");
	service.delete(documentId);