Reporting | Tajima Software Solutions Inc.

With the /Reporting endpoint user can manage Reporting from the database.

GET /api/Reporting/GetReportingTypes Get a list of all reporting types

Request Example

    /api/Reporting/GetReportingTypes

RESPONSE EXAMPLE

    [
        "Advanced Thread Break",
        "Design",
        "Designs Ordered",
        "Efficiency",
        "Ink Usage Report",
        "Jobs Report",
        "Machine",
        "Machine Production Summary",
        "Operator",
        "Product Category",
        "Production Summary",
        "Thread Break",
        "Thread Usage"
    ]

GET /api/Reporting/GetTemplatesForType Get a list of all reporting types

Request Example

    /api/Reporting/GetTemplatesForType?reportingType=reportingTypeName

RESPONSE EXAMPLE

    If found, a Reporting is returned with status code 200. Otherwise an error with code and message is returned with status code 404  

    [
       "designdetail-standard"
       ...
    ]

POST /api/Reporting/GenerateReport Create a Report

Model Request Example

            All field is required 
    {
        "ReportingType"  : "",  // e.g. Design
        "StartPeriod" : "yyyy-MM-dd HH:mm:ss",
        "EndPeriod" : "yyyy-MM-dd HH:mm:ss",
        "OffsetStart" : Number, // e.g. 240
        "OffsetEnd" : Number, // e.g. 240
        "TimeZoneOffset" : Number, // e.g. 240
        "TemplateFile" : "string"  // e.g. designdetail standard,
        "machineName" : "string" // e.g. all machines"
    }

    
        Time Zones and Offsets Example from UTC
        
        
        Time Zone
        Standard Time Offset (minutes)
        Daylight Saving Time Offset (minutes)
            
        
        
        
        Pacific Time (PT)
        480
        420
            
        
        Mountain Time (MT)
        420
        360
            
        
        Central Time (CT)
        360
        300
            
        
        Eastern Time (ET)
        300
        240
            
        
        Atlantic Time (AT)
        240
        180
            
        
        Newfoundland Time (NT)
        210
        150
            
        
        Japan Standard Time (JST)
        -540
        N/A
            
        
        China Standard Time (CST)
        -480
        N/A
            
        
        Western European Time (WET)
        0
        -60
            
        
        Central European Time (CET)
        -60
        -120
            
        
        Eastern European Time (EET)
        -120
        -180

Time Zones and Offsets Example from UTC
Time Zone	Standard Time Offset (minutes)	Daylight Saving Time Offset (minutes)
Pacific Time (PT)	480	420
Mountain Time (MT)	420	360
Central Time (CT)	360	300
Eastern Time (ET)	300	240
Atlantic Time (AT)	240	180
Newfoundland Time (NT)	210	150
Japan Standard Time (JST)	-540	N/A
China Standard Time (CST)	-480	N/A
Western European Time (WET)	0	-60
Central European Time (CET)	-60	-120
Eastern European Time (EET)	-120	-180

Response Example

If the operation is successful a Reporting download url will be returned with status code 200
Otherwise an error with code and message will be returned with status code 409

POST /api/Reporting/CreateEfficiencyReport Create a Efficiency Report

Model Request Example

            All field is required 
    {
        "StartPeriod" : "yyyy-MM-dd",
        "EndPeriod" : "yyyy-MM-dd",
        "OffsetStart" : Number, // e.g. 240
        "OffsetEnd" : Number, // e.g. 240
        "TimeZoneOffset" : Number, // e.g. 240
        "isZeroValuesIncluded" : true
    }

Response Example

If the operation is successful, a byte of data will be returned with a status code of 200
Otherwise an error with code and message will be returned with status code 409

POST /api/Reporting/GenerateInkUsageReport Create a Ink Usage Report

Model Request Example

            All field is required 
    {
        "columns"  : "string"  // e.g Job, MachineMode,PlatenSize,
        "printers" : "string"  // printer names
        "utcStartDate" : "yyyy-MM-dd",
        "utcEndDate" : "yyyy-MM-dd"
    }

Response Example

If the operation is successful, a byte of data will be returned with a status code of 200
Otherwise an error with code and message will be returned with status code 409

GET /api/Reporting/GetListOfExcelColumns Get a list of excel columns for Ink Usage Report

Request Example

    /api/Reporting/GetListOfExcelColumns

RESPONSE EXAMPLE

    [
        {
            "Name": "Job",
            "Description": "Job name in PulseIQ",
            "DataType": "String",
            "IncludeInTheReport": false,
            "ColumnOrder": 1,
            "ParameterName": "Job"
        },
        ...
    ]