POST api/2.0/project/report
Creates a project report template with the parameters specified in the request. Most of the parameters are optional and depend on the report type selected.
Name |
Description |
Type |
Example |
name
sent in body
|
Report name
|
string
|
some text
|
period
sent in body
|
Report template generation period: Day/Week/Month
optional
|
string
|
some text
|
periodItem
sent in body
|
Period item: weekday name (for weekly report, starting with Sunday), day of the month (for monthly report)
optional
|
number
|
1234
|
hour
sent in body
|
Report sending time (in hours)
optional
|
number
|
1234
|
autoGenerated
sent in body
|
Specifies if a report will be 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
|
Report tag
optional
|
number
|
1234
|
project
sent in body
|
Report 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
|
Report view type: by group or by project
optional
|
number
|
1234
|
noResponsible
sent in body
|
Specifies if the tasks without responsibles will be shown or hidden
optional
|
Bool value
|
true
|
isShowAverageTime
sent in body
|
Specifies if the average time will be shown or not
optional
|
Bool value
|
true
|
typeOfShowAverageTime
sent in body
|
Average time type (All, ClosingProjects, CompletingTasks)
optional
|
All, ClosingProjects, CompletingTasks
|
|
projectAverageCompletingTasks
sent in body
|
Specifies if the average time of closing projects will be shown or not
optional
|
Bool value
|
true
|
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,
"isShowAverageTime": true,
"typeOfShowAverageTime": "all",
"projectAverageCompletingTasks": true
}
application/json
{
"status": 0,
"response": {
"autoGenerated": false,
"cron": null,
"reportType": 0,
"filter": null,
"id": 1233,
"title": "Sample ReportTemplate",
"description": "Sample description",
"status": 0,
"created": "2023-01-27T05:35:45.2837279Z",
"createdBy": {
"id": "00000000-0000-0000-0000-000000000000",
"displayName": "Mike Zanyatski",
"title": "Manager",
"avatarSmall": "url to small avatar",
"profileUrl": ""
},
"updated": "2023-01-27T05:35:45.2837279Z"
}
}
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>2023-01-27T05:35:45.2837279Z</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-01-27T05:35:45.2837279Z</updated>
</response>
</result>