Create Report

POST

/core/reporting

This API allows users to create a report by specifying the report name, type, and necessary parameters.

Request Table

Field Name	Type	Required	Description
name	string	TRUE	Name of the report being created.
reportTypeId	integer	TRUE	Unique identifier for the report type.
parameters	array	TRUE	Array of parameters required for generating the report.
parameterId	integer	TRUE	Unique identifier of the parameter.
value	string	TRUE	Value assigned to the corresponding parameter.

Response Table

Field Name	Type	Description
id	integer	Unique identifier of the created report.
name	string	Name of the created report.
reportTypeId	integer	Unique identifier of the report type.
parameters	array	Array of parameters included in the report.
parameterId	integer	Unique identifier of a parameter in the report.
value	string	Value assigned to the parameter.

Request

Body Params application/json

Example

{
    "name": "Test Report",
    "reportTypeId": 1,
    "parameters": [
        {
            "parameterId": 1,
            "value": "2024-01-01"
        },
        {
            "parameterId": 2,
            "value": "2024-07-08"
        },
        {
            "parameterId": 3,
            "value": "ALL"
        },
        {
            "parameterId": 4,
            "value": "ALL"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/core/reporting' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Test Report",
    "reportTypeId": 1,
    "parameters": [
        {
            "parameterId": 1,
            "value": "2024-01-01"
        },
        {
            "parameterId": 2,
            "value": "2024-07-08"
        },
        {
            "parameterId": 3,
            "value": "ALL"
        },
        {
            "parameterId": 4,
            "value": "ALL"
        }
    ]
}'

Responses

🟢200Success

application/json

Body

Example

{
    "id": 1,
    "name": "Test Report",
    "reportTypeId": 1,
    "parameters": [
        {
            "parameterId": 1,
            "value": "2024-01-01"
        },
        {
            "parameterId": 2,
            "value": "2024-07-08"
        },
        {
            "parameterId": 3,
            "value": "ALL"
        },
        {
            "parameterId": 4,
            "value": "ALL"
        },
        {
            "parameterId": 5,
            "value": "26"
        }
    ]
}

Modified at 2025-03-19 15:04:40

Get Report Parameters

Report Details