| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | query | Guid? | No | |
| RecIDIn | query | Guid[] | No | |
| SY_Forms_ClassName | query | string | No | |
| SY_Forms_ClassNameStartsWith | query | string | No | |
| SY_Forms_ClassNameEndsWith | query | string | No | |
| SY_Forms_ClassNameContains | query | string | No | |
| SY_Forms_ClassNameLike | query | string | No | |
| SY_Forms_ClassNameBetween | query | string[] | No | |
| SY_Forms_ClassNameIn | query | string[] | No | |
| HR_Staff_StaffID | query | string | No | |
| HR_Staff_StaffIDStartsWith | query | string | No | |
| HR_Staff_StaffIDEndsWith | query | string | No | |
| HR_Staff_StaffIDContains | query | string | No | |
| HR_Staff_StaffIDLike | query | string | No | |
| HR_Staff_StaffIDBetween | query | string[] | No | |
| HR_Staff_StaffIDIn | query | string[] | No | |
| Document_RecID | query | string | No | |
| Document_RecIDStartsWith | query | string | No | |
| Document_RecIDEndsWith | query | string | No | |
| Document_RecIDContains | query | string | No | |
| Document_RecIDLike | query | string | No | |
| Document_RecIDBetween | query | string[] | No | |
| Document_RecIDIn | query | string[] | No | |
| Document_DisplayText | query | string | No | |
| Document_DisplayTextStartsWith | query | string | No | |
| Document_DisplayTextEndsWith | query | string | No | |
| Document_DisplayTextContains | query | string | No | |
| Document_DisplayTextLike | query | string | No | |
| Document_DisplayTextBetween | query | string[] | No | |
| Document_DisplayTextIn | query | string[] | No | |
| IsPinned | query | bool? | No | |
| LastSavedDateTime | query | DateTime? | No | |
| LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeGreaterThan | query | DateTime? | No | |
| LastSavedDateTimeLessThan | query | DateTime? | No | |
| LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
| LastSavedDateTimeBetween | query | DateTime[] | No | |
| LastSavedDateTimeIn | query | DateTime[] | 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 | |
| SY_Forms_ClassName | form | string | No | |
| HR_Staff_StaffID | form | string | No | |
| Document_RecID | form | string | No | |
| Document_DisplayText | form | string | No | |
| IsPinned | form | bool | No | |
| LastSavedDateTime | form | DateTime | 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_RecentlyViewedQuery HTTP/1.1
Host: localhost
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RecID":"00000000000000000000000000000000","RecIDIn":["00000000-0000-0000-0000-000000000000"],"SY_Forms_ClassName":"String","SY_Forms_ClassNameStartsWith":"String","SY_Forms_ClassNameEndsWith":"String","SY_Forms_ClassNameContains":"String","SY_Forms_ClassNameLike":"String","SY_Forms_ClassNameBetween":["String"],"SY_Forms_ClassNameIn":["String"],"HR_Staff_StaffID":"String","HR_Staff_StaffIDStartsWith":"String","HR_Staff_StaffIDEndsWith":"String","HR_Staff_StaffIDContains":"String","HR_Staff_StaffIDLike":"String","HR_Staff_StaffIDBetween":["String"],"HR_Staff_StaffIDIn":["String"],"Document_RecID":"String","Document_RecIDStartsWith":"String","Document_RecIDEndsWith":"String","Document_RecIDContains":"String","Document_RecIDLike":"String","Document_RecIDBetween":["String"],"Document_RecIDIn":["String"],"Document_DisplayText":"String","Document_DisplayTextStartsWith":"String","Document_DisplayTextEndsWith":"String","Document_DisplayTextContains":"String","Document_DisplayTextLike":"String","Document_DisplayTextBetween":["String"],"Document_DisplayTextIn":["String"],"IsPinned":false,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"LastSavedDateTimeIn":["0001-01-01T00:00:00.0000000"],"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":[{"SY_Forms_ClassName":"String","HR_Staff_StaffID":"String","Document_RecID":"String","Document_DisplayText":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}