GET v1/Tasks?TaskId={TaskId}&ModifiedUserId={ModifiedUserId}&ModifiedDate={ModifiedDate}&FromUserId={FromUserId}&CreationDate={CreationDate}&AssignedUserId={AssignedUserId}&ReferenceType={ReferenceType}&ReferenceKey={ReferenceKey}&Subject={Subject}&DueDate={DueDate}&CompletionDate={CompletionDate}&Status={Status}&Priority={Priority}&Limit={Limit}&Offset={Offset}&Total={Total}&SortDirection={SortDirection}&Sort={Sort}&Expand={Expand}
Task Search
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
TaskId | string |
None. |
|
ModifiedUserId | string |
None. |
|
ModifiedDate | string |
None. |
|
FromUserId | string |
None. |
|
CreationDate | string |
None. |
|
AssignedUserId | string |
None. |
|
ReferenceType | TaskReferenceTypeEnum |
None. |
|
ReferenceKey | string |
String length: inclusive between 0 and 254 |
|
Subject | string |
String length: inclusive between 0 and 254 |
|
DueDate | string |
None. |
|
CompletionDate | string |
None. |
|
Status | TaskStatusEnum |
None. |
|
Priority | TaskPriorityEnum |
None. |
|
Limit |
Maximum number of records to return |
integer |
Range: inclusive between 1 and 2147483647 |
Offset |
Number of records to skip during search, useful for pagination |
integer |
Range: inclusive between 0 and 2147483647 |
Total |
Flag to indicate if the total number of records matching the search should be computed. Default: False. WARNING: Setting to True will considerably slow down search performance when searching large datasets. |
boolean |
None. |
SortDirection |
Direction of sort: Ascending or Descending |
SortDirection |
None. |
Sort |
Comma separated list of field names to sort by |
string |
None. |
Expand |
Comma separated list of expansions to include in results |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
TaskListResponseName | Description | Type | Additional information |
---|---|---|---|
Limit |
Echoed limit of request |
integer |
None. |
Offset |
Echoed offset of request |
integer |
None. |
Total |
Total records matching search, if requested |
integer |
None. |
Data |
List of records matching the search |
Collection of TaskOutboundDTO |
None. |
Response Formats
application/json, text/json
{ "Limit": 1, "Offset": 1, "Total": 1, "Data": [ { "Id": 1, "ModifiedUserId": 1, "ModifiedDate": "2024-03-28T19:09:06.5600557-10:00", "FromUserId": 2, "CreationDate": "2024-03-28T19:09:06.5600557-10:00", "AssignedUserId": 3, "ReferenceType": "Unknown", "ReferenceKey": "sample string 4", "Subject": "sample string 5", "DueDate": "2024-03-28T19:09:06.5600557-10:00", "CompletionDate": "2024-03-28T19:09:06.5600557-10:00", "Status": "Unknown", "Priority": "Unknown", "Annotation": "sample string 7" }, { "Id": 1, "ModifiedUserId": 1, "ModifiedDate": "2024-03-28T19:09:06.5600557-10:00", "FromUserId": 2, "CreationDate": "2024-03-28T19:09:06.5600557-10:00", "AssignedUserId": 3, "ReferenceType": "Unknown", "ReferenceKey": "sample string 4", "Subject": "sample string 5", "DueDate": "2024-03-28T19:09:06.5600557-10:00", "CompletionDate": "2024-03-28T19:09:06.5600557-10:00", "Status": "Unknown", "Priority": "Unknown", "Annotation": "sample string 7" } ] }
application/xml, text/xml
<TaskListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound"> <Data> <TaskOutboundDTO> <Id>1</Id> <Annotation>sample string 7</Annotation> <AssignedUserId>3</AssignedUserId> <CompletionDate>2024-03-28T19:09:06.5600557-10:00</CompletionDate> <CreationDate>2024-03-28T19:09:06.5600557-10:00</CreationDate> <DueDate>2024-03-28T19:09:06.5600557-10:00</DueDate> <FromUserId>2</FromUserId> <ModifiedDate>2024-03-28T19:09:06.5600557-10:00</ModifiedDate> <ModifiedUserId>1</ModifiedUserId> <Priority>Unknown</Priority> <ReferenceKey>sample string 4</ReferenceKey> <ReferenceType>Unknown</ReferenceType> <Status>Unknown</Status> <Subject>sample string 5</Subject> </TaskOutboundDTO> <TaskOutboundDTO> <Id>1</Id> <Annotation>sample string 7</Annotation> <AssignedUserId>3</AssignedUserId> <CompletionDate>2024-03-28T19:09:06.5600557-10:00</CompletionDate> <CreationDate>2024-03-28T19:09:06.5600557-10:00</CreationDate> <DueDate>2024-03-28T19:09:06.5600557-10:00</DueDate> <FromUserId>2</FromUserId> <ModifiedDate>2024-03-28T19:09:06.5600557-10:00</ModifiedDate> <ModifiedUserId>1</ModifiedUserId> <Priority>Unknown</Priority> <ReferenceKey>sample string 4</ReferenceKey> <ReferenceType>Unknown</ReferenceType> <Status>Unknown</Status> <Subject>sample string 5</Subject> </TaskOutboundDTO> </Data> <Limit>1</Limit> <Offset>1</Offset> <Total>1</Total> </TaskListResponse>