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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetImpiantoFilesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gemma.WebApi.ServiceModel.Responses">
  <Contents>
    <FileMetadataDto>
      <DataAggiornamento>0001-01-01T00:00:00</DataAggiornamento>
      <DataCreazione>0001-01-01T00:00:00</DataCreazione>
      <FolderId>0</FolderId>
      <Id>0</Id>
      <ImpiantoId>0</ImpiantoId>
      <IsFolder>false</IsFolder>
      <Nome>String</Nome>
    </FileMetadataDto>
  </Contents>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <RootFile>
    <DataAggiornamento>0001-01-01T00:00:00</DataAggiornamento>
    <DataCreazione>0001-01-01T00:00:00</DataCreazione>
    <FolderId>0</FolderId>
    <Id>0</Id>
    <ImpiantoId>0</ImpiantoId>
    <IsFolder>false</IsFolder>
    <Nome>String</Nome>
  </RootFile>
</GetImpiantoFilesResponse>