JOC API

/reporting/reports/generated

POST

Returns generated reports

Parameters in the POST body schema

Name	Type	Description	Example
`reportPaths`	optional, array[string]	Paths or names of report configurations
`templateNames`	optional, array[string]	Limits the result to template names such as WORKFLOWS_FREQUENTLY_FAILED JOBS_FREQUENTLY_FAILED AGENTS_PARALLEL_JOB_EXECUTIONS JOBS_EXECUTIONS_FREQUENCY ORDERS_EXECUTIONS_FREQUENCY WORKFLOWS_LONGEST_EXECUTION_TIMES JOBS_LONGEST_EXECUTION_TIMES PERIODS_MOST_ORDER_EXECUTIONS PERIODS_MOST_JOB_EXECUTIONS JOBS_SUCCESSFUL_EXECUTIONS WORKFLOWS_SUCCESSFUL_EXECUTIONS	["WORKFLOWS_LONGEST_EXECUTION_TIMES"]
`runIds`	optional, array[integer]	Limits the result to reports generated by specific run IDs
`dateFrom`	optional, string	Date in the format YYYY-MM-DD. Limits the result to reports that are younger than this date
`dateTo`	optional, string	Date in the format YYYY-MM-DD. Limits the result to reports that are older than this date

Request

Name

Description

Example

Type

Constraints

Default

Headers

X-Access-Token*

Request requires authentication!

550e8400-e29b-11d4-a716-446655440000

string

Body

application/json

model | example

{
    "title": "generated reports",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.reporting.ReportHistoryFilter",
    "type": "object",
    "extends": {
        "javaType": "com.sos.joc.model.reporting.ReportPaths",
        "type": "object",
        "properties": {
            "reportPaths": {
                "type": "array",
                "uniqueItems": true,
                "items": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255,
                    "minLength": 1
                }
            }
        },
        "additionalProperties": false
    },
    "properties": {
        "runIds": {
            "type": "array",
            "uniqueItems": true,
            "items": {
                "type": "number",
                "format": "utc-millisec",
                "minimum": 0
            }
        },
        "compact": {
            "description": "controls if the object's data is compact or detailed",
            "type": "boolean",
            "default": false
        },
        "dateFrom": {
            "description": "ISO date YYYY-MM-DD",
            "type": "string",
            "format": "date"
        },
        "dateTo": {
            "description": "ISO date YYYY-MM-DD",
            "type": "string",
            "format": "date"
        },
        "templateNames": {
            "type": "array",
            "uniqueItems": true,
            "items": {
                "javaType": "com.sos.inventory.model.report.TemplateId",
                "type": "string",
                "enum": [
                    "WORKFLOWS_FREQUENTLY_FAILED",
                    "JOBS_FREQUENTLY_FAILED",
                    "AGENTS_PARALLEL_JOB_EXECUTIONS",
                    "JOBS_HIGH_LOW_EXECUTION_PERIODS",
                    "JOBS_EXECUTIONS_FREQUENCY",
                    "ORDERS_EXECUTIONS_FREQUENCY",
                    "WORKFLOWS_LONGEST_EXECUTION_TIMES",
                    "JOBS_LONGEST_EXECUTION_TIMES",
                    "PERIODS_MOST_ORDER_EXECUTIONS",
                    "PERIODS_MOST_JOB_EXECUTIONS"
                ]
            }
        }
    },
    "additionalProperties": false
}

Responses

Code	Description	Body
200		application/json model \| example { "title": "reports from REPORT_HISTORY", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.reporting.ReportItems", "type": "object", "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "reports": { "type": "array", "items": { "javaType": "com.sos.joc.model.reporting.ReportItem", "type": "object", "required": [ "id", "runId", "templateName", "frequency", "hits", "dateFrom", "dateTo", "data" ], "properties": { "id": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "runId": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "path": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "controllerId": { "type": "string", "pattern": "^[^/\\<>?:\"\|]$", "maxLength": 100 }, "templateName": { "javaType": "com.sos.inventory.model.report.TemplateId", "type": "string", "enum": [ "WORKFLOWS_FREQUENTLY_FAILED", "JOBS_FREQUENTLY_FAILED", "AGENTS_PARALLEL_JOB_EXECUTIONS", "JOBS_HIGH_LOW_EXECUTION_PERIODS", "JOBS_EXECUTIONS_FREQUENCY", "ORDERS_EXECUTIONS_FREQUENCY", "WORKFLOWS_LONGEST_EXECUTION_TIMES", "JOBS_LONGEST_EXECUTION_TIMES", "PERIODS_MOST_ORDER_EXECUTIONS", "PERIODS_MOST_JOB_EXECUTIONS", "JOBS_SUCCESSFUL_EXECUTIONS", "WORKFLOWS_SUCCESSFUL_EXECUTIONS" ] }, "frequency": { "javaType": "com.sos.inventory.model.report.Frequency", "type": "string", "enum": [ "WEEKLY", "TWO_WEEKS", "MONTHLY", "THREE_MONTHS", "SIX_MONTHS", "YEARLY", "THREE_YEARS" ] }, "sort": { "javaType": "com.sos.inventory.model.report.ReportOrder", "type": "string", "enum": [ "HIGHEST", "LOWEST" ], "default": "HIGHEST" }, "periodLength": { "type": "integer", "minimum": 0 }, "periodStep": { "type": "integer", "minimum": 0 }, "hits": { "type": "integer", "minimum": 1, "maximum": 100 }, "dateFrom": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "dateTo": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "created": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "modified": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "data": { "type": "array", "items": { "javaType": "com.sos.joc.model.reporting.ReportData", "type": "object", "additionalProperties": true } } }, "additionalProperties": false } } }, "additionalProperties": false }
401	Unauthorized!	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false }
403	Forbidden! The user doesn't have sufficient permissions for 'generated'	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "You don't have sufficient permissions for ...", "role": "all", "isAuthenticated": true, "isPermitted": false } { "user": "root", "message": "You don't have sufficient permissions for ...", "role": "all", "isAuthenticated": true, "isPermitted": false }
420	'generated' failed!	application/json model \| example { "title": "error object with delivery date", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Err420", "type": "object", "required": [ "deliveryDate", "error" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "surveyDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "error": { "javaType": "com.sos.joc.model.common.Err", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "generated failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "generated failed!" } }
440	Login Timeout! The client's session has expired and must log in again.	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Session has expired. Please log in again", "role": "all", "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Session has expired. Please log in again", "role": "all", "isAuthenticated": false, "isPermitted": false }