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 | |
ToDoNo | query | string | No | |
ToDoNoStartsWith | query | string | No | |
ToDoNoEndsWith | query | string | No | |
ToDoNoContains | query | string | No | |
ToDoNoLike | query | string | No | |
ToDoNoBetween | query | string[] | No | |
ToDoNoIn | query | string[] | No | |
Subject | query | string | No | |
SubjectStartsWith | query | string | No | |
SubjectEndsWith | query | string | No | |
SubjectContains | query | string | No | |
SubjectLike | query | string | No | |
SubjectBetween | query | string[] | No | |
SubjectIn | query | string[] | No | |
Body | query | string | No | |
BodyStartsWith | query | string | No | |
BodyEndsWith | query | string | No | |
BodyContains | query | string | No | |
BodyLike | query | string | No | |
BodyBetween | query | string[] | No | |
BodyIn | query | string[] | No | |
TD_Priorities_RecID | query | string | No | |
TD_Priorities_RecIDStartsWith | query | string | No | |
TD_Priorities_RecIDEndsWith | query | string | No | |
TD_Priorities_RecIDContains | query | string | No | |
TD_Priorities_RecIDLike | query | string | No | |
TD_Priorities_RecIDBetween | query | string[] | No | |
TD_Priorities_RecIDIn | query | string[] | No | |
DurationInHours | query | int? | No | |
DurationInHoursGreaterThanOrEqualTo | query | int? | No | |
DurationInHoursGreaterThan | query | int? | No | |
DurationInHoursLessThan | query | int? | No | |
DurationInHoursLessThanOrEqualTo | query | int? | No | |
DurationInHoursNotEqualTo | query | int? | No | |
DurationInHoursBetween | query | int[] | No | |
DurationInHoursIn | query | int[] | No | |
AssignedBy_HR_Staff_RecID | query | string | No | |
AssignedBy_HR_Staff_RecIDStartsWith | query | string | No | |
AssignedBy_HR_Staff_RecIDEndsWith | query | string | No | |
AssignedBy_HR_Staff_RecIDContains | query | string | No | |
AssignedBy_HR_Staff_RecIDLike | query | string | No | |
AssignedBy_HR_Staff_RecIDBetween | query | string[] | No | |
AssignedBy_HR_Staff_RecIDIn | query | string[] | No | |
AssignedTo_HR_Staff_RecID | query | string | No | |
AssignedTo_HR_Staff_RecIDStartsWith | query | string | No | |
AssignedTo_HR_Staff_RecIDEndsWith | query | string | No | |
AssignedTo_HR_Staff_RecIDContains | query | string | No | |
AssignedTo_HR_Staff_RecIDLike | query | string | No | |
AssignedTo_HR_Staff_RecIDBetween | query | string[] | No | |
AssignedTo_HR_Staff_RecIDIn | query | string[] | No | |
ReminderEnabled | query | bool? | No | |
ReminderTrigger | query | int? | No | |
ReminderTriggerGreaterThanOrEqualTo | query | int? | No | |
ReminderTriggerGreaterThan | query | int? | No | |
ReminderTriggerLessThan | query | int? | No | |
ReminderTriggerLessThanOrEqualTo | query | int? | No | |
ReminderTriggerNotEqualTo | query | int? | No | |
ReminderTriggerBetween | query | int[] | No | |
ReminderTriggerIn | query | int[] | No | |
ReminderPredefinedSetting | query | int? | No | |
ReminderPredefinedSettingGreaterThanOrEqualTo | query | int? | No | |
ReminderPredefinedSettingGreaterThan | query | int? | No | |
ReminderPredefinedSettingLessThan | query | int? | No | |
ReminderPredefinedSettingLessThanOrEqualTo | query | int? | No | |
ReminderPredefinedSettingNotEqualTo | query | int? | No | |
ReminderPredefinedSettingBetween | query | int[] | No | |
ReminderPredefinedSettingIn | query | int[] | No | |
ReminderSpecificDateTime | query | DateTime? | No | |
ReminderSpecificDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
ReminderSpecificDateTimeGreaterThan | query | DateTime? | No | |
ReminderSpecificDateTimeLessThan | query | DateTime? | No | |
ReminderSpecificDateTimeLessThanOrEqualTo | query | DateTime? | No | |
ReminderSpecificDateTimeNotEqualTo | query | DateTime? | No | |
ReminderSpecificDateTimeBetween | query | DateTime[] | No | |
ReminderSpecificDateTimeIn | query | DateTime[] | No | |
Source_SY_Forms_ClassName | query | string | No | |
Source_SY_Forms_ClassNameStartsWith | query | string | No | |
Source_SY_Forms_ClassNameEndsWith | query | string | No | |
Source_SY_Forms_ClassNameContains | query | string | No | |
Source_SY_Forms_ClassNameLike | query | string | No | |
Source_SY_Forms_ClassNameBetween | query | string[] | No | |
Source_SY_Forms_ClassNameIn | query | string[] | No | |
Source_RecID | query | string | No | |
Source_RecIDStartsWith | query | string | No | |
Source_RecIDEndsWith | query | string | No | |
Source_RecIDContains | query | string | No | |
Source_RecIDLike | query | string | No | |
Source_RecIDBetween | query | string[] | No | |
Source_RecIDIn | query | string[] | No | |
TD_ToDoTypes_RecID | query | string | No | |
TD_ToDoTypes_RecIDStartsWith | query | string | No | |
TD_ToDoTypes_RecIDEndsWith | query | string | No | |
TD_ToDoTypes_RecIDContains | query | string | No | |
TD_ToDoTypes_RecIDLike | query | string | No | |
TD_ToDoTypes_RecIDBetween | query | string[] | No | |
TD_ToDoTypes_RecIDIn | query | string[] | No | |
UsesStatusTracking | query | bool? | No | |
TD_Statuses_RecID | query | string | No | |
TD_Statuses_RecIDStartsWith | query | string | No | |
TD_Statuses_RecIDEndsWith | query | string | No | |
TD_Statuses_RecIDContains | query | string | No | |
TD_Statuses_RecIDLike | query | string | No | |
TD_Statuses_RecIDBetween | query | string[] | No | |
TD_Statuses_RecIDIn | query | string[] | No | |
CompletePercentage | query | int? | No | |
CompletePercentageGreaterThanOrEqualTo | query | int? | No | |
CompletePercentageGreaterThan | query | int? | No | |
CompletePercentageLessThan | query | int? | No | |
CompletePercentageLessThanOrEqualTo | query | int? | No | |
CompletePercentageNotEqualTo | query | int? | No | |
CompletePercentageBetween | query | int[] | No | |
CompletePercentageIn | query | int[] | No | |
LastSaved_HR_Staff_RecID | query | string | No | |
LastSaved_HR_Staff_RecIDStartsWith | query | string | No | |
LastSaved_HR_Staff_RecIDEndsWith | query | string | No | |
LastSaved_HR_Staff_RecIDContains | query | string | No | |
LastSaved_HR_Staff_RecIDLike | query | string | No | |
LastSaved_HR_Staff_RecIDBetween | query | string[] | No | |
LastSaved_HR_Staff_RecIDIn | query | string[] | 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 | |
DueDateTime | query | DateTime? | No | |
DueDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
DueDateTimeGreaterThan | query | DateTime? | No | |
DueDateTimeLessThan | query | DateTime? | No | |
DueDateTimeLessThanOrEqualTo | query | DateTime? | No | |
DueDateTimeNotEqualTo | query | DateTime? | No | |
DueDateTimeBetween | query | DateTime[] | No | |
DueDateTimeIn | query | DateTime[] | No | |
FinishedDateTime | query | DateTime? | No | |
FinishedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
FinishedDateTimeGreaterThan | query | DateTime? | No | |
FinishedDateTimeLessThan | query | DateTime? | No | |
FinishedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
FinishedDateTimeNotEqualTo | query | DateTime? | No | |
FinishedDateTimeBetween | query | Nullable<DateTime>[] | No | |
FinishedDateTimeIn | query | Nullable<DateTime>[] | No | |
HasBeenRead | query | bool? | No | |
ReminderSent | query | bool? | No | |
Source_DisplayText | query | string | No | |
Source_DisplayTextStartsWith | query | string | No | |
Source_DisplayTextEndsWith | query | string | No | |
Source_DisplayTextContains | query | string | No | |
Source_DisplayTextLike | query | string | No | |
Source_DisplayTextBetween | query | string[] | No | |
Source_DisplayTextIn | query | string[] | 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 | |
ToDoNo | form | string | No | |
Subject | form | string | No | |
Body | form | string | No | |
TD_Priorities_RecID | form | string | No | |
DurationInHours | form | int | No | |
AssignedBy_HR_Staff_RecID | form | string | No | |
AssignedTo_HR_Staff_RecID | form | string | No | |
ReminderEnabled | form | bool | No | |
ReminderTrigger | form | int | No | |
ReminderPredefinedSetting | form | int | No | |
ReminderSpecificDateTime | form | DateTime | No | |
Source_SY_Forms_ClassName | form | string | No | |
Source_RecID | form | string | No | |
TD_ToDoTypes_RecID | form | string | No | |
UsesStatusTracking | form | bool | No | |
TD_Statuses_RecID | form | string | No | |
CompletePercentage | form | int | No | |
LastSaved_HR_Staff_RecID | form | string | No | |
LastSavedDateTime | form | DateTime | No | |
DueDateTime | form | DateTime | No | |
FinishedDateTime | form | DateTime? | No | |
HasBeenRead | form | bool | No | |
ReminderSent | form | bool | No | |
Source_DisplayText | form | string | 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/TD_MainQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"ToDoNo":"String","ToDoNoStartsWith":"String","ToDoNoEndsWith":"String","ToDoNoContains":"String","ToDoNoLike":"String","ToDoNoBetween":["String"],"ToDoNoIn":["String"],"Subject":"String","SubjectStartsWith":"String","SubjectEndsWith":"String","SubjectContains":"String","SubjectLike":"String","SubjectBetween":["String"],"SubjectIn":["String"],"Body":"String","BodyStartsWith":"String","BodyEndsWith":"String","BodyContains":"String","BodyLike":"String","BodyBetween":["String"],"BodyIn":["String"],"TD_Priorities_RecID":"String","TD_Priorities_RecIDStartsWith":"String","TD_Priorities_RecIDEndsWith":"String","TD_Priorities_RecIDContains":"String","TD_Priorities_RecIDLike":"String","TD_Priorities_RecIDBetween":["String"],"TD_Priorities_RecIDIn":["String"],"DurationInHours":0,"DurationInHoursGreaterThanOrEqualTo":0,"DurationInHoursGreaterThan":0,"DurationInHoursLessThan":0,"DurationInHoursLessThanOrEqualTo":0,"DurationInHoursNotEqualTo":0,"DurationInHoursBetween":[0],"DurationInHoursIn":[0],"AssignedBy_HR_Staff_RecID":"String","AssignedBy_HR_Staff_RecIDStartsWith":"String","AssignedBy_HR_Staff_RecIDEndsWith":"String","AssignedBy_HR_Staff_RecIDContains":"String","AssignedBy_HR_Staff_RecIDLike":"String","AssignedBy_HR_Staff_RecIDBetween":["String"],"AssignedBy_HR_Staff_RecIDIn":["String"],"AssignedTo_HR_Staff_RecID":"String","AssignedTo_HR_Staff_RecIDStartsWith":"String","AssignedTo_HR_Staff_RecIDEndsWith":"String","AssignedTo_HR_Staff_RecIDContains":"String","AssignedTo_HR_Staff_RecIDLike":"String","AssignedTo_HR_Staff_RecIDBetween":["String"],"AssignedTo_HR_Staff_RecIDIn":["String"],"ReminderEnabled":false,"ReminderTrigger":0,"ReminderTriggerGreaterThanOrEqualTo":0,"ReminderTriggerGreaterThan":0,"ReminderTriggerLessThan":0,"ReminderTriggerLessThanOrEqualTo":0,"ReminderTriggerNotEqualTo":0,"ReminderTriggerBetween":[0],"ReminderTriggerIn":[0],"ReminderPredefinedSetting":0,"ReminderPredefinedSettingGreaterThanOrEqualTo":0,"ReminderPredefinedSettingGreaterThan":0,"ReminderPredefinedSettingLessThan":0,"ReminderPredefinedSettingLessThanOrEqualTo":0,"ReminderPredefinedSettingNotEqualTo":0,"ReminderPredefinedSettingBetween":[0],"ReminderPredefinedSettingIn":[0],"ReminderSpecificDateTime":"0001-01-01T00:00:00.0000000","ReminderSpecificDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","ReminderSpecificDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","ReminderSpecificDateTimeLessThan":"0001-01-01T00:00:00.0000000","ReminderSpecificDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","ReminderSpecificDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","ReminderSpecificDateTimeBetween":["0001-01-01T00:00:00.0000000"],"ReminderSpecificDateTimeIn":["0001-01-01T00:00:00.0000000"],"Source_SY_Forms_ClassName":"String","Source_SY_Forms_ClassNameStartsWith":"String","Source_SY_Forms_ClassNameEndsWith":"String","Source_SY_Forms_ClassNameContains":"String","Source_SY_Forms_ClassNameLike":"String","Source_SY_Forms_ClassNameBetween":["String"],"Source_SY_Forms_ClassNameIn":["String"],"Source_RecID":"String","Source_RecIDStartsWith":"String","Source_RecIDEndsWith":"String","Source_RecIDContains":"String","Source_RecIDLike":"String","Source_RecIDBetween":["String"],"Source_RecIDIn":["String"],"TD_ToDoTypes_RecID":"String","TD_ToDoTypes_RecIDStartsWith":"String","TD_ToDoTypes_RecIDEndsWith":"String","TD_ToDoTypes_RecIDContains":"String","TD_ToDoTypes_RecIDLike":"String","TD_ToDoTypes_RecIDBetween":["String"],"TD_ToDoTypes_RecIDIn":["String"],"UsesStatusTracking":false,"TD_Statuses_RecID":"String","TD_Statuses_RecIDStartsWith":"String","TD_Statuses_RecIDEndsWith":"String","TD_Statuses_RecIDContains":"String","TD_Statuses_RecIDLike":"String","TD_Statuses_RecIDBetween":["String"],"TD_Statuses_RecIDIn":["String"],"CompletePercentage":0,"CompletePercentageGreaterThanOrEqualTo":0,"CompletePercentageGreaterThan":0,"CompletePercentageLessThan":0,"CompletePercentageLessThanOrEqualTo":0,"CompletePercentageNotEqualTo":0,"CompletePercentageBetween":[0],"CompletePercentageIn":[0],"LastSaved_HR_Staff_RecID":"String","LastSaved_HR_Staff_RecIDStartsWith":"String","LastSaved_HR_Staff_RecIDEndsWith":"String","LastSaved_HR_Staff_RecIDContains":"String","LastSaved_HR_Staff_RecIDLike":"String","LastSaved_HR_Staff_RecIDBetween":["String"],"LastSaved_HR_Staff_RecIDIn":["String"],"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"],"DueDateTime":"0001-01-01T00:00:00.0000000","DueDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DueDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","DueDateTimeLessThan":"0001-01-01T00:00:00.0000000","DueDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DueDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","DueDateTimeBetween":["0001-01-01T00:00:00.0000000"],"DueDateTimeIn":["0001-01-01T00:00:00.0000000"],"FinishedDateTime":"0001-01-01T00:00:00.0000000","FinishedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","FinishedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","FinishedDateTimeLessThan":"0001-01-01T00:00:00.0000000","FinishedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","FinishedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","FinishedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"FinishedDateTimeIn":["0001-01-01T00:00:00.0000000"],"HasBeenRead":false,"ReminderSent":false,"Source_DisplayText":"String","Source_DisplayTextStartsWith":"String","Source_DisplayTextEndsWith":"String","Source_DisplayTextContains":"String","Source_DisplayTextLike":"String","Source_DisplayTextBetween":["String"],"Source_DisplayTextIn":["String"],"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","ToDoNo":"String","Subject":"String","Body":"String","TD_Priorities_RecID":"String","AssignedBy_HR_Staff_RecID":"String","AssignedTo_HR_Staff_RecID":"String","Source_SY_Forms_ClassName":"String","Source_RecID":"String","TD_ToDoTypes_RecID":"String","TD_Statuses_RecID":"String","LastSaved_HR_Staff_RecID":"String","FinishedDateTime":"0001-01-01T00:00:00.0000000","Source_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"}}}