Get Started
Usage API
More information

POST api/2.0/project/{id}/milestone This function requires authentication

Description

Adds a new milestone using the parameters (project ID, milestone title, deadline, etc) specified in the request.

Parameters
Name Description Type Example
id
sent in url
Project ID number 1234
title
sent in body
Milestone title string some text
deadline
sent in body
Milestone deadline Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
isKey
sent in body
Specifies if this is a key milestone or not Bool value true
isNotify
sent in body
Reminds me 48 hours before the milestone due date Bool value true
description
sent in body
Milestone description string some text
responsible
sent in body
Milestone responsible guid 9924256A-739C-462b-AF15-E652A3B1B6EB
notifyResponsible
sent in body
Notifies the responsible about the milestone actions or not Bool value true
Example
POST api/2.0/project/1234/milestone
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "title": "some text",
  "deadline": "2008-04-10T06-30-00.000Z",
  "isKey": true,
  "isNotify": true,
  "description": "some text",
  "responsible": "9924256A-739C-462b-AF15-E652A3B1B6EB",
  "notifyResponsible": true
}
Returns

Added milestone

Example Response

application/json

{
  "status": 0,
  "response": {
    "canEdit": true,
    "canDelete": false,
    "id": 10,
    "title": "Sample Title",
    "description": "Sample description",
    "projectOwner": {
      "id": 123,
      "title": "Sample project",
      "status": 0,
      "isPrivate": false
    },
    "deadline": "2021-10-27T06:29:16.2634680Z",
    "isKey": false,
    "isNotify": false,
    "activeTaskCount": 15,
    "closedTaskCount": 5,
    "status": 0,
    "responsible": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "updatedBy": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "created": "2021-10-27T06:29:16.2634680Z",
    "createdBy": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "updated": "2021-10-27T06:29:16.2634680Z"
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <canEdit>true</canEdit>
    <canDelete>false</canDelete>
    <id>10</id>
    <title>Sample Title</title>
    <description>Sample description</description>
    <projectOwner>
      <id>123</id>
      <title>Sample project</title>
      <status>0</status>
      <isPrivate>false</isPrivate>
    </projectOwner>
    <deadline>2021-10-27T06:29:16.2634680Z</deadline>
    <isKey>false</isKey>
    <isNotify>false</isNotify>
    <activeTaskCount>15</activeTaskCount>
    <closedTaskCount>5</closedTaskCount>
    <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></profileUrl>
    </responsible>
    <updatedBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </updatedBy>
    <created>2021-10-27T06:29:16.2634680Z</created>
    <createdBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </createdBy>
    <updated>2021-10-27T06:29:16.2634680Z</updated>
  </response>
</result>