PUT api/2.0/project/{id}
Updates the existing project using all the parameters (project ID, title, description, responsible ID, etc) specified in the request.
Name |
Description |
Type |
Example |
id
sent in url
|
Project ID
|
number
|
1234
|
title
sent in body
|
New project title
|
string
|
some text
|
description
sent in body
|
New project description
|
string
|
some text
|
responsibleId
sent in body
|
New project responsible ID
|
guid
|
9924256A-739C-462b-AF15-E652A3B1B6EB
|
tags
sent in body
|
New project tags
|
string
|
some text
|
participants
sent in body
|
New project participants
|
Collection of guids
collection
|
9924256A-739C-462b-AF15-E652A3B1B6EB
|
status
sent in body
|
New project status: Open, Paused or Closed
optional
|
project status
|
Open = 0, Closed = 1
|
private
sent in body
|
Private project or not
optional
|
Bool value
|
true
|
notify
sent in body
|
Notifies a project manager about the project actions or not
|
Bool value
|
true
|
PUT api/2.0/project/1234
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",
"participants": [
"00000000-0000-0000-0000-000000000000"
],
"status": null,
"private": null,
"notify": true
}
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": "2023-02-01T01:35:47.4310536Z",
"createdBy": {
"id": "00000000-0000-0000-0000-000000000000",
"displayName": "Mike Zanyatski",
"title": "Manager",
"avatarSmall": "url to small avatar",
"profileUrl": ""
},
"updated": "2023-02-01T01:35:47.4310536Z"
}
}
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>2023-02-01T01:35:47.4310536Z</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>2023-02-01T01:35:47.4310536Z</updated>
</response>
</result>