Get Started
Usage API
More information

POST api/2.0/project This function requires authentication

Description

Creates a new project using all the necessary (title, description, responsible ID, etc) and some optional parameters specified in the request.

Parameters
Name Description Type Example
title
sent in body
Project title string some text
description
sent in body
Project description string some text
responsibleId
sent in body
Project responsible ID guid 9924256A-739C-462b-AF15-E652A3B1B6EB
tags
sent in body
Project tags string some text
private
sent in body
Private project or not Bool value true
participants
sent in body
Project participants
optional
Collection of guids
collection
9924256A-739C-462b-AF15-E652A3B1B6EB
notify
sent in body
Notifies a project manager about the project actions or not
optional
Bool value true
tasks
sent in body
Project tasks
collection
milestones
sent in body
Project milestones
collection
notifyResponsibles
sent in body
Notifies responsibles about the project actions or not
optional
Bool value true
Example
POST api/2.0/project
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "title": "some text",
  "description": "some text",
  "responsibleId": "9924256A-739C-462b-AF15-E652A3B1B6EB",
  "tags": "some text",
  "private": true,
  "participants": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "notify": null,
  "tasks": [],
  "milestones": [],
  "notifyResponsibles": null
}
Returns

Newly created project

Example Response

application/json

{
  "status": 0,
  "response": {
    "canEdit": false,
    "canDelete": false,
    "security": null,
    "projectFolder": 13234,
    "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": ""
    },
    "isPrivate": false,
    "taskCount": 0,
    "taskCountTotal": 0,
    "milestoneCount": 0,
    "discussionCount": 0,
    "participantCount": 0,
    "timeTrackingTotal": null,
    "documentsCount": 0,
    "isFollow": false,
    "updatedBy": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "created": "2021-10-16T17:55:51.3470343Z",
    "createdBy": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "updated": "2021-10-16T17:55:51.3470343Z"
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <canEdit>false</canEdit>
    <canDelete>false</canDelete>
    <security />
    <projectFolder>13234</projectFolder>
    <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></profileUrl>
    </responsible>
    <isPrivate>false</isPrivate>
    <taskCount>0</taskCount>
    <taskCountTotal>0</taskCountTotal>
    <milestoneCount>0</milestoneCount>
    <discussionCount>0</discussionCount>
    <participantCount>0</participantCount>
    <timeTrackingTotal />
    <documentsCount>0</documentsCount>
    <isFollow>false</isFollow>
    <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-16T17:55:51.3470343Z</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-16T17:55:51.3470343Z</updated>
  </response>
</result>