GET | /Queries/SY_Plugin | Retrieves a list of plugins. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | query | Guid? | No | |
RecIDIn | query | Guid[] | No | |
Name | query | string | No | |
NameStartsWith | query | string | No | |
NameEndsWith | query | string | No | |
NameContains | query | string | No | |
NameLike | query | string | No | |
NameBetween | query | string[] | No | |
NameIn | query | string[] | No | |
Description | query | string | No | |
DescriptionStartsWith | query | string | No | |
DescriptionEndsWith | query | string | No | |
DescriptionContains | query | string | No | |
DescriptionLike | query | string | No | |
DescriptionBetween | query | string[] | No | |
DescriptionIn | query | string[] | No | |
IsEnabled | query | bool? | No | |
ExecutionOrder | query | int? | No | |
ExecutionOrderGreaterThanOrEqualTo | query | int? | No | |
ExecutionOrderGreaterThan | query | int? | No | |
ExecutionOrderLessThan | query | int? | No | |
ExecutionOrderLessThanOrEqualTo | query | int? | No | |
ExecutionOrderNotEqualTo | query | int? | No | |
ExecutionOrderBetween | query | int[] | No | |
ExecutionOrderIn | query | int[] | No | |
Author | query | string | No | |
AuthorStartsWith | query | string | No | |
AuthorEndsWith | query | string | No | |
AuthorContains | query | string | No | |
AuthorLike | query | string | No | |
AuthorBetween | query | string[] | No | |
AuthorIn | query | string[] | No | |
Version | query | string | No | |
VersionStartsWith | query | string | No | |
VersionEndsWith | query | string | No | |
VersionContains | query | string | No | |
VersionLike | query | string | No | |
VersionBetween | query | string[] | No | |
VersionIn | query | string[] | No | |
LicenceKey | query | string | No | |
LicenceKeyStartsWith | query | string | No | |
LicenceKeyEndsWith | query | string | No | |
LicenceKeyContains | query | string | No | |
LicenceKeyLike | query | string | No | |
LicenceKeyBetween | query | string[] | No | |
LicenceKeyIn | query | string[] | No | |
ViewPassword | query | string | No | |
ViewPasswordStartsWith | query | string | No | |
ViewPasswordEndsWith | query | string | No | |
ViewPasswordContains | query | string | No | |
ViewPasswordLike | query | string | No | |
ViewPasswordBetween | query | string[] | No | |
ViewPasswordIn | query | string[] | No | |
EditPassword | query | string | No | |
EditPasswordStartsWith | query | string | No | |
EditPasswordEndsWith | query | string | No | |
EditPasswordContains | query | string | No | |
EditPasswordLike | query | string | No | |
EditPasswordBetween | query | string[] | No | |
EditPasswordIn | query | string[] | No | |
IsEncrypted | query | bool? | No | |
RowHash | query | byte[] | No | |
Code | query | string | No | |
CodeStartsWith | query | string | No | |
CodeEndsWith | query | string | No | |
CodeContains | query | string | No | |
CodeLike | query | string | No | |
CodeBetween | query | string[] | No | |
CodeIn | query | string[] | No | |
ExceptionPolicy | query | short? | No | |
ExceptionPolicyGreaterThanOrEqualTo | query | short? | No | |
ExceptionPolicyGreaterThan | query | short? | No | |
ExceptionPolicyLessThan | query | short? | No | |
ExceptionPolicyLessThanOrEqualTo | query | short? | No | |
ExceptionPolicyNotEqualTo | query | short? | No | |
ExceptionPolicyBetween | query | short[] | No | |
ExceptionPolicyIn | query | short[] | No | |
IsIsolatedToOwnAppDomain | query | bool? | No | |
FileHash | query | string | No | |
FileHashStartsWith | query | string | No | |
FileHashEndsWith | query | string | No | |
FileHashContains | query | string | No | |
FileHashLike | query | string | No | |
FileHashBetween | query | string[] | No | |
FileHashIn | query | string[] | No | |
CreateDateTime | query | DateTime? | No | |
CreateDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
CreateDateTimeGreaterThan | query | DateTime? | No | |
CreateDateTimeLessThan | query | DateTime? | No | |
CreateDateTimeLessThanOrEqualTo | query | DateTime? | No | |
CreateDateTimeNotEqualTo | query | DateTime? | No | |
CreateDateTimeBetween | query | DateTime[] | No | |
CreateDateTimeIn | query | DateTime[] | No | |
LastWriteDateTime | query | DateTime? | No | |
LastWriteDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
LastWriteDateTimeGreaterThan | query | DateTime? | No | |
LastWriteDateTimeLessThan | query | DateTime? | No | |
LastWriteDateTimeLessThanOrEqualTo | query | DateTime? | No | |
LastWriteDateTimeNotEqualTo | query | DateTime? | No | |
LastWriteDateTimeBetween | query | DateTime[] | No | |
LastWriteDateTimeIn | query | DateTime[] | No | |
Language | query | byte? | No | |
LanguageGreaterThanOrEqualTo | query | byte? | No | |
LanguageGreaterThan | query | byte? | No | |
LanguageLessThan | query | byte? | No | |
LanguageLessThanOrEqualTo | query | byte? | No | |
LanguageNotEqualTo | query | byte? | No | |
LanguageBetween | query | byte[] | No | |
LanguageIn | query | byte[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | form | Guid | No | |
Name | form | string | No | |
Description | form | string | No | |
IsEnabled | form | bool? | No | |
ExecutionOrder | form | int | No | |
Author | form | string | No | |
Version | form | string | No | |
LicenceKey | form | string | No | |
ViewPassword | form | string | No | |
EditPassword | form | string | No | |
IsEncrypted | form | bool? | No | |
RowHash | form | byte[] | No | |
Code | form | string | No | |
ExceptionPolicy | form | short | No | |
IsIsolatedToOwnAppDomain | form | bool? | No | |
FileHash | form | string | No | |
CreateDateTime | form | DateTime | No | |
LastWriteDateTime | form | DateTime | No | |
Language | form | byte | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Queries/SY_Plugin HTTP/1.1 Host: api.jiwa.com.au Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"Results":[{"Name":"String","Description":"String","IsEnabled":false,"Author":"String","Version":"String","LicenceKey":"String","ViewPassword":"String","EditPassword":"String","IsEncrypted":false,"RowHash":"AA==","Code":"String","IsIsolatedToOwnAppDomain":false,"FileHash":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}