Get Started
Portal api methods
Help

POST api/2.0/project/report This function requires authentication

Description

Creates the project report template with the parameters specified in the request. Most of the parameters are optional and depend on the report type selected.

Parameters
Name Description Type Example
name
sent in body
Report name string some text
period
sent in body
Report template generation period. Can be one of the following: Day/Week/Month
optional
string some text
periodItem
sent in body
Period item. Can be: weekday name (for weekly report, starting with Sunday), day of the month (for monthly report).
optional
number 1234
hour
sent in body
Send time (hour)
optional
number 1234
autoGenerated
sent in body
Automatically generated or not
optional
Bool value true
reportType
sent in body
Report type
optional
MilestonesExpired, MilestonesNearest, UsersWithoutActiveTasks, ProjectsWithoutActiveMilestones, ProjectsWithoutActiveTasks, UsersActivity, UsersWorkload, ProjectsList, TimeSpend, TasksByProjects, TasksByUsers, TasksExpired, EmptyReport
tag
sent in body
Tag
optional
number 1234
project
sent in body
Project
optional
number 1234
status
sent in body
Task status
optional
task status NotAccept = 0,Open = 1, Closed = 2,Disable = 3,Unclassified = 4,NotInMilestone = 5
departament
sent in body
Department/Group
optional
guid 9924256A-739C-462b-AF15-E652A3B1B6EB
userId
sent in body
User GUID
optional
guid 9924256A-739C-462b-AF15-E652A3B1B6EB
reportTimeInterval
sent in body
Report time interval
optional
Absolute, Relative, Today, Yesterday, Tomorrow, CurrWeek, PrevWeek, NextWeek, CurrMonth, PrevMonth, NextMonth, CurrYear, PrevYear, NextYear
fromDate
sent in body
Report period start date
optional
Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
toDate
sent in body
Report period end date
optional
Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
viewType
sent in body
View type: view by group or view by project
optional
number 1234
noResponsible
sent in body
Show or hide tasks without responsible
optional
Bool value true
Example
POST api/2.0/project/report
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "name": "some text",
  "period": "some text",
  "periodItem": 1234,
  "hour": 1234,
  "autoGenerated": true,
  "reportType": "MilestonesExpired",
  "tag": 1234,
  "project": 1234,
  "status": null,
  "departament": "9924256A-739C-462b-AF15-E652A3B1B6EB",
  "userId": "9924256A-739C-462b-AF15-E652A3B1B6EB",
  "reportTimeInterval": "Absolute",
  "fromDate": "2008-04-10T06-30-00.000Z",
  "toDate": "2008-04-10T06-30-00.000Z",
  "viewType": 1234,
  "noResponsible": true
}
Returns

Project report template

Example Response

application/json

{
  "status": 0,
  "response": {
    "autoGenerated": false,
    "cron": null,
    "reportType": 0,
    "filter": null,
    "id": 1233,
    "title": "Sample ReportTemplate",
    "description": "Sample description",
    "status": 0,
    "created": "2019-06-20T03:26:06.3283644Z",
    "createdBy": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "updated": "2019-06-20T03:26:06.3283644Z"
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <autoGenerated>false</autoGenerated>
    <cron />
    <reportType>0</reportType>
    <filter />
    <id>1233</id>
    <title>Sample ReportTemplate</title>
    <description>Sample description</description>
    <status>0</status>
    <created>2019-06-20T03:26:06.3283644Z</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>2019-06-20T03:26:06.3283644Z</updated>
  </response>
</result>