JOC API

/order/log

POST

Log (plain text or html)

Parameters in the POST body schema

Name	Type	Description	Example	Default
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`jobChain`	required, string	Path of a job chain	/sos/reporting/Inventory
`orderId`	required; string	The id of an order	inventory
`historyId`	required; integer	The history id of an order	4711
`mime`	optional, string, enum[PLAIN,HTML]	The log can have a HTML representation where the HTML content is a colored version consider the log levelfor the browser where CSS is required. pre.log {font-family:"Lucida Console",monospace;font-size:12px;line-height:1.1em;margin-left:2px;padding-left:0} .log_error {color:red;} .log_warn {color:tomato;} .log_info {color:black;} .log_stderr {color:red;} .log_debug {color:darkgreen;} .log_debug2 {color:#408040;} .log_debug3 {color:#808080;} .log_debug4 {color:#8080FF;} .log_debug5 {color:#8080FF;} .log_debug6 {color:#8080FF;} .log_debug7 {color:#8080FF;} .log_debug8 {color:#8080FF;} .log_debug9 {color:#a0a0a0;}		PLAIN
`filename`	optional, string	name of a temp. file from ./order/log/info This file will be responsed if exists	sos-download-5961566003164029224.tmp

Request

Name

Description

Example

Type

Constraints

Default

Headers

X-Access-Token*

Request requires authentication!

550e8400-e29b-11d4-a716-446655440000

string

access_token*

Request requires authentication! This header is deprecated. Please use X-Access-Token

550e8400-e29b-11d4-a716-446655440000

string

Body

application/json

model | example

{
    "title": "order filter with history id",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.order.OrderHistoryFilter",
    "type": "object",
    "required": [
        "jobschedulerId"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "jobChain": {
            "description": "absolute path based on live folder of a JobScheduler object.",
            "type": "string",
            "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
            "maxLength": 255
        },
        "orderId": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "historyId": {
            "type": "string",
            "pattern": "^\\d+$"
        },
        "filename": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 255
        },
        "mime": {
            "description": "The log can have a HTML representation where the HTML gets a highlighting via CSS classes.",
            "javaType": "com.sos.joc.model.common.LogMime",
            "type": "string",
            "enum": [
                "PLAIN",
                "HTML"
            ],
            "default": "PLAIN"
        }
    }
}

{ "jobschedulerId": "scheduler", "historyId": 4711, "jobChain": "/test/foo/bar1", "orderId": "order1" }

{
    "jobschedulerId": "scheduler",
    "historyId": 4711,
    "jobChain": "/test/foo/bar1",
    "orderId": "order1"
}

Responses

Code	Description	Headers	Body
200	Content of log. It depends on the if size if it is offered as download with the Content-Disposition header	Content-Disposition Content-Type
401	Unauthorized!		application/json model \| example { "title": "security", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "hasRole": { "type": "boolean", "default": false }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Oops!", "hasRole": false, "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Oops!", "hasRole": false, "isAuthenticated": false, "isPermitted": false }
403	Forbidden! The user doesn't have sufficient permissions for 'log'		application/json model \| example { "title": "security", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "hasRole": { "type": "boolean", "default": false }, "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 ...", "hasRole": false, "isAuthenticated": true, "isPermitted": false } { "user": "root", "message": "You don't have sufficient permissions for ...", "hasRole": false, "isAuthenticated": true, "isPermitted": false }
420	'log' 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": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "surveyDate": { "description": "is also required for permanent or volatile requests", "type": "string", "format": "date-time" }, "error": { "javaType": "com.sos.joc.model.common.Err", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255 }, "message": { "type": "string" } } } } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "log failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "log failed!" } }
440	Login Timeout! The client's session has expired and must log in again.		application/json model \| example { "title": "security", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "hasRole": { "type": "boolean", "default": false }, "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", "hasRole": false, "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Session has expired. Please log in again", "hasRole": false, "isAuthenticated": false, "isPermitted": false }