Gemma.WebApi

<back to all web services

OpenApiCallbackSdiQuery

Requires Authentication
Required role:Admin
OpenApiCallbackSdiQuery Parameters:
NameParameterData TypeRequiredDescription
Idqueryint?No
IdGreaterThanOrEqualToqueryint?No
IdGreaterThanqueryint?No
IdLessThanqueryint?No
IdLessThanOrEqualToqueryint?No
IdNotEqualToqueryint?No
IdBetweenqueryint[]No
IdInqueryint[]No
EventTypequerystringNo
EventTypeStartsWithquerystringNo
EventTypeEndsWithquerystringNo
EventTypeContainsquerystringNo
EventTypeLikequerystringNo
EventTypeBetweenquerystring[]No
EventTypeInquerystring[]No
InvoiceUuidquerystringNo
InvoiceUuidStartsWithquerystringNo
InvoiceUuidEndsWithquerystringNo
InvoiceUuidContainsquerystringNo
InvoiceUuidLikequerystringNo
InvoiceUuidBetweenquerystring[]No
InvoiceUuidInquerystring[]No
ProcessingStatusquerystringNo
ProcessingStatusStartsWithquerystringNo
ProcessingStatusEndsWithquerystringNo
ProcessingStatusContainsquerystringNo
ProcessingStatusLikequerystringNo
ProcessingStatusBetweenquerystring[]No
ProcessingStatusInquerystring[]No
RawJsonquerystringNo
RawJsonStartsWithquerystringNo
RawJsonEndsWithquerystringNo
RawJsonContainsquerystringNo
RawJsonLikequerystringNo
RawJsonBetweenquerystring[]No
RawJsonInquerystring[]No
RequestHeadersJsonquerystringNo
RequestHeadersJsonStartsWithquerystringNo
RequestHeadersJsonEndsWithquerystringNo
RequestHeadersJsonContainsquerystringNo
RequestHeadersJsonLikequerystringNo
RequestHeadersJsonBetweenquerystring[]No
RequestHeadersJsonInquerystring[]No
CreatedUtcqueryDateTime?No
CreatedUtcGreaterThanOrEqualToqueryDateTime?No
CreatedUtcGreaterThanqueryDateTime?No
CreatedUtcLessThanqueryDateTime?No
CreatedUtcLessThanOrEqualToqueryDateTime?No
CreatedUtcNotEqualToqueryDateTime?No
CreatedUtcBetweenqueryDateTime[]No
CreatedUtcInqueryDateTime[]No
ModifiedUtcqueryDateTime?No
ModifiedUtcGreaterThanOrEqualToqueryDateTime?No
ModifiedUtcGreaterThanqueryDateTime?No
ModifiedUtcLessThanqueryDateTime?No
ModifiedUtcLessThanOrEqualToqueryDateTime?No
ModifiedUtcNotEqualToqueryDateTime?No
ModifiedUtcBetweenqueryDateTime[]No
ModifiedUtcInqueryDateTime[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
OpenApiCallbackSdi Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
EventTypeformstringNo
InvoiceUuidformstringNo
ProcessingStatusformstringNo
RawJsonformstringNo
RequestHeadersJsonformstringNo
CreatedUtcformDateTimeNo
ModifiedUtcformDateTimeNo
MetaformDictionary<string, string>No
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/OpenApiCallbackSdiQuery 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],"eventType":"String","eventTypeStartsWith":"String","eventTypeEndsWith":"String","eventTypeContains":"String","eventTypeLike":"String","eventTypeBetween":["String"],"eventTypeIn":["String"],"invoiceUuid":"String","invoiceUuidStartsWith":"String","invoiceUuidEndsWith":"String","invoiceUuidContains":"String","invoiceUuidLike":"String","invoiceUuidBetween":["String"],"invoiceUuidIn":["String"],"processingStatus":"String","processingStatusStartsWith":"String","processingStatusEndsWith":"String","processingStatusContains":"String","processingStatusLike":"String","processingStatusBetween":["String"],"processingStatusIn":["String"],"rawJson":"String","rawJsonStartsWith":"String","rawJsonEndsWith":"String","rawJsonContains":"String","rawJsonLike":"String","rawJsonBetween":["String"],"rawJsonIn":["String"],"requestHeadersJson":"String","requestHeadersJsonStartsWith":"String","requestHeadersJsonEndsWith":"String","requestHeadersJsonContains":"String","requestHeadersJsonLike":"String","requestHeadersJsonBetween":["String"],"requestHeadersJsonIn":["String"],"createdUtc":"\/Date(-62135596800000-0000)\/","createdUtcGreaterThanOrEqualTo":"\/Date(-62135596800000-0000)\/","createdUtcGreaterThan":"\/Date(-62135596800000-0000)\/","createdUtcLessThan":"\/Date(-62135596800000-0000)\/","createdUtcLessThanOrEqualTo":"\/Date(-62135596800000-0000)\/","createdUtcNotEqualTo":"\/Date(-62135596800000-0000)\/","createdUtcBetween":["0001-01-01T00:00:00"],"createdUtcIn":["0001-01-01T00:00:00"],"modifiedUtc":"\/Date(-62135596800000-0000)\/","modifiedUtcGreaterThanOrEqualTo":"\/Date(-62135596800000-0000)\/","modifiedUtcGreaterThan":"\/Date(-62135596800000-0000)\/","modifiedUtcLessThan":"\/Date(-62135596800000-0000)\/","modifiedUtcLessThanOrEqualTo":"\/Date(-62135596800000-0000)\/","modifiedUtcNotEqualTo":"\/Date(-62135596800000-0000)\/","modifiedUtcBetween":["0001-01-01T00:00:00"],"modifiedUtcIn":["0001-01-01T00:00:00"],"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,"eventType":"String","invoiceUuid":"String","processingStatus":"String","rawJson":"String","requestHeadersJson":"String","meta":{"String":"String"}}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}