GET api/2.0/project/task/filter This function requires authentication

Description

Returns a list with the detailed information about all the tasks matching the parameters specified in the request.

Parameters

Name	Description	Type	Example
projectid sent in url	Project ID optional	number	1234
myProjects sent in url	Specifies whether to return tasks only from my projects or not	Bool value	true
milestone sent in url	Milestone ID optional	number	1234
myMilestones sent in url	Specifies whether to return tasks only from my milestones or not	Bool value	true
nomilestone sent in url	Specifies whether to return tasks only without milestones or not	Bool value	true
tag sent in url	Project tag optional	number	1234
status sent in url	Task status optional	NotAccept = 0,Open = 1, Closed = 2,Disable = 3,Unclassified = 4,NotInMilestone = 5	NotAccept
substatus sent in url	Custom task status optional	number	1234
follow sent in url	Specifies whether to return only followed tasks or not	Bool value	true
departament sent in url	Departament GUID optional	guid	9924256A-739C-462b-AF15-E652A3B1B6EB
participant sent in url	Participant GUID optional	guid	9924256A-739C-462b-AF15-E652A3B1B6EB
creator sent in url	Creator GUID	guid	9924256A-739C-462b-AF15-E652A3B1B6EB
deadlineStart sent in url	Minimum value of task deadline optional	Date and Time	Roundtrip format: 2008-04-10T06-30-00.000Z
deadlineStop sent in url	Maximum value of task deadline optional	Date and Time	Roundtrip format: 2008-04-10T06-30-00.000Z
lastId sent in url	Last task ID	number	1234

Example

GET api/2.0/project/task/filter?projectid=1234&myProjects=true&milestone=1234&myMilestones=true&nomilestone=true&tag=1234&status=%22NotAccept%22&substatus=1234&follow=true&departament=%229924256A-739C-462b-AF15-E652A3B1B6EB%22&participant=%229924256A-739C-462b-AF15-E652A3B1B6EB%22&creator=%229924256A-739C-462b-AF15-E652A3B1B6EB%22&deadlineStart=%222008-04-10T06-30-00.000Z%22&deadlineStop=%222008-04-10T06-30-00.000Z%22&lastId=1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

Returns

List of tasks

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "Id": 10,
      "Title": "Sample Title",
      "Description": "Sample description",
      "Deadline": "2020-12-22T04:11:56.5768573Z",
      "Priority": 1,
      "MilestoneId": 123,
      "ProjectOwner": {
        "Id": "123",
        "Title": "Sample project",
        "Status": 0,
        "IsPrivate": false
      },
      "Progress": 55,
      "Subtasks": [
        {
          "Id": 10,
          "Title": "Sample Title",
          "Description": "Sample description",
          "Status": 0,
          "Responsible": {
            "Id": "00000000-0000-0000-0000-000000000000",
            "DisplayName": "Mike Zanyatski",
            "Title": "Manager",
            "AvatarSmall": "url to small avatar",
            "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
          },
          "ResponsibleId": "00000000-0000-0000-0000-000000000000",
          "UpdatedBy": {
            "Id": "00000000-0000-0000-0000-000000000000",
            "DisplayName": "Mike Zanyatski",
            "Title": "Manager",
            "AvatarSmall": "url to small avatar",
            "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
          },
          "UpdatedById": "00000000-0000-0000-0000-000000000000",
          "Created": "2020-12-22T04:11:56.5658524Z",
          "CreatedBy": {
            "Id": "00000000-0000-0000-0000-000000000000",
            "DisplayName": "Mike Zanyatski",
            "Title": "Manager",
            "AvatarSmall": "url to small avatar",
            "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
          },
          "CreatedById": "00000000-0000-0000-0000-000000000000",
          "Updated": "2020-12-22T04:11:56.5658524Z",
          "CanEdit": false,
          "TaskId": 1234
        }
      ],
      "Status": 0,
      "Links": [
        {
          "DependenceTaskId": "123",
          "ParentTaskId": "44",
          "LinkType": "1"
        }
      ],
      "Responsible": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "DisplayName": "Mike Zanyatski",
        "Title": "Manager",
        "AvatarSmall": "url to small avatar",
        "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      },
      "ResponsibleId": "00000000-0000-0000-0000-000000000000",
      "UpdatedBy": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "DisplayName": "Mike Zanyatski",
        "Title": "Manager",
        "AvatarSmall": "url to small avatar",
        "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      },
      "UpdatedById": "00000000-0000-0000-0000-000000000000",
      "Created": "2020-12-22T04:11:56.5658524Z",
      "CreatedBy": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "DisplayName": "Mike Zanyatski",
        "Title": "Manager",
        "AvatarSmall": "url to small avatar",
        "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      },
      "CreatedById": "00000000-0000-0000-0000-000000000000",
      "Updated": "2020-12-22T04:11:56.5658524Z",
      "Responsibles": [
        {
          "Id": "00000000-0000-0000-0000-000000000000",
          "DisplayName": "Mike Zanyatski",
          "Title": "Manager",
          "AvatarSmall": "url to small avatar",
          "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
        }
      ],
      "ResponsibleIds": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "Milestone": {
        "Id": 123,
        "Title": "Title",
        "Deadline": "2020-12-22T04:11:56.5768573Z"
      },
      "CustomTaskStatus": 1,
      "CanEdit": false,
      "CanCreateSubtask": false,
      "CanCreateTimeSpend": false,
      "CanDelete": false,
      "CanReadFiles": false,
      "StartDate": "2020-12-22T04:11:56.5768573Z"
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <Id>10</Id>
    <Title>Sample Title</Title>
    <Description>Sample description</Description>
    <Deadline>2020-12-22T04:11:56.5768573Z</Deadline>
    <Priority>1</Priority>
    <MilestoneId>123</MilestoneId>
    <ProjectOwner>
      <Id>123</Id>
      <Title>Sample project</Title>
      <Status>0</Status>
      <IsPrivate>False</IsPrivate>
    </ProjectOwner>
    <Progress>55</Progress>
    <Subtasks>
      <Id>10</Id>
      <Title>Sample Title</Title>
      <Description>Sample description</Description>
      <Status>0</Status>
      <Responsible>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <DisplayName>Mike Zanyatski</DisplayName>
        <Title>Manager</Title>
        <AvatarSmall>url to small avatar</AvatarSmall>
        <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
      </Responsible>
      <ResponsibleId>00000000-0000-0000-0000-000000000000</ResponsibleId>
      <UpdatedBy>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <DisplayName>Mike Zanyatski</DisplayName>
        <Title>Manager</Title>
        <AvatarSmall>url to small avatar</AvatarSmall>
        <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
      </UpdatedBy>
      <UpdatedById>00000000-0000-0000-0000-000000000000</UpdatedById>
      <Created>2020-12-22T04:11:56.5658524Z</Created>
      <CreatedBy>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <DisplayName>Mike Zanyatski</DisplayName>
        <Title>Manager</Title>
        <AvatarSmall>url to small avatar</AvatarSmall>
        <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
      </CreatedBy>
      <CreatedById>00000000-0000-0000-0000-000000000000</CreatedById>
      <Updated>2020-12-22T04:11:56.5658524Z</Updated>
      <CanEdit>False</CanEdit>
      <TaskId>1234</TaskId>
    </Subtasks>
    <Status>0</Status>
    <Links>
      <DependenceTaskId>123</DependenceTaskId>
      <ParentTaskId>44</ParentTaskId>
      <LinkType>1</LinkType>
    </Links>
    <Responsible>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </Responsible>
    <ResponsibleId>00000000-0000-0000-0000-000000000000</ResponsibleId>
    <UpdatedBy>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </UpdatedBy>
    <UpdatedById>00000000-0000-0000-0000-000000000000</UpdatedById>
    <Created>2020-12-22T04:11:56.5658524Z</Created>
    <CreatedBy>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </CreatedBy>
    <CreatedById>00000000-0000-0000-0000-000000000000</CreatedById>
    <Updated>2020-12-22T04:11:56.5658524Z</Updated>
    <Responsibles>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </Responsibles>
    <ResponsibleIds>00000000-0000-0000-0000-000000000000</ResponsibleIds>
    <Milestone>
      <Id>123</Id>
      <Title>Title</Title>
      <Deadline>2020-12-22T04:11:56.5768573Z</Deadline>
    </Milestone>
    <CustomTaskStatus>1</CustomTaskStatus>
    <CanEdit>False</CanEdit>
    <CanCreateSubtask>False</CanCreateSubtask>
    <CanCreateTimeSpend>False</CanCreateTimeSpend>
    <CanDelete>False</CanDelete>
    <CanReadFiles>False</CanReadFiles>
    <StartDate>2020-12-22T04:11:56.5768573Z</StartDate>
  </response>
</result>