Advanced Search
Search Results
8 total results found
Introduction
The service can save and manage the notes added from a Digital user related to one or more entities of external services. With the same model it is possible to represent even folders, groups of identifiers of external entities that have logical relationship be...
Model
Annotation is the base model in which the entire service is based. It has the following format: { "id": "string", "type": "string", "text": "string", "classification": "string", "referencing_date": "date", "reference_period": "st...
Get annotation
This API is responsible for retrieving the annotation with the given id. [GET]/api/v1/annotations/{id} Response: Annotation. Header Header used on this API are those taken from header standards of TS Digital. Content-type is accepted in application/json ...
Create annotation
This API is responsible for creating an annotation. [POST]/api/v1/annotations Response: The id of the newly created annotation. Header Header used on this API are those taken from header standards of TS Digital. Content-type is accepted in application/jso...
Update references
This API is responsible for updating an annotation`s references. [PUT]/api/v1/annotations/{id}/{operation} Response: The id of the updated annotation. Header Header used on this API are those taken from header standards of TS Digital. Content-type is acce...
Update annotation
This API is responsible for updating an annotation. [PATCH]/api/v1/annotations/{id} Response: The id of the updated annotation. The update operation is only available to the user who created the annotation. Header Header used on this API are those taken f...
Delete annotation
This API is responsible for soft deleting an annotation. [DELETE]/api/v1/annotations/{id} Response: The id of the deleted annotation. Header Header used on this API are those taken from header standards of TS Digital. Content-type is accepted in applicati...
Search annotations
This API is responsible for searching annotations. [POST]/api/v1/annotations/search Response: A list of the requested annotations. Header Header used on this API are those taken from header standards of TS Digital. Content-type is accepted in application/...