JOC API

/reporting/reports

POST

Returns released report configurations

Parameters in the POST body schema

Name	Type	Description	Example	Default
`reportPaths`	optional, array[string]	Paths or names of report configurations
`folders`	optional, array[object]	Limits the result to a collection of folders	[{ "folder": "/sos", "recursive": true }]

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": "reports request",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.reporting.ReportsFilter",
    "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": {
        "folders": {
            "type": "array",
            "items": {
                "type": "object",
                "javaType": "com.sos.joc.model.common.Folder",
                "required": [
                    "folder"
                ],
                "properties": {
                    "folder": {
                        "description": "absolute path of an object.",
                        "type": "string",
                        "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
                        "maxLength": 255,
                        "minLength": 1
                    },
                    "recursive": {
                        "type": "boolean",
                        "default": true
                    }
                },
                "additionalProperties": false
            }
        }
    },
    "additionalProperties": false
}

Responses

Code	Description	Body
200		application/json model \| example { "title": "reports", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.reporting.Reports", "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.Report", "type": "object", "extends": { "javaType": "com.sos.inventory.model.report.Report", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject", "com.sos.joc.model.common.IReleaseObject", "com.sos.inventory.model.common.IInventoryObject" ], "required": [ "templateName", "frequencies", "hits", "monthFrom" ], "properties": { "version": { "description": "inventory repository version", "type": "string", "pattern": "[0-9]+\\.[0-9]+\\.[0-9]+", "default": "1.5.0", "maxLength": 10 }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "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" ] }, "frequencies": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "javaType": "com.sos.inventory.model.report.Frequency", "type": "string", "enum": [ "WEEKLY", "TWO_WEEKS", "MONTHLY", "THREE_MONTHS", "SIX_MONTHS", "YEARLY", "THREE_YEARS" ] } }, "hits": { "type": "integer", "minimum": 1, "maximum": 100 }, "controllerId": { "type": "string", "pattern": "^[^/\\<>?!&:;()\"\|^]$", "maxLength": 100 }, "monthFrom": { "type": "string", "pattern": "^([1-9][0-9]\\s[MmYy]\|\\d{4}-(0[1-9]\|1[0-2]))$" }, "monthTo": { "type": "string", "pattern": "^([1-9][0-9]\\s[MmYy]\|\\d{4}-(0[1-9]\|1[0-2]))$" } }, "additionalProperties": false }, "properties": { "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 } }, "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 'reports'	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	'reports' 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": "reports failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "reports 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 }