| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecId | query | string | No | |
| RecIdStartsWith | query | string | No | |
| RecIdEndsWith | query | string | No | |
| RecIdContains | query | string | No | |
| RecIdLike | query | string | No | |
| RecIdBetween | query | string[] | No | |
| RecIdIn | query | string[] | No | |
| PK | query | int? | No | |
| PKGreaterThanOrEqualTo | query | int? | No | |
| PKGreaterThan | query | int? | No | |
| PKLessThan | query | int? | No | |
| PKLessThanOrEqualTo | query | int? | No | |
| PKNotEqualTo | query | int? | No | |
| PKBetween | query | int[] | No | |
| PKIn | query | int[] | No | |
| DatabaseMajor | query | byte? | No | |
| DatabaseMajorGreaterThanOrEqualTo | query | byte? | No | |
| DatabaseMajorGreaterThan | query | byte? | No | |
| DatabaseMajorLessThan | query | byte? | No | |
| DatabaseMajorLessThanOrEqualTo | query | byte? | No | |
| DatabaseMajorNotEqualTo | query | byte? | No | |
| DatabaseMajorBetween | query | byte[] | No | |
| DatabaseMajorIn | query | byte[] | No | |
| DatabaseMinor | query | byte? | No | |
| DatabaseMinorGreaterThanOrEqualTo | query | byte? | No | |
| DatabaseMinorGreaterThan | query | byte? | No | |
| DatabaseMinorLessThan | query | byte? | No | |
| DatabaseMinorLessThanOrEqualTo | query | byte? | No | |
| DatabaseMinorNotEqualTo | query | byte? | No | |
| DatabaseMinorBetween | query | byte[] | No | |
| DatabaseMinorIn | query | byte[] | No | |
| DatabaseRelease | query | byte? | No | |
| DatabaseReleaseGreaterThanOrEqualTo | query | byte? | No | |
| DatabaseReleaseGreaterThan | query | byte? | No | |
| DatabaseReleaseLessThan | query | byte? | No | |
| DatabaseReleaseLessThanOrEqualTo | query | byte? | No | |
| DatabaseReleaseNotEqualTo | query | byte? | No | |
| DatabaseReleaseBetween | query | byte[] | No | |
| DatabaseReleaseIn | query | byte[] | No | |
| ScriptOrder | query | int? | No | |
| ScriptOrderGreaterThanOrEqualTo | query | int? | No | |
| ScriptOrderGreaterThan | query | int? | No | |
| ScriptOrderLessThan | query | int? | No | |
| ScriptOrderLessThanOrEqualTo | query | int? | No | |
| ScriptOrderNotEqualTo | query | int? | No | |
| ScriptOrderBetween | query | int[] | No | |
| ScriptOrderIn | query | int[] | No | |
| Script | query | string | No | |
| ScriptStartsWith | query | string | No | |
| ScriptEndsWith | query | string | No | |
| ScriptContains | query | string | No | |
| ScriptLike | query | string | No | |
| ScriptBetween | query | string[] | No | |
| ScriptIn | query | string[] | No | |
| Status | query | byte? | No | |
| StatusGreaterThanOrEqualTo | query | byte? | No | |
| StatusGreaterThan | query | byte? | No | |
| StatusLessThan | query | byte? | No | |
| StatusLessThanOrEqualTo | query | byte? | No | |
| StatusNotEqualTo | query | byte? | No | |
| StatusBetween | query | byte[] | No | |
| StatusIn | query | byte[] | No | |
| Message | query | string | No | |
| MessageStartsWith | query | string | No | |
| MessageEndsWith | query | string | No | |
| MessageContains | query | string | No | |
| MessageLike | query | string | No | |
| MessageBetween | query | string[] | No | |
| MessageIn | query | string[] | No | |
| ScriptType | query | byte? | No | |
| ScriptTypeGreaterThanOrEqualTo | query | byte? | No | |
| ScriptTypeGreaterThan | query | byte? | No | |
| ScriptTypeLessThan | query | byte? | No | |
| ScriptTypeLessThanOrEqualTo | query | byte? | No | |
| ScriptTypeNotEqualTo | query | byte? | No | |
| ScriptTypeBetween | query | byte[] | No | |
| ScriptTypeIn | query | byte[] | No | |
| RowHash | 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 | string | No | |
| PK | form | int | No | |
| DatabaseMajor | form | byte | No | |
| DatabaseMinor | form | byte | No | |
| DatabaseRelease | form | byte | No | |
| ScriptOrder | form | int | No | |
| Script | form | string | No | |
| Status | form | byte | No | |
| Message | form | string | No | |
| ScriptType | form | byte | No | |
| RowHash | 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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/SY_UpgradeScriptsQuery HTTP/1.1
Host: localhost
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RecId":"String","RecIdStartsWith":"String","RecIdEndsWith":"String","RecIdContains":"String","RecIdLike":"String","RecIdBetween":["String"],"RecIdIn":["String"],"PK":0,"PKGreaterThanOrEqualTo":0,"PKGreaterThan":0,"PKLessThan":0,"PKLessThanOrEqualTo":0,"PKNotEqualTo":0,"PKBetween":[0],"PKIn":[0],"DatabaseMajor":0,"DatabaseMajorGreaterThanOrEqualTo":0,"DatabaseMajorGreaterThan":0,"DatabaseMajorLessThan":0,"DatabaseMajorLessThanOrEqualTo":0,"DatabaseMajorNotEqualTo":0,"DatabaseMajorBetween":"AA==","DatabaseMajorIn":"AA==","DatabaseMinor":0,"DatabaseMinorGreaterThanOrEqualTo":0,"DatabaseMinorGreaterThan":0,"DatabaseMinorLessThan":0,"DatabaseMinorLessThanOrEqualTo":0,"DatabaseMinorNotEqualTo":0,"DatabaseMinorBetween":"AA==","DatabaseMinorIn":"AA==","DatabaseRelease":0,"DatabaseReleaseGreaterThanOrEqualTo":0,"DatabaseReleaseGreaterThan":0,"DatabaseReleaseLessThan":0,"DatabaseReleaseLessThanOrEqualTo":0,"DatabaseReleaseNotEqualTo":0,"DatabaseReleaseBetween":"AA==","DatabaseReleaseIn":"AA==","ScriptOrder":0,"ScriptOrderGreaterThanOrEqualTo":0,"ScriptOrderGreaterThan":0,"ScriptOrderLessThan":0,"ScriptOrderLessThanOrEqualTo":0,"ScriptOrderNotEqualTo":0,"ScriptOrderBetween":[0],"ScriptOrderIn":[0],"Script":"String","ScriptStartsWith":"String","ScriptEndsWith":"String","ScriptContains":"String","ScriptLike":"String","ScriptBetween":["String"],"ScriptIn":["String"],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":"AA==","StatusIn":"AA==","Message":"String","MessageStartsWith":"String","MessageEndsWith":"String","MessageContains":"String","MessageLike":"String","MessageBetween":["String"],"MessageIn":["String"],"ScriptType":0,"ScriptTypeGreaterThanOrEqualTo":0,"ScriptTypeGreaterThan":0,"ScriptTypeLessThan":0,"ScriptTypeLessThanOrEqualTo":0,"ScriptTypeNotEqualTo":0,"ScriptTypeBetween":"AA==","ScriptTypeIn":"AA==","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":[{"RecId":"String","Script":"String","Message":"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"}}}