JOC API

/jobscheduler/debuglog/info

POST

Log info (temp. filename, size)

Parameters in the POST body schema

Name	Type	Description	Example
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`host`	optional, string	host of the JobScheduler Master This parameter is required for a specific JobScheduler in a cluster	localhost
`port`	optional, string	port of the JobScheduler Master This parameter is required for a specific JobScheduler in a cluster	4444

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": "hostPortParam",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.jobscheduler.HostPortParameter",
    "type": "object",
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "host": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "port": {
            "type": "integer",
            "minimum": 0,
            "maximum": 65535
        },
        "filename": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 255
        },
        "auditLog": {
            "javaType": "com.sos.joc.model.audit.AuditParams",
            "type": "object",
            "properties": {
                "comment": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                },
                "timeSpent": {
                    "type": "integer",
                    "minimum": 0
                },
                "ticketLink": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                }
            }
        }
    }
}

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

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

Responses

Code	Description	Body
200	Creates a temporary file of the log which is deleted after 3 minutes. `filename`: filename of the temporary file which can be used as parameter for ./jobscheduler/log `size` : size of the log `download`: (true\|false) depends on the size and the max size setting if the log is offered as download or displayed in the browser	application/json model \| example { "title": "log info with delivery date", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.LogInfo200", "type": "object", "required": [ "deliveryDate", "surveyDate", "log" ], "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": "Date of the inventory data. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "log": { "javaType": "com.sos.joc.model.common.LogInfo", "type": "object", "properties": { "filename": { "description": "name of temporary file. Can be used as parameter for ./jobscheduler/log, ./order/log or ./task/log", "type": "string" }, "size": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "download": { "description": "if true then ./jobscheduler/log, ./order/log or ./task/log sends log as download (with Content-Disposition 'attachment').", "type": "boolean", "default": true } } } } } { "deliveryDate": "2018-05-05T21:14:56Z", "surveyDate": "2018-05-05T21:12:00Z", "log": { "size": 4189, "filename": "sos-download-5961566003164029224.tmp", "download": false } } { "deliveryDate": "2018-05-05T21:14:56Z", "surveyDate": "2018-05-05T21:12:00Z", "log": { "size": 4189, "filename": "sos-download-5961566003164029224.tmp", "download": false } }
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 'info'	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	'info' 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": "info failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "info 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 }