API: EVENT_LOG_QUERY - ricerca di un evento

Gli identificativi del tipo "<***>" sono descritti in questa sezione

Azione

Recupero di un evento sulla base di specifici parametri di ricerca.

Nota: poiché l’indicizzazione degli eventi avviene in elastic search e viene mostrato  un certo tempo dopo che l'evento si è generato nel sistema.

Richiesta

{ 
    "message_type": "LOG_QUERY", 
    "version": "1.0", 
    "authentication": <AUTHTENTICATION>, 
"organization_code": <ORGANIZATION_CODE>,
"document_type": <DOCUMENT_TYPE>,

"any": [ "testo libero"
],
"data": [
// For Date Fields
{
"field_name": ,
"operation": ( "BETWEEN" | "MATCH" ),
"value1": ,
"value2":
},

// For String Fields
{
"field_name": ,
"operation": "MATCH",
"value1":
},

...
],
"info": [

// For Date Fields
{ "field_name": ,
"operation": ( "BETWEEN" | "MATCH" ),
"value1": ,
"value2":
},

// For String Fields
{
"field_name": ,
"operation": "MATCH",
"value1":
},

// For Non-negative Integer Number Fields
{
"field_name": ,
"operation": ( "BETWEEN" | "MATCH" ),
"value1": ,
"value2":
},

...
],

"order_by" : [
{
"section_name": ( "senddata" | "documentdata"
| "metadata" ),
"field_name": ,
"type": ( "ASC" | "DESC" )
},
...
],

"paging" : {
"start" : ,
"count" :
}
}

Errori

Errore nel parsing della richiesta
400 Bad Request
{
    "status" : "ERROR_PARSING_FIELD_QUERY",
    "field_area" : ('senddata' | 'documentdata' | 'metadata'),
    "field_name" : ,
"description" : ,
"comment" : "Error parsing $FIELD_NAME: $DESCRIPTION"
}

Troppi parametri specificati

400 Bad Request
{
    "status" : "TOO_MANY_CLAUSES",
    "comment" : "Too many clauses, make a more specific query"
}

Descrizione dei campi

In field_name di  info si possono specificare i seguenti nomi:

document_type String il codice che individua la classe documentale -
creation_date
String la data di creazione dell'evento. In formato AAAA-MM-GG -
type
"WARNING" "ERROR"
il tipo di evento -
code UNKNOWN_TYPE"  "SEQUENCE_VIOLATION"  "DOCUMENT_TOO_OLD"  "DUPLICATE_DOCUMENT"  "UNEXPECTED_ERROR"  "DOCUMENT_OVERWRITTEN"  "DOCUMENT_DELETED"  "FOUND_SEQUENCE_VIOLATION"  "SPOOL_OK"  "SETUP_USER_CAPABILITIES"  "CREATE_USER"  "DELETE_USER"  "ADVICE"  "LOT_DELETED"  "METADATA_NOT_FOUND"  "MISSING_REQUIRED_METADATA"  "UPLOAD_SPOOL"  "SPOOL_GENERATION_ERROR"  "SPOOL_ARCHIVING_ERROR" il codice dell'evento (il tipo) -
context "UPLOAD_SPOOL"  "UPLOAD_SINGLE_DOCUMENT"  "OVERWRITE_SPOOL"  "OVERWRITE_SINGLE_DOCUMENT"  "ARCHIVE"  "GENERATION"  "SENDING" "ADMIN" "DELETE_SINGLE_DOCUMENT" è l'ambito nel quale si è verificato l'evento durante la lavorazione del documento
 

I campi data devono essere nel formato yyyy-mm-dd. Per tali campi le ricerche possibili sono 2:

  • ricerca in una data specifica: “OPERATION” deve essere “MATCH” e “value1” contiene la data da ricercare
  • ricerca in un intervallo: “OPERATION” deve essere “BETWEEN” e “value1” e “value2” i due estremi dell’intervallo di date
Le ricerche sui campi interi positivi utilizzano “value1” e “value2”, che sono decimali, e si possono avere 2 casi:
  • ricerca in un valore specifico: “OPERATION” deve essere “MATCH” e “value1” contiene il valore da ricercare
  • ricerca in un intervallo: “OPERATION” deve essere “BETWEEN” e “value1” e “value2” i due estremi dell’intervallo numerico

Le ricerche sui campi testuali utilizzano “value1” che può contenere “*” e “?” e “OPERATION” deve essere “MATCH”

 

Nel caso sia necessario ricercare una stringa precisa è necessario scriverla fra doppi apici (ricordarsi che in json i doppi apici vanno indicati come '\"')

Risposta OK

200 OK
{
    "status": "OK",
    "comment": "Log Query Results",
    "rows_count": ,
    "rows": [ 
		<EVENT_DATA>, ...
     ]
}
Attenzione: le informazioni riportate in questa sezione possono non essere perfettamente allineate con la versione corrente del servizio, in continua evoluzione. Per qualunque informazione specifica, vi preghiamo di contattarci.