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

HTTP + CSV

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

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

{"id":0,"idGreaterThanOrEqualTo":0,"idGreaterThan":0,"idLessThan":0,"idLessThanOrEqualTo":0,"idNotEqualTo":0,"idBetween":[0],"idIn":[0],"nome":"String","nomeStartsWith":"String","nomeEndsWith":"String","nomeContains":"String","nomeLike":"String","nomeBetween":["String"],"nomeIn":["String"],"dataCreazione":"\/Date(-62135596800000-0000)\/","dataCreazioneGreaterThanOrEqualTo":"\/Date(-62135596800000-0000)\/","dataCreazioneGreaterThan":"\/Date(-62135596800000-0000)\/","dataCreazioneLessThan":"\/Date(-62135596800000-0000)\/","dataCreazioneLessThanOrEqualTo":"\/Date(-62135596800000-0000)\/","dataCreazioneNotEqualTo":"\/Date(-62135596800000-0000)\/","dataCreazioneBetween":["0001-01-01T00:00:00"],"dataCreazioneIn":["0001-01-01T00:00:00"],"utenteCreaId":0,"utenteCreaIdGreaterThanOrEqualTo":0,"utenteCreaIdGreaterThan":0,"utenteCreaIdLessThan":0,"utenteCreaIdLessThanOrEqualTo":0,"utenteCreaIdNotEqualTo":0,"utenteCreaIdBetween":[0],"utenteCreaIdIn":[0],"dataAggiornamento":"\/Date(-62135596800000-0000)\/","dataAggiornamentoGreaterThanOrEqualTo":"\/Date(-62135596800000-0000)\/","dataAggiornamentoGreaterThan":"\/Date(-62135596800000-0000)\/","dataAggiornamentoLessThan":"\/Date(-62135596800000-0000)\/","dataAggiornamentoLessThanOrEqualTo":"\/Date(-62135596800000-0000)\/","dataAggiornamentoNotEqualTo":"\/Date(-62135596800000-0000)\/","dataAggiornamentoBetween":["0001-01-01T00:00:00"],"dataAggiornamentoIn":["0001-01-01T00:00:00"],"binaryData":"AA==","isSystemFolder":false,"isFolder":false,"folderId":0,"folderIdGreaterThanOrEqualTo":0,"folderIdGreaterThan":0,"folderIdLessThan":0,"folderIdLessThanOrEqualTo":0,"folderIdNotEqualTo":0,"folderIdBetween":[0],"folderIdIn":[0],"utenteAggiornaId":0,"utenteAggiornaIdGreaterThanOrEqualTo":0,"utenteAggiornaIdGreaterThan":0,"utenteAggiornaIdLessThan":0,"utenteAggiornaIdLessThanOrEqualTo":0,"utenteAggiornaIdNotEqualTo":0,"utenteAggiornaIdBetween":[0],"utenteAggiornaIdIn":[0],"skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"offset":0,"total":0,"results":[{"id":0,"nome":"String","utenteCreaId":0,"binaryData":"AA==","isSystemFolder":false,"isFolder":false,"folderId":0,"utenteAggiornaId":0}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}