Report

A report.

Get all reports

Get all reports of the authenticated user of the authenticated hub.

SecurityJWT

Request

query Parameters

measure	string or integer Filter the report list for a measure.
measure_package	string or integer Filter the report list for a measure package.
project	string or integer Filter the report list for a project.
program	string or integer Filter the report list for a program.
type	integer The type of the report. 1 - Overview 2 - Detail 3 - Summary Enum: 1 2 3
created_user	string or integer Filter the report list for a created user.
latest	integer [ 1 .. 100 ] Filter the report list for the latest entries. The integer value determines the number of elements displayed. The list is sorted in descending order, i.e., the newest element is at the top.
page	integer Default: 1 The page number of the response.

Responses

200

Successful operation

get/report

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "fff8ed3e7fb56dc9781ff257df7c1f33e9680b67",
"data": [{"id": 38,
"hash": "cbc6ae1721ea2a2db3d4de2964f702b27ff85d00",
"name": "20221004_150855_Hub_1_Measure_2_Report.pptx",
"extension": "pptx",
"mime": "application/vnd.openxmlformats-officedocument.presentationml.presentation",
"size": 541463,
"type": 2,
"expiration_time": "2022-10-07T23:59:59.000000Z",
"remaining_days": 2,
"remaining_time": "2 days 13 hours",
"created_time": "2022-10-04T15:08:55.000000Z",
"modified_time": "2022-10-04T15:08:55.000000Z",
"modified_user_time": "2022-10-04T15:08:55.000000Z",
"signature": "c0ca77b48d774c2ce7641c9d29931cc710cb686126122f39dbd5e992f6865fb4",
"model": "Report",
"reportable": {"id": 2,
"hash": "952d544cd1d50a3937b903ee9f0322808baba201",
"name": "Turnover",
"model": "Measure"
},
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"model": "User"
}
},
{"id": 39,
"hash": "e2e75c71355f46bd47b9d2483edd16f382e3ee8a",
"name": "20221005_104634_Hub_1_Program_1_Report.pptx",
"extension": "pptx",
"mime": "application/vnd.openxmlformats-officedocument.presentationml.presentation",
"size": 532568,
"type": 3,
"expiration_time": "2022-10-08T23:59:59.000000Z",
"remaining_days": 3,
"remaining_time": "3 days 13 hours",
"created_time": "2022-10-05T10:46:34.000000Z",
"modified_time": "2022-10-05T10:46:34.000000Z",
"modified_user_time": "2022-10-05T10:46:34.000000Z",
"signature": "daabe581031e6fe931d4f27e52876dc40263993ee921b629f1830337956f9b7e",
"model": "Report",
"reportable": {"id": 1,
"hash": "1650600bd010a50897b50572382460965fed588a",
"name": "Airborne",
"model": "Program"
},
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"model": "User"
}
}
],
"meta": {"page": 1,
"first": 1,
"last": 2,
"total": 2,
"limit": 1000,
"pages": 1
},
"timestamp": 1664966798626
}

Get a report

Get a report.

Returns either the report object or the binary file content, depending on the API server endpoint.

SecurityJWT

Request

path Parameters

report

required

string or integer

The id/hash of the report.

query Parameters

disposition

string

Default: "attachment"

The content-disposition for the requested file.

Only applicable when downloading a file from the Storage API. For attachment the file should be downloaded, forinline the file can be displayed.

Enum: "attachment" "inline"

Responses

200

Successful operation

404

Not Found

422

Unprocessable Content

get/report/{report}

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "fff8ed3e7fb56dc9781ff257df7c1f33e9680b67",
"data": {"id": 38,
"hash": "cbc6ae1721ea2a2db3d4de2964f702b27ff85d00",
"name": "20221004_150855_Hub_1_Measure_2_Report.pptx",
"extension": "pptx",
"mime": "application/vnd.openxmlformats-officedocument.presentationml.presentation",
"size": 541463,
"type": 2,
"expiration_time": "2022-10-07T23:59:59.000000Z",
"remaining_days": 2,
"remaining_time": "2 days 13 hours",
"created_time": "2022-10-04T15:08:55.000000Z",
"modified_time": "2022-10-04T15:08:55.000000Z",
"modified_user_time": "2022-10-04T15:08:55.000000Z",
"signature": "c0ca77b48d774c2ce7641c9d29931cc710cb686126122f39dbd5e992f6865fb4",
"model": "Report",
"reportable": {"id": 2,
"hash": "952d544cd1d50a3937b903ee9f0322808baba201",
"name": "Turnover",
"model": "Measure"
},
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"model": "User"
}
},
"timestamp": 1664966798626
}

Delete a report

Delete a report.

SecurityJWT

Request

path Parameters

report

required

string or integer

The id/hash of the report.

Responses

200

Successful operation

404

Not Found

delete/report/{report}

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
"data": { },
"timestamp": 1664967545980
}

➔ Next to Report subscription