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/json

Query Parameters

No query parameters are needed to make this request.

Body

{
  "limit": "integer",
  "from": "integer",
  "ownership": {
    "type": "WS",
    "identifier": "string"
  },
  "sort": {
    "name": "CREATED",
    "order": "ASC"
  },
  "type": "string",
  "reference_ids": [
    "string"
  ],
  "show_deleted": true,
  "search_words": "string"
}

• limit: limits the number of annotations in the response. The default value is 100.
• from: specifies the value of the field next from a pagination call. The default value is 0.
• ownership: specifies the ownership of the annotation. It contains the following 2 fields:
  • type: it can be WS or ITEM
  • identifier: the item identifier
• sort: specifies the sorting order. The order field specifies if the sorting has to be in ascending (ASC) or descending (DESC) order. The other field, name, can have the following values:
  • CREATED: sorting on the creation date.
  • UPDATED: sorting on the last modified date.
  • ALPHABETICAL: sorting on alphabetical order.
• type: specifies the annotation type, FOLDER or NOTE.
• reference_ids: the ids of the related documents
• show_deleted: shows the deleted annotations if set to true. Default value is false. 
• search_words: search for terms in the text field of the entity. The default value is all.

Response

On successful response

If successful, the API responds with HTTP code 200(OK) with the following body:

{
  "count": "integer",
  "data": [
    {
      "id": "string",
      "type": "string",
      "text": "string",
      "classification": "string",
      "referencingDate": "string",
      "referencePeriod": "string",
      "referenceType": "string",
      "referenceIds": [
        "string"
      ],
      "deleted": true,
      "ownership": {
        "type": "WS",
        "identifier": "string"
      },
      "itemClassifier": "string",
      "insertedBy": "string",
      "insertedAt": "2022-10-31T15:02:44.115Z",
      "modifiedAt": "2022-10-31T15:02:44.115Z"
    }
  ]
}

• count: the number of the annotations returned by the search that fulfill the search filters.
• data: an list containing all the annotations that fulfill the search filters.

The elements inside the data list contain the following fields:

• id: unique identifier of the annotation, in UUID format
• type: specifies the annotation type. It can have the following values:
  • NOTE
  • FOLDER
• text: contains information about the annotation. It has a maximum length of 1000 characters. Depending on the type, the information contained can be:
  • note text: the text value, in case the annotation is of type NOTE
  • folder name: the name of the folder, in case the annotation is of type FOLDER
• classification: it can have the following possible values:
  • PERSONALIZZATO
  • BANCA
  • BILANCIO
  • DICHIARAZIONI
  • CONTENZIOSO
• referencing_date: the referencing date
• reference_period: the year of reference
• reference_type: the reference type, at the moment the only possible value is DOCSTORE
• reference_ids: the ids of the related documents
• deleted: specifies if the annotation is deleted or not
• ownership: specifies the ownership of the annotation. It contains the following 2 fields:
  • type: it can be WS or ITEM
  • identifier: the item identifier
• item_classifier: it can be ACCOUNTANT or COMPANY
• inserted_by: the name of the creator of the annotation
• inserted_at: the timestamp of the annotation creation
• modified_at: the timestamp of the last edit of the annotation

On error response

In the event of an error, the API responds with a body JSON with the following format:

{
  "code": "string",
  "timestamp": "2022-10-28T13:01:00.754Z",
  "message": "string",
  "subErrors": [
    {}
  ]
}

• code: A string representation of the HTTP error code, linked with the returned http error
• timestamp: Date and time of the answer, expressed as a string.
• message: Message expressing error.

Possible errors are:

• 400: The request is malformed (parameters with incorrect format, invalid or inconsistent parameters).
• 401: An authorization token has not been provided or the authorization token provided is invalid (eg: it has expired).
• 403: The provided token is valid, but the user is not authorized to perform the operation.
• 500: An unexpected error occurred.