JiwaAPI

<back to all web services

SY_PluginSnippetDeclarationQuery

Requires Authentication
SY_PluginSnippetDeclarationQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDqueryGuid?No
RecIDInqueryGuid[]No
SY_PluginSnippet_RecIDqueryGuid?No
SY_PluginSnippet_RecIDInqueryGuid[]No
IDquerystringNo
IDStartsWithquerystringNo
IDEndsWithquerystringNo
IDContainsquerystringNo
IDLikequerystringNo
IDBetweenquerystring[]No
IDInquerystring[]No
TypequerystringNo
TypeStartsWithquerystringNo
TypeEndsWithquerystringNo
TypeContainsquerystringNo
TypeLikequerystringNo
TypeBetweenquerystring[]No
TypeInquerystring[]No
TooltipquerystringNo
TooltipStartsWithquerystringNo
TooltipEndsWithquerystringNo
TooltipContainsquerystringNo
TooltipLikequerystringNo
TooltipBetweenquerystring[]No
TooltipInquerystring[]No
DefaultquerystringNo
DefaultStartsWithquerystringNo
DefaultEndsWithquerystringNo
DefaultContainsquerystringNo
DefaultLikequerystringNo
DefaultBetweenquerystring[]No
DefaultInquerystring[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_PluginSnippetDeclaration Parameters:
NameParameterData TypeRequiredDescription
RecIDformGuidNo
SY_PluginSnippet_RecIDformGuidNo
IDformstringNo
TypeformstringNo
TooltipformstringNo
DefaultformstringNo
ItemNoformintNo
RowHashformbyte[]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/SY_PluginSnippetDeclarationQuery HTTP/1.1 
Host: localhost 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"RecID":"00000000000000000000000000000000","RecIDIn":["00000000-0000-0000-0000-000000000000"],"SY_PluginSnippet_RecID":"00000000000000000000000000000000","SY_PluginSnippet_RecIDIn":["00000000-0000-0000-0000-000000000000"],"ID":"String","IDStartsWith":"String","IDEndsWith":"String","IDContains":"String","IDLike":"String","IDBetween":["String"],"IDIn":["String"],"Type":"String","TypeStartsWith":"String","TypeEndsWith":"String","TypeContains":"String","TypeLike":"String","TypeBetween":["String"],"TypeIn":["String"],"Tooltip":"String","TooltipStartsWith":"String","TooltipEndsWith":"String","TooltipContains":"String","TooltipLike":"String","TooltipBetween":["String"],"TooltipIn":["String"],"Default":"String","DefaultStartsWith":"String","DefaultEndsWith":"String","DefaultContains":"String","DefaultLike":"String","DefaultBetween":["String"],"DefaultIn":["String"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"RowHash":"AA==","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

{"Results":[{"ID":"String","Type":"String","Tooltip":"String","Default":"String","RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}