POST api/2.0/project/report

Данная функция требует аутентификации

Описание
Создает шаблон отчета по проекту с параметрами, указанными в запросе. Большинство параметров являются необязательными и зависят от выбранного типа отчета.

Параметры

Название Описание Тип Пример
name

sent in body
Название отчета строковый текст
period

sent in body
Период создания шаблона отчета: День/Неделя/Месяц

необязательно
строковый текст
periodItem

sent in body
Элемент периода: название дня недели (для еженедельного отчета, начиная с воскресенья), день месяца (для ежемесячного отчета)

необязательно
численный 1234
hour

sent in body
Время отправки отчета (в часах)

необязательно
численный 1234
autoGenerated

sent in body
Показывает, будет ли отчет создаваться автоматически или нет.

необязательно
Bool value true
reportType

sent in body
Тип отчета

необязательно
MilestonesExpired, MilestonesNearest, UsersWithoutActiveTasks, ProjectsWithoutActiveMilestones, ProjectsWithoutActiveTasks, UsersActivity, UsersWorkload, ProjectsList, TimeSpend, TasksByProjects, TasksByUsers, TasksExpired, EmptyReport
tag

sent in body
Тег проекта

необязательно
численный 1234
project

sent in body
Проект отчета

необязательно
численный 1234
status

sent in body
Статус задачи

необязательно
статус задачи NotAccept = 0,Open = 1, Closed = 2,Disable = 3,Unclassified = 4,NotInMilestone = 5
departament

sent in body
Отдел/группа

необязательно
guid 9924256A-739C-462b-AF15-E652A3B1B6EB
userId

sent in body
GUID пользователя

необязательно
guid 9924256A-739C-462b-AF15-E652A3B1B6EB
reportTimeInterval

sent in body
Интервал времени отчета

необязательно
Absolute, Relative, Today, Yesterday, Tomorrow, CurrWeek, PrevWeek, NextWeek, CurrMonth, PrevMonth, NextMonth, CurrYear, PrevYear, NextYear
fromDate

sent in body
Дата начала отчетного периода

необязательно
дата и время Roundtrip format: 2008-04-10T06-30-00.000Z
toDate

sent in body
Дата окончания отчетного периода

необязательно
дата и время Roundtrip format: 2008-04-10T06-30-00.000Z
viewType

sent in body
Тип просмотра отчета: по группам или по проектам

необязательно
численный 1234
noResponsible

sent in body
Указывает, будут ли задачи без ответственных отображаться или скрываться

необязательно
логический true
isShowAverageTime

sent in body
Указывает, будет ли отображаться среднее время или нет

необязательно
логический true
typeOfShowAverageTime

sent in body
Тип усредненного времени (все, закрытие проектов, выполнение задач)

необязательно
All, ClosingProjects, CompletingTasks
projectAverageCompletingTasks

sent in body
Указывает, будет ли показано среднее время завершения проектов или нет

необязательно
логический true
Пример
POST api/2.0/project/report
Host: yourportal.Р7.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": "2022-11-03T15:35:57.9042922Z",
    "createdBy": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "updated": "2022-11-03T15:35:57.9042922Z"
  }
}

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>2022-11-03T15:35:57.9042922Z</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>2022-11-03T15:35:57.9042922Z</updated>
  </response>
</result>