PUT api/2.0/project/report/{reportid} This function requires authentication

Description

Updates the selected project report template with the parameters specified in the request.

Parameters

Name	Description	Type	Example
reportid sent in url	Report template ID	number	1234
name sent in body	New report name	string	some text
period sent in body	New report generation period: Day/Week/Month optional	string	some text
periodItem sent in body	New 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	New 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	New report type optional	MilestonesExpired, MilestonesNearest, UsersWithoutActiveTasks, ProjectsWithoutActiveMilestones, ProjectsWithoutActiveTasks, UsersActivity, UsersWorkload, ProjectsList, TimeSpend, TasksByProjects, TasksByUsers, TasksExpired, EmptyReport	MilestonesExpired
tag sent in body	New report tag optional	number	1234
project sent in body	New report project optional	number	1234
status sent in body	New task status optional	NotAccept = 0,Open = 1, Closed = 2,Disable = 3,Unclassified = 4,NotInMilestone = 5	NotAccept
departament sent in body	New department/group GUID optional	guid	9924256A-739C-462b-AF15-E652A3B1B6EB
userId sent in body	New user GUID optional	guid	9924256A-739C-462b-AF15-E652A3B1B6EB
reportTimeInterval sent in body	New report time interval optional	Absolute, Relative, Today, Yesterday, Tomorrow, CurrWeek, PrevWeek, NextWeek, CurrMonth, PrevMonth, NextMonth, CurrYear, PrevYear, NextYear	Absolute
fromDate sent in body	New report period start date optional	Date and Time	Roundtrip format: 2008-04-10T06-30-00.000Z
toDate sent in body	New report period end date optional	Date and Time	Roundtrip format: 2008-04-10T06-30-00.000Z
viewType sent in body	New 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

Example

PUT api/2.0/project/report/1234
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
}

Returns

Updated project report template

Example Response

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>

PUT api/2.0/project/report/{reportid} This function requires authentication

Get information

Get help