Report

A report.

Report a measure

Report a measure for the given report type.

SecurityJWT
Request
path Parameters
measure
required
string

The id/hash of the current measure.

type
required
string

The type of the report.

Value: "detail"
Request Body schema: application/json

A JSON object containing measure report information.

budgeting_item_id
integer >= 1

The budgeting item for the report.

period_type
integer

The budgeting period type for the report.

  • 1 - Overall
  • 2 - Actual year
  • 3 - Previous year
  • 4 - Pre previous year
  • 5 - Upcoming year
  • 6 - Year to date
  • 7 - Date to year
  • 8 - Start to date
  • 9 - Date to start
  • 10 - Actual period
  • 11 - Previous period
  • 12 - Pre previous period
  • 13 - Upcoming period
Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13
scaling
integer

The budgeting scaling type for the report.

  • 1 - Weekly
  • 2 - Monthly
  • 3 - Quarterly
  • 4 - Yearly
Enum: 1 2 3 4
Responses
200

Successful operation

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable Content

post/measure/{measure}/{type}/report
Request samples
application/json
{
  • "budgeting_item_id": 2,
  • "period_type": 6,
  • "scaling": 2
}
Response samples
application/json
{
  • "value": {
    }
}

Report a measure package

Report a measure package for the given report type.

SecurityJWT
Request
path Parameters
measurepackage
required
string

The id/hash of the current measure package.

type
required
string

The type of the report.

Enum: "detail" "summary"
Request Body schema: application/json

A JSON object containing measure package report information.

budgeting_item_id
integer >= 1

The budgeting item for the report.

period_type
integer

The budgeting period type for the report.

  • 1 - Overall
  • 2 - Actual year
  • 3 - Previous year
  • 4 - Pre previous year
  • 5 - Upcoming year
  • 6 - Year to date
  • 7 - Date to year
  • 8 - Start to date
  • 9 - Date to start
  • 10 - Actual period
  • 11 - Previous period
  • 12 - Pre previous period
  • 13 - Upcoming period
Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13
scaling
integer

The budgeting scaling type for the report.

  • 1 - Weekly
  • 2 - Monthly
  • 3 - Quarterly
  • 4 - Yearly
Enum: 1 2 3 4
responsible_users
Array of arrays

Filter the report for responsible users.

tags
Array of arrays

Filter the report for tags.

workflow_phases
Array of arrays

Filter the report for workflow phases.

Responses
200

Successful operation

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable Content

post/measurepackage/{measurepackage}/{type}/report
Request samples
application/json
{
  • "budgeting_item_id": 2,
  • "period_type": 6,
  • "responsible_users": [
    ],
  • "scaling": 2,
  • "tags": [
    ],
  • "workflow_phases": [
    ]
}
Response samples
application/json
{
  • "value": {
    }
}

Report a project

Report a project for the given report type.

SecurityJWT
Request
path Parameters
project
required
string

The id/hash of the current project.

type
required
string

The type of the report.

Enum: "detail" "summary"
Request Body schema: application/json

A JSON object containing measure package report information.

budgeting_item_id
integer >= 1

The budgeting item for the report.

period_type
integer

The budgeting period type for the report.

  • 1 - Overall
  • 2 - Actual year
  • 3 - Previous year
  • 4 - Pre previous year
  • 5 - Upcoming year
  • 6 - Year to date
  • 7 - Date to year
  • 8 - Start to date
  • 9 - Date to start
  • 10 - Actual period
  • 11 - Previous period
  • 12 - Pre previous period
  • 13 - Upcoming period
Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13
scaling
integer

The budgeting scaling type for the report.

  • 1 - Weekly
  • 2 - Monthly
  • 3 - Quarterly
  • 4 - Yearly
Enum: 1 2 3 4
responsible_users
Array of arrays

Filter the report for responsible users.

tags
Array of arrays

Filter the report for tags.

workflow_phases
Array of arrays

Filter the report for workflow phases.

Responses
200

Successful operation

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable Content

post/project/{project}/{type}/report
Request samples
application/json
{
  • "budgeting_item_id": 2,
  • "period_type": 6,
  • "responsible_users": [
    ],
  • "scaling": 2,
  • "tags": [
    ],
  • "workflow_phases": [
    ]
}
Response samples
application/json
{
  • "value": {
    }
}

Report a program

Report a program for the given report type.

SecurityJWT
Request
path Parameters
program
required
string

The id/hash of the current program.

type
required
string

The type of the report.

Enum: "detail" "summary"
Request Body schema: application/json

A JSON object containing measure package report information.

budgeting_item_id
integer >= 1

The budgeting item for the report.

period_type
integer

The budgeting period type for the report.

  • 1 - Overall
  • 2 - Actual year
  • 3 - Previous year
  • 4 - Pre previous year
  • 5 - Upcoming year
  • 6 - Year to date
  • 7 - Date to year
  • 8 - Start to date
  • 9 - Date to start
  • 10 - Actual period
  • 11 - Previous period
  • 12 - Pre previous period
  • 13 - Upcoming period
Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13
scaling
integer

The budgeting scaling type for the report.

  • 1 - Weekly
  • 2 - Monthly
  • 3 - Quarterly
  • 4 - Yearly
Enum: 1 2 3 4
responsible_users
Array of arrays

Filter the report for responsible users.

tags
Array of arrays

Filter the report for tags.

workflow_phases
Array of arrays

Filter the report for workflow phases.

Responses
200

Successful operation

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable Content

post/program/{program}/{type}/report
Request samples
application/json
{
  • "budgeting_item_id": 2,
  • "period_type": 6,
  • "responsible_users": [
    ],
  • "scaling": 2,
  • "tags": [
    ],
  • "workflow_phases": [
    ]
}
Response samples
application/json
{
  • "value": {
    }
}