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 generation period: Day/Week/Month
optional
|
string
|
some text
|
periodItem
sent in body
|
Period item: day of the week (for a weekly report, starting with Sunday), day of the month (for a 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
|
MilestonesExpired
|
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
|
NotAccept = 0,Open = 1, Closed = 2,Disable = 3,Unclassified = 4,NotInMilestone = 5
|
NotAccept
|
departament
sent in body
|
Department/Group GUID
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
|
Absolute
|
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
|
ASC.Projects.Core.Domain.AverageTime
|
|
projectAverageCompletingTasks
sent in body
|
Specifies if the average time of completing tasks 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": "NotAccept",
"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": null,
"projectAverageCompletingTasks": true
}
application/json
{
"status": 0,
"response": {
"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": "\\/Products\\/People\\/Profile.aspx?user=administrator"
},
"ResponsibleId": "00000000-0000-0000-0000-000000000000",
"UpdatedBy": {
"Id": "00000000-0000-0000-0000-000000000000",
"DisplayName": "Mike Zanyatski",
"Title": "Manager",
"AvatarSmall": "url to small avatar",
"ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
},
"UpdatedById": "00000000-0000-0000-0000-000000000000",
"Created": "2020-12-22T04:11:56.5658524Z",
"CreatedBy": {
"Id": "00000000-0000-0000-0000-000000000000",
"DisplayName": "Mike Zanyatski",
"Title": "Manager",
"AvatarSmall": "url to small avatar",
"ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
},
"CreatedById": "00000000-0000-0000-0000-000000000000",
"Updated": "2020-12-22T04:11:56.5658524Z",
"AutoGenerated": true,
"Cron": "Cron",
"ReportType": 0,
"Filter": "Filter"
}
}
text/xml
<result>
<status>0</status>
<response>
<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>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
</Responsible>
<ResponsibleId>00000000-0000-0000-0000-000000000000</ResponsibleId>
<UpdatedBy>
<Id>00000000-0000-0000-0000-000000000000</Id>
<DisplayName>Mike Zanyatski</DisplayName>
<Title>Manager</Title>
<AvatarSmall>url to small avatar</AvatarSmall>
<ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
</UpdatedBy>
<UpdatedById>00000000-0000-0000-0000-000000000000</UpdatedById>
<Created>2020-12-22T04:11:56.5658524Z</Created>
<CreatedBy>
<Id>00000000-0000-0000-0000-000000000000</Id>
<DisplayName>Mike Zanyatski</DisplayName>
<Title>Manager</Title>
<AvatarSmall>url to small avatar</AvatarSmall>
<ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
</CreatedBy>
<CreatedById>00000000-0000-0000-0000-000000000000</CreatedById>
<Updated>2020-12-22T04:11:56.5658524Z</Updated>
<AutoGenerated>True</AutoGenerated>
<Cron>Cron</Cron>
<ReportType>0</ReportType>
<Filter>Filter</Filter>
</response>
</result>