TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

POST api/2.0/project/{projectid}/task This function requires authentication

Description

Adds a task to the selected project with the parameters (responsible user ID, task description, deadline time, etc) specified in the request.

Parameters
Name Description Type Example
projectid
sent in url
Project ID number 1234
description
sent in body
Task description string some text
deadline
sent in body
Task deadline time Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
priority
sent in body
Task priority ("Low", "Normal", or "High") High = 1, Normal = 0, Low = -1 Normal
title
sent in body
Task title string some text
milestoneid
sent in body
Task milestone ID number 1234
responsibles
sent in body
List of responsibles Collection of guids
collection
9924256A-739C-462b-AF15-E652A3B1B6EB
notify
sent in body
Specifies whether to notify the responsibles about the task actions or not Bool value true
startDate
sent in body
Task start date Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
Example
POST api/2.0/project/1234/task
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "description": "some text",
  "deadline": "2008-04-10T06-30-00.000Z",
  "priority": "Normal",
  "title": "some text",
  "milestoneid": 1234,
  "responsibles": [
    "9924256A-739C-462b-AF15-E652A3B1B6EB"
  ],
  "notify": true,
  "startDate": "2008-04-10T06-30-00.000Z"
}
Returns

Added task

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>