Gemma.WebApi

<back to all web services

FileQuery

Requires Authentication
Required role:Admin
FileQuery Parameters:
NameParameterData TypeRequiredDescription
Idqueryint?No
IdGreaterThanOrEqualToqueryint?No
IdGreaterThanqueryint?No
IdLessThanqueryint?No
IdLessThanOrEqualToqueryint?No
IdNotEqualToqueryint?No
IdBetweenqueryint[]No
IdInqueryint[]No
NomequerystringNo
NomeStartsWithquerystringNo
NomeEndsWithquerystringNo
NomeContainsquerystringNo
NomeLikequerystringNo
NomeBetweenquerystring[]No
NomeInquerystring[]No
DataCreazionequeryDateTime?No
DataCreazioneGreaterThanOrEqualToqueryDateTime?No
DataCreazioneGreaterThanqueryDateTime?No
DataCreazioneLessThanqueryDateTime?No
DataCreazioneLessThanOrEqualToqueryDateTime?No
DataCreazioneNotEqualToqueryDateTime?No
DataCreazioneBetweenqueryDateTime[]No
DataCreazioneInqueryDateTime[]No
UtenteCreaIdqueryint?No
UtenteCreaIdGreaterThanOrEqualToqueryint?No
UtenteCreaIdGreaterThanqueryint?No
UtenteCreaIdLessThanqueryint?No
UtenteCreaIdLessThanOrEqualToqueryint?No
UtenteCreaIdNotEqualToqueryint?No
UtenteCreaIdBetweenqueryint[]No
UtenteCreaIdInqueryint[]No
DataAggiornamentoqueryDateTime?No
DataAggiornamentoGreaterThanOrEqualToqueryDateTime?No
DataAggiornamentoGreaterThanqueryDateTime?No
DataAggiornamentoLessThanqueryDateTime?No
DataAggiornamentoLessThanOrEqualToqueryDateTime?No
DataAggiornamentoNotEqualToqueryDateTime?No
DataAggiornamentoBetweenqueryDateTime[]No
DataAggiornamentoInqueryDateTime[]No
BinaryDataquerybyte[]No
IsSystemFolderquerybool?No
IsFolderquerybool?No
FolderIdqueryint?No
FolderIdGreaterThanOrEqualToqueryint?No
FolderIdGreaterThanqueryint?No
FolderIdLessThanqueryint?No
FolderIdLessThanOrEqualToqueryint?No
FolderIdNotEqualToqueryint?No
FolderIdBetweenqueryint[]No
FolderIdInqueryint[]No
UtenteAggiornaIdqueryint?No
UtenteAggiornaIdGreaterThanOrEqualToqueryint?No
UtenteAggiornaIdGreaterThanqueryint?No
UtenteAggiornaIdLessThanqueryint?No
UtenteAggiornaIdLessThanOrEqualToqueryint?No
UtenteAggiornaIdNotEqualToqueryint?No
UtenteAggiornaIdBetweenqueryint[]No
UtenteAggiornaIdInqueryint[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
File Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NomeformstringNo
DataCreazioneformDateTimeNo
UtenteCreaIdformintNo
DataAggiornamentoformDateTimeNo
BinaryDataformbyte[]No
IsSystemFolderformboolNo
IsFolderformboolNo
FolderIdformintNo
UtenteAggiornaIdformintNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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.

POST /xml/reply/FileQuery HTTP/1.1 
Host: gemma.api.kerberos.energy 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FileQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gemma.WebApi.ServiceModel.Types">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <BinaryData>AA==</BinaryData>
  <DataAggiornamento>0001-01-01T00:00:00</DataAggiornamento>
  <DataAggiornamentoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </DataAggiornamentoBetween>
  <DataAggiornamentoGreaterThan>0001-01-01T00:00:00</DataAggiornamentoGreaterThan>
  <DataAggiornamentoGreaterThanOrEqualTo>0001-01-01T00:00:00</DataAggiornamentoGreaterThanOrEqualTo>
  <DataAggiornamentoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </DataAggiornamentoIn>
  <DataAggiornamentoLessThan>0001-01-01T00:00:00</DataAggiornamentoLessThan>
  <DataAggiornamentoLessThanOrEqualTo>0001-01-01T00:00:00</DataAggiornamentoLessThanOrEqualTo>
  <DataAggiornamentoNotEqualTo>0001-01-01T00:00:00</DataAggiornamentoNotEqualTo>
  <DataCreazione>0001-01-01T00:00:00</DataCreazione>
  <DataCreazioneBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </DataCreazioneBetween>
  <DataCreazioneGreaterThan>0001-01-01T00:00:00</DataCreazioneGreaterThan>
  <DataCreazioneGreaterThanOrEqualTo>0001-01-01T00:00:00</DataCreazioneGreaterThanOrEqualTo>
  <DataCreazioneIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </DataCreazioneIn>
  <DataCreazioneLessThan>0001-01-01T00:00:00</DataCreazioneLessThan>
  <DataCreazioneLessThanOrEqualTo>0001-01-01T00:00:00</DataCreazioneLessThanOrEqualTo>
  <DataCreazioneNotEqualTo>0001-01-01T00:00:00</DataCreazioneNotEqualTo>
  <FolderId>0</FolderId>
  <FolderIdBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </FolderIdBetween>
  <FolderIdGreaterThan>0</FolderIdGreaterThan>
  <FolderIdGreaterThanOrEqualTo>0</FolderIdGreaterThanOrEqualTo>
  <FolderIdIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </FolderIdIn>
  <FolderIdLessThan>0</FolderIdLessThan>
  <FolderIdLessThanOrEqualTo>0</FolderIdLessThanOrEqualTo>
  <FolderIdNotEqualTo>0</FolderIdNotEqualTo>
  <Id>0</Id>
  <IdBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </IdBetween>
  <IdGreaterThan>0</IdGreaterThan>
  <IdGreaterThanOrEqualTo>0</IdGreaterThanOrEqualTo>
  <IdIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </IdIn>
  <IdLessThan>0</IdLessThan>
  <IdLessThanOrEqualTo>0</IdLessThanOrEqualTo>
  <IdNotEqualTo>0</IdNotEqualTo>
  <IsFolder>false</IsFolder>
  <IsSystemFolder>false</IsSystemFolder>
  <Nome>String</Nome>
  <NomeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NomeBetween>
  <NomeContains>String</NomeContains>
  <NomeEndsWith>String</NomeEndsWith>
  <NomeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NomeIn>
  <NomeLike>String</NomeLike>
  <NomeStartsWith>String</NomeStartsWith>
  <UtenteAggiornaId>0</UtenteAggiornaId>
  <UtenteAggiornaIdBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </UtenteAggiornaIdBetween>
  <UtenteAggiornaIdGreaterThan>0</UtenteAggiornaIdGreaterThan>
  <UtenteAggiornaIdGreaterThanOrEqualTo>0</UtenteAggiornaIdGreaterThanOrEqualTo>
  <UtenteAggiornaIdIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </UtenteAggiornaIdIn>
  <UtenteAggiornaIdLessThan>0</UtenteAggiornaIdLessThan>
  <UtenteAggiornaIdLessThanOrEqualTo>0</UtenteAggiornaIdLessThanOrEqualTo>
  <UtenteAggiornaIdNotEqualTo>0</UtenteAggiornaIdNotEqualTo>
  <UtenteCreaId>0</UtenteCreaId>
  <UtenteCreaIdBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </UtenteCreaIdBetween>
  <UtenteCreaIdGreaterThan>0</UtenteCreaIdGreaterThan>
  <UtenteCreaIdGreaterThanOrEqualTo>0</UtenteCreaIdGreaterThanOrEqualTo>
  <UtenteCreaIdIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </UtenteCreaIdIn>
  <UtenteCreaIdLessThan>0</UtenteCreaIdLessThan>
  <UtenteCreaIdLessThanOrEqualTo>0</UtenteCreaIdLessThanOrEqualTo>
  <UtenteCreaIdNotEqualTo>0</UtenteCreaIdNotEqualTo>
</FileQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfFileCYQkyN_Pr xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gemma.WebApi.ServiceModel.Types">
    <d2p1:File>
      <d2p1:BinaryData>AA==</d2p1:BinaryData>
      <d2p1:DataAggiornamento>0001-01-01T00:00:00</d2p1:DataAggiornamento>
      <d2p1:DataCreazione>0001-01-01T00:00:00</d2p1:DataCreazione>
      <d2p1:FolderId>0</d2p1:FolderId>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsFolder>false</d2p1:IsFolder>
      <d2p1:IsSystemFolder>false</d2p1:IsSystemFolder>
      <d2p1:Nome>String</d2p1:Nome>
      <d2p1:UtenteAggiornaId>0</d2p1:UtenteAggiornaId>
      <d2p1:UtenteCreaId>0</d2p1:UtenteCreaId>
    </d2p1:File>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <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>
        </Meta>
      </ResponseError>
    </Errors>
    <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>
    </Meta>
  </ResponseStatus>
</QueryResponseOfFileCYQkyN_Pr>