API Allegati Merci¶

Endpoint¶

Metodo	Path	Descrizione
GET	`/v1/allegato-merce`	Lettura allegati associati a una merce

Query string — GET¶

Parametro	Tipo	Obbligatorio	Note
`codice_host`	string	SI	Codice host della merce (`rmer_codice_host`)

Schema output¶

`AllegatoMerceOutput`¶

Campo	Tipo	Descrizione
`nome_originale`	string	Nome originale del file allegato
`nome_memorizzato`	string	Nome con cui il file e' memorizzato su S3
`descrizione`	string	Descrizione dell'allegato
`contenuto`	string	Contenuto del file codificato in base64

La risposta e' un array di AllegatoMerceOutput. Se la merce non ha allegati, viene restituito un array vuoto.

Tabelle coinvolte¶

Tabella	Condizione	Scopo
`ARPMERCI`	`rmer_codice_host = codice_host`	Risoluzione merce: da codice host a codice merce interno (`rmer_cm`)
`APCOGARIDX`	`a_arx_doc_classe = 'AM'` AND `a_arx_fl_canc <> 'C'`	Indice allegati della classe "Allegati Merci", esclusi i cancellati logicamente

La query su APCOGARIDX filtra per:

a_arx_doc_classe = 'AM' — classe documento "Allegati Merci"
a_arx_fl_canc <> 'C' — esclusione allegati cancellati logicamente

Integrazione AWS S3¶

I file allegati sono memorizzati su un bucket AWS S3. Il percorso di ogni file e':

classi/AM/{rmer_cm}/{nome_memorizzato}

dove rmer_cm e' il codice merce interno ottenuto dalla risoluzione su ARPMERCI.

Il recupero avviene tramite GetObjectCommand dell'SDK AWS. Il contenuto binario del file viene codificato in base64 prima di essere incluso nel campo contenuto della risposta.

Risposte¶

200 OK¶

[
  {
    "nome_originale": "scheda-tecnica.pdf",
    "nome_memorizzato": "20240101_scheda-tecnica.pdf",
    "descrizione": "Scheda tecnica prodotto",
    "contenuto": "JVBERi0xLjQK..."
  }
]

Array vuoto se la merce non ha allegati:

[]

400 Bad Request¶

Restituito se il parametro codice_host non corrisponde a nessuna merce in ARPMERCI.

Note implementative¶

Il parametro codice_host e' obbligatorio: se mancante o non trovato in ARPMERCI, l'API restituisce 400
La codifica base64 del contenuto puo' generare risposte di dimensioni significative per allegati di grandi dimensioni
La classe documento AM (Allegati Merci) e' una delle classi gestite dal sistema di archiviazione documentale (APCOGARIDX)