Gemma.WebApi

<back to all web services

GetImpiantoFilesRequest

Files

Recupera i metadati del file o della cartella radice associata all'Impianto e, se si tratta di una cartella, elenca anche i suoi contenuti (senza dati binari).

Requires Authentication
Required role:ApiUser
The following routes are available for this service:
GET/impianti/{ImpiantoId}/filesElenca i file e le cartelle all'interno della cartella radice dell'Impianto.
GetImpiantoFilesRequest Parameters:
NameParameterData TypeRequiredDescription
ImpiantoIdpathintegerYesID univoco dell'Impianto di cui elencare i file.
GetImpiantoFilesResponse Parameters:
NameParameterData TypeRequiredDescription
RootFileformFileMetadataDtoNo
ContentsformList<FileMetadataDto>No
ResponseStatusformResponseStatusNo
FileMetadataDto Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NomeformstringNo
IsFolderformboolNo
FolderIdformint?No
DataCreazioneformDateTimeNo
DataAggiornamentoformDateTimeNo
ImpiantoIdformint?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /impianti/{ImpiantoId}/files HTTP/1.1 
Host: gemma.api.kerberos.energy 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	rootFile: 
	{
		id: 0,
		nome: String,
		isFolder: False,
		folderId: 0,
		impiantoId: 0
	},
	contents: 
	[
		{
			id: 0,
			nome: String,
			isFolder: False,
			folderId: 0,
			impiantoId: 0
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}