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

Description

Returns a list with the detailed information about all the task time spent matching the filter 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 task time only for my projects or not	Bool value	true
milestone sent in url	Milestone ID optional	number	1234
myMilestones sent in url	Specifies whether to return task time only for my milestones or not	Bool value	true
tag sent in url	Project tag optional	number	1234
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
createdStart sent in url	The earliest date of task creation optional	Date and Time	Roundtrip format: 2008-04-10T06-30-00.000Z
createdStop sent in url	The latest date of task creation optional	Date and Time	Roundtrip format: 2008-04-10T06-30-00.000Z
lastId sent in url	Last spent time ID	number	1234
status sent in url	Payment status ("NotChargeable", "NotBilled", or "Billed") optional	NotChargeable, NotBilled, Billed	NotChargeable

Example

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

Returns

List of spent time

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "Id": 10,
      "Date": "2020-12-22T04:11:56.5438537Z",
      "Hours": 35.0,
      "Note": "Sample note",
      "RelatedProject": 123,
      "Task": {
        "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"
      },
      "RelatedTask": 13456,
      "RelatedTaskTitle": "Sample task",
      "CreatedBy": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "DisplayName": "Mike Zanyatski",
        "Title": "Manager",
        "AvatarSmall": "url to small avatar",
        "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      },
      "Person": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "DisplayName": "Mike Zanyatski",
        "Title": "Manager",
        "AvatarSmall": "url to small avatar",
        "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      },
      "StatusChanged": "2020-12-22T04:11:56.5438537Z",
      "CanEditPaymentStatus": true,
      "CreateOn": "2020-12-22T04:11:56.5438537Z",
      "CanEdit": true,
      "PaymentStatus": 2
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <Id>10</Id>
    <Date>2020-12-22T04:11:56.5438537Z</Date>
    <Hours>35</Hours>
    <Note>Sample note</Note>
    <RelatedProject>123</RelatedProject>
    <Task>
      <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>
    </Task>
    <RelatedTask>13456</RelatedTask>
    <RelatedTaskTitle>Sample task</RelatedTaskTitle>
    <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>
    <Person>
      <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>
    </Person>
    <StatusChanged>2020-12-22T04:11:56.5438537Z</StatusChanged>
    <CanEditPaymentStatus>True</CanEditPaymentStatus>
    <CreateOn>2020-12-22T04:11:56.5438537Z</CreateOn>
    <CanEdit>True</CanEdit>
    <PaymentStatus>2</PaymentStatus>
  </response>
</result>

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

Get information

Get help