Passa al contenuto principale

API Asset

Get by Id

Chiamata per ottenere l'asset tramite l'Id appartenente alla classe indicata.

GET/api/rest/asset/{class_name}/{id}
Permessi Ruolo o Utente
  • Permesso generale per accesso alla risorsa: Assets
  • Permesso per l'accesso al workspace asset dello specifico path: list

Headers: Autenticazione

Path Params

NomeDescrizione
class_nameClasse dell'asset richiesto (es: Image)
idId dell'asset

Query Params

NomeTipoDefaultDescrizione
includeBase64DataboolfalseSe true include nella risposta il file encodato in base64

Body Response

{
"data": {
"id": 3229,
"filename": "66e7e7ba9ab5f-yellow-0.jpg",
"path": "/Images/",
"creationDate": 1759582914,
"modificationDate": 1759582914,
"url": "https://dev3.sintra-soh/Images/66e7e7ba9ab5f-yellow-0.jpg",
"data": "/9j/4QDeRX...(truncated for brevity)...",
"tags": []
},
"errors": [],
"hasErrors": false
}

Get list

Chiamata per ottenere una lista di asset in base ai filtri inseriti.

GET/api/rest/asset/{class_name}
Permessi Ruolo o Utente
  • Permesso generale per accesso alla risorsa: Assets
  • Permesso per l'accesso al workspace asset dello specifico path: list

Headers: Autenticazione

Path Params

NomeDescrizione
class_nameClasse dell'asset richiesto (es: Image)

Query Params

NomeTipoDefaultDescrizione
offsetint0Indice di partenza per la paginazione dei risultati
limitint1000Numero massimo di record da restituire
querystringnullFiltro di ricerca in formato stringa (es: modificationDate >= 1748611683)
sortstringnullCampo e direzione di ordinamento dei risultati in formato json (es: {"modificationDate":"DESC"})
includeBase64DataboolfalseSe true include nella risposta il file encodato in base64

Body Response

{
"data": [
{
"id": 3229,
"filename": "66e7e7ba9ab5f-yellow-0.jpg",
"path": "/Images/",
"creationDate": 1759582914,
"modificationDate": 1759582914,
"url": "https://dev3.sintra-soh/Images/66e7e7ba9ab5f-yellow-0.jpg",
"data": "/9j/4QDeRX...(truncated for brevity)...",
"tags": []
},
{
"id": 3230,
"filename": "66e7e7ba9ab5f-yellow-1.jpg",
"path": "/Images/",
"creationDate": 1759582914,
"modificationDate": 1759582914,
"url": "https://dev3.sintra-soh/Images/66e7e7ba9ab5f-yellow-1.jpg",
"data": "/9j/4QDeRX...(truncated for brevity)...",
"tags": []
}
],
"errors": [],
"hasErrors": false
}

Get count

Chiamata per ottenere il numero totale di asset in base ai filtri inseriti.

GET/api/rest/asset/{class_name}/count
Permessi Ruolo o Utente
  • Permesso generale per accesso alla risorsa: Assets
  • Permesso per l'accesso al workspace asset dello specifico path: list

Headers: Autenticazione

Path Params

NomeDescrizione
class_nameClasse dell'asset richiesto (es: Image)

Query Params

NomeTipoDefaultDescrizione
querystringnullFiltro di ricerca in formato stringa (es: modificationDate >= 1748611683)

Body Response

{
"data": {
"result": 2
},
"errors": [],
"hasErrors": false
}

Upsert

Chiamata per creare o aggiornare un asset, passando come input una URL oppure il file in base64.

POST/api/rest/asset/{class_name}
Permessi Ruolo o Utente
  • Permesso generale per accesso alla risorsa: Assets
  • Permesso per l'accesso al workspace asset dello specifico path: list, create

Headers: Autenticazione

Path Params

NomeDescrizione
class_nameClasse dell'asset richiesto (es: Image)

Query Params

NomeTipoDefaultDescrizione
outputstringresultDefinisce l'output restituito dall’operazione (es. result = OK o KO, full = intero dataobject).

Body Input Url

{
"filename": "66e7e7ba9ab5f-yellow-0.jpg",
"path": "/Images/",
"url": "https://dev3.sintra-soh/Images/66e7e7ba9ab5f-yellow-0.jpg",
"tags": []
}

Body Input Base64

{
"filename": "66e7e7ba9ab5f-yellow-0.jpg",
"path": "/Images/",
"data": "/9j/4QDeRX...(truncated for brevity)...",
"tags": []
}

Body Response

{
"data": {
"result": "OK"
},
"errors": [],
"hasErrors": false
}

Upsert Bulk

Chiamata per creare o aggiornare più asset in un'unica richiesta, passando come input una lista di asset (URL o file in base64).

POST/api/rest/asset/{class_name}/bulk
Permessi Ruolo o Utente
  • Permesso generale per accesso alla risorsa: Assets
  • Permesso per l'accesso al workspace asset dello specifico path: list, create

Headers: Autenticazione

Path Params

NomeDescrizione
class_nameClasse dell'asset richiesto (es: Image)

Query Params

NomeTipoDefaultDescrizione
outputstringresultDefinisce l'output restituito dall’operazione (es. result = OK o KO, full = intero dataobject).

Body Input Url

[
{
"filename": "66e7e7ba9ab5f-yellow-0.jpg",
"path": "/Images/",
"url": "https://dev3.sintra-soh/Images/66e7e7ba9ab5f-yellow-0.jpg",
"tags": []
},
{
"filename": "66e7e7ba9ab5f-yellow-1.jpg",
"path": "/Images/",
"url": "https://dev3.sintra-soh/Images/66e7e7ba9ab5f-yellow-1.jpg",
"tags": []
}
]

Body Input Base64

[
{
"filename": "66e7e7ba9ab5f-yellow-0.jpg",
"path": "/Images/",
"data": "/9j/4QDeRX...(truncated for brevity)...",
"tags": []
},
{
"filename": "66e7e7ba9ab5f-yellow-1.jpg",
"path": "/Images/",
"data": "/9j/4QDeRX...(truncated for brevity)...",
"tags": []
}
]

Body Response

{
"data": {
"result": [
{
"error": "",
"inputItemIndex": 0,
"result": "OK"
},
{
"error": "",
"inputItemIndex": 1,
"result": "OK"
}
]
},
"errors": [],
"hasErrors": false
}

Delete

Chiamata per eliminare un asset specifico tramite Id e classe.

DELETE/api/rest/asset/{class_name}/{id}
Permessi Ruolo o Utente
  • Permesso generale per accesso alla risorsa: Assets
  • Permesso per l'accesso al workspace asset dello specifico path: delete

Headers: Autenticazione

Path Params

NomeDescrizione
class_nameClasse dell'asset richiesto (es: Image)
idId dell'asset

Body Response

{
"data": {
"result": "OK"
},
"errors": [],
"hasErrors": false
}