Lavorare con gli allegati utilizzando le API

Modifica online

In Targetprocess, i file allegati e i caricamenti sono memorizzati sotto forma di risorse Allegato. Per automatizzare la gestione degli allegati, è possibile utilizzare i metodi CRUD (creazione / lettura / aggiornamento / eliminazione) supportati dalle nostre API.

Ottenere gli allegati

Ottenere l'elenco di tutti gli allegati

L'API REST consente di ottenere l'elenco di tutti i file allegati attualmente presenti nel sistema. Ogni elemento dell'elenco contiene gli URI delle risorse allegate (proprietà Uri) e i riferimenti a entità generali (per esempio, User Story, Bug, Task, Feature, Release, ecc.) in Generalproperty.

L'endpoint di un servizio REST sarà:

https://your-targetprocess-application-URL/api/v1/Attachments/

Si ottiene l'elenco dei nodi. Ogni nodo rappresenta un singolo file nel sistema. Il formato è il seguente:

<Allegato Id="1234" Name="NewAccountScreen.xls">

<Descrizione>Form per la creazione di un nuovo conto <Descrizione>

<Date>2008-03-13T13:01:08</Date>

<MimeType>application/vnd.ms-excel</MimeType>

<Uri>

https://your-targetprocess-application-URL/Attachment.aspx?AttachmentID=1234

</Uri>

<ThumbnailUri>

https://your-targetprocess-application-URL/AttachmentThumbnail.aspx?AttachmentID=1234&width=100&height=100

</ThumbnailUri>

<Size>47616</Size>

<Proprietario ResourceType="GeneralUser" Id="23">

<FirstName>James</FirstName>

<LastName>White</LastName>

</Proprietario>

<Generale ResourceType="General" Id="1884" Nome="Servizio di creazione account"/>

<Messaggio nil="true"/>

</Allegato>

Vedere la definizione dei campi disponibili su https://md5.tpondemand.com/api/v1/Attachments/meta.

Se lavorate con un account ospitato sui nostri server cloud, utilizzate sempre i prefissi https:// quando richiedete un elenco di allegati. Altrimenti si otterranno URI sbagliati per gli elementi.

A volte si può verificare il problema del set di risultati di grandi dimensioni, quando non tutti gli allegati vengono visti come inclusi nella risposta. È necessario iterare su ciascun elemento generale e quindi effettuare una seconda chiamata che estragga gli URL degli allegati per quell'id di elemento generale specifico. Utilizzate con attenzione anche la paginazione delle API REST.

Ottenere l'elenco di tutti gli allegati di un'entità con ID noto

https://your-targetprocess-application-URL/api/v1/Generals/1884?include=[Attachments]

È possibile utilizzare il tipo di entità pertinente. Utilizzate il nostro modello di risorse come riferimento. Gli endpoint più comuni sono:

  • UserStories
  • Attività
  • Insetti
  • Funzioni
  • Epiche
  • Iterazioni
  • Rilasci
  • TeamIterations
  • Richieste

Filtrare e ordinare l'elenco degli allegati

Queste azioni non sono finora supportate. È necessario interrogare l'elenco di tutti gli allegati, analizzarli, filtrarli e ordinarli sul lato client e quindi cercare gli elementi richiesti.

Scarica il singolo file allegato

https://your-targetprocess-application-URL/Attachment.aspx?AttachmentID=1234.

Per l'autenticazione, è possibile utilizzare il metodo di autenticazione di base o inviare un cookie che imita il comportamento del browser web.

HTTP Deve essere utilizzato il tipo di richiesta GET.

Autenticazione di base

È possibile generare credenziali di autenticazione di base che non sono legate a uno specifico utente di Targetprocess. A questo scopo si può utilizzare il conto speciale "Sistema". Non appartiene a nessun utente umano specifico e si consiglia di utilizzare questo account per le integrazioni.

La password per l'utente di sistema deve essere impostata in anticipo dall'amministratore di Targetprocess in Impostazioni → Impostazioni generali Impostazioni → Credenziali utente di sistema.

Quindi, si codifica la coppia system:passwordofsystemuser come stringa codificata base64 e si passa questo parametro nell'intestazione della richiesta all'API.

Autenticazione tramite cookie

È necessario impostare correttamente i campi di intestazione Accept e Cookie della richiesta GET di HTTP.

Autenticazione con token

Finora non è possibile utilizzare il token API REST per scaricare un file allegato.

Creare allegati

Istruzioni ed esempi sono stati spostati in Dev Guide.

Scarica le immagini in linea

Era possibile incollare le immagini nell'archivio dei file senza convertirle in Allegati. È successo quando hai incollato le immagini dall'editor di descrizione. Nelle soluzioni in loco questo metodo di stoccaggio è ancora attuale.

Non è possibile scaricare immagini in linea tramite API REST. I link a tali immagini sono disponibili per la visualizzazione e il download solo per il client del browser web.

Per la nostra soluzione in hosting abbiamo cambiato il processo di archiviazione dei file, passando dai file in linea alle entità Allegato.