Create a report template

POST /api/2.0/project/report

Request

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.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

namestring

Report name

periodstring

Report generation period: Day/Week/Month

periodIteminteger

Period item: day of the week (for a weekly report, starting with Sunday), day of the month (for a monthly report)

hourinteger

Report sending time (in hours)

autoGeneratedboolean

Specifies if a report will be automatically generated or not

reportTypeinteger

Report type

taginteger

Report tag

projectinteger

Report project

statusarray of integer

Task status

departamentstring

Department/Group GUID

userIdstring

User GUID

reportTimeIntervalinteger

Report time interval

fromDatestring

Report period start date

toDatestring

Report period end date

viewTypeinteger

Report view type: by group or by project

noResponsibleboolean

Specifies if the tasks without responsibles will be shown or hidden

isShowAverageTimeboolean

Specifies if the average time will be shown or not

typeOfShowAverageTimeinteger

Average time type (All, ClosingProjects, CompletingTasks)

projectAverageCompletingTasksboolean

Specifies if the average time of completing tasks will be shown or not

Examples

POST /api/2.0/project/report HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request POST \
  --url https://example.com/api/2.0/project/report \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Project report template

AutoGeneratedboolean

Cronstring

ReportTypeenum of integerformat: int32

[0 - MilestonesExpired, 1 - MilestonesNearest, 2 - UsersWithoutActiveTasks, 3 - ProjectsWithoutActiveMilestones, 4 - ProjectsWithoutActiveTasks, 5 - UsersActivity, 6 - UsersWorkload, 7 - ProjectsList, 8 - TimeSpend, 9 - TasksByProjects, 10 - TasksByUsers, 11 - TasksExpired, 12 - EmptyReport]

Can be one of: MilestonesExpired, MilestonesNearest, UsersWithoutActiveTasks, ProjectsWithoutActiveMilestones, ProjectsWithoutActiveTasks, UsersActivity, UsersWorkload, ProjectsList, TimeSpend, TasksByProjects, TasksByUsers, TasksExpired, EmptyReport.

Filterstring

Createdstring

CreatedByobject

Idstringformat: uuid

DisplayNamestring

Titlestring

AvatarSmallstring

ProfileUrlstring

CreatedByIdstringformat: uuid

Updatedstring

UpdatedByobject

Idstringformat: uuid

DisplayNamestring

Titlestring

AvatarSmallstring

ProfileUrlstring

UpdatedByIdstringformat: uuid

Idintegerformat: int32

Titlestring

Descriptionstring

Statusintegerformat: int32

Responsibleobject

Idstringformat: uuid

DisplayNamestring

Titlestring

AvatarSmallstring

ProfileUrlstring

ResponsibleIdstringformat: uuid

401

Unauthorized