Read Task
Retrieves the details of a Task object that has been previously created.
Parameters
Path Params | |
---|---|
yourCompany: | string |
Query Params | |
---|---|
filter: | string
https://xyzcompany.agiliron.net/agiliron/api-40/Task?filter=Subject,eq,New task;Test CheckBox,eq,no&key=xyzkey
https://xyzcompany.agiliron.net/agiliron/api-40/Task?filter=CreatedTime,bt,01-15-2020 | 01-31-2020&key=xyzkey
https://xyzcompany.agiliron.net/agiliron/api-40/Task?filter=CreatedTime,bt,01-15-2020 01:03:10| 01-31-2020 20:00:00&key=xyzkey
https://xyzcompany.agiliron.net/agiliron/api-40/Task?filter=Status,eq,Planned OR In Progress&key=xyzkey
https://xyzcompany.agiliron.net/agiliron/api-40/Task?filter=TaskId,eq,3422&key=xyzkey List of condition abbrevations to be used: |
customview: | string https://xyzcompany.agiliron.net/agiliron/api-40/Task?customview=ABC Customview&key=xyzkey |
page: | int https://xyzcompany.agiliron.net/agiliron/api-40/Task?filter=Subject,eq,New task;Test CheckBox,eq,no&page=10&key=xyzkey |
pageSize: | int https://xyzcompany.agiliron.net/agiliron/api-40/Task?filter=Subject,eq,New task;Test CheckBox,eq,no&pageSize=10&key=xyzkey |
Header Params | |
---|---|
Accept: | string |
Query Auth | |
---|---|
key: | string |
Header Auth | |
---|---|
apiKey: | string |
Sample Code
{
"Tasks": {
"Task": [{
"TaskId": "3422",
"Subject": "Test New Task",
"StartDate": "01-24-2020",
"StartTime": "05:47:00",
"DueDate": "01-25-2020",
"AccountName": "Account1",
"ContactName": "Contact1",
"RelatedToType": "Accounts",
"RelatedToValue": "Account1",
"Status": "In Progress",
"SendNotification": "No",
"ActivityType": "Task",
"Priority": "High",
"CreatedTime": "01-24-2020 05:51:01",
"CreatedTimeUTC": "01-24-2020 15:01:35",
"ModifiedTime": "01-24-2020 05:53:00",
"ModifiedTimeUTC": "01-24-2020 15:05:56",
"Description": "The Description Goes here.",
"TaskCustomFields": {
"CustomField": [{
"Name": "CustomFied1",
"Value": "Custom info 1"
},
{
"Name": "CustomFied2",
"Value": "Custom info 2"
}
]
}
}],
"TotalRecords": "1",
"CurrentPage": "1",
"TotalPages": "1",
"PageSize": "50"
}
}
<Tasks>
<Task>
<TaskId>3422</TaskId>
<Subject>Test New Task</Subject>
<StartDate>01-24-2020</StartDate>
<StartTime>05:47:00</StartTime>
<DueDate>01-25-2020</DueDate>
<AccountName>Account1</AccountName>
<ContactName>Contact1</ContactName>
<RelatedToType>Accounts</RelatedToType>
<RelatedToValue>Account1</RelatedToValue>
<Status>In Progress</Status>
<SendNotification>No</SendNotification>
<ActivityType>Task</ActivityType>
<Priority>High</Priority>
<CreatedTime>01-24-2020 05:51:01</CreatedTime>
<CreatedTimeUTC>01-24-2020 15:01:35</CreatedTimeUTC>
<ModifiedTime>01-24-2020 05:53:00</ModifiedTime>
<ModifiedTimeUTC>01-24-2020 15:05:56</ModifiedTimeUTC>
<Description>The Description Goes here.</Description>
<TaskCustomFields>
<CustomField>
<Name>CustomFied1</Name>
<Value>Custom info 1</Value>
</CustomField>
<CustomField>
<Name>CustomFied2</Name>
<Value>Custom info 2</Value>
</CustomField>
</TaskCustomFields>
</Task>
<TotalRecords>1</TotalRecords>
<CurrentPage>1</CurrentPage>
<TotalPages>1</TotalPages>
<PageSize>50</PageSize>
</Tasks>
WADL
<?xml version="1.0" encoding="utf-8"?>
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
<resource path="Task">
<method name="GET">
<request>
<param name="key" type="xsd:string" style="query" required="true"/>
<param name="Subject" type="xsd:string" style="query" required="true"/>
<param name="StartDate" type="xsd:date" style="query"/>
<param name="EndDate" type="xsd:date" style="query"/>
<param name="Filter" type="xsd:string" style="query"/>
</request>
<response status="200">
<representation mediaType="application/xml" element="yn:ResultSet"/>
</response>
<response status="400">
<representation mediaType="application/xml" element="ya:Error"/>
</response>
</method>
</resource>
</resources>
</application>
Updated about 21 hours ago