JOC API

/agent/log/download

POST

Provides Agent log as download

Parameters in the POST body schema

Name	Type	Description	Example	Default
`controllerId`	required, string	Controller ID	myController
`agentId`	required, string	Agent ID
`subagentId`	optional, string	Subagent ID of a Subagent This parameter is required for an Agent cluster.
`level`	required, string	log level Possible values: DEBUG INFO WARN	DEBUG	INFO
`dateFrom`	required, string	The value has multiple formats Filters items starting from a date. an ISO 8601 date format with the time offset and milliseconds being optional, e.g. YYYY-MM-DDThh:mm:ss[.s][Z (Z means +00)] YYYY-MM-DDThh:mm:ss[.s][+01:00] YYYY-MM-DDThh:mm:ss[.s][+0100] YYYY-MM-DDThh:mm:ss[.s][+01] a format for a period relative to the current time, e.g. 6h, 12h, 1d, 1w that specifies the quantity followed by a qualifier: s (seconds) m (minutes) h (hours) d (days) w (weeks) M (months) y (years) a time offset is optional (e.g. 2d+02:00) it can also be specified with the parameter `timeZone` if `timeZone` is undefined then UTC is used the value 0 indicates the current time	1d
`dateTo`	optional, string	The value has multiple formats similiar to the `dateFrom` parameter Filters items ending before a date.	0
`timeZone`	optional, string	If this parameter is set then it beats the time offset in `dateFrom` and `dateTo` See the list for available time zones.	Europe/Berlin
`numOfLines`	optional, integer	Limits the number of log lines	2500

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": "agent log filter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.log.AgentLogRequest",
    "type": "object",
    "extends": {
        "javaType": "com.sos.joc.model.log.LogBaseRequest",
        "type": "object",
        "required": [
            "dateFrom"
        ],
        "properties": {
            "level": {
                "javaType": "com.sos.joc.model.log.RequestLevel",
                "description": "ERROR: WARN + ERROR | WARN: WARN + ERROR | INFO: INFO + WARN + ERROR | DEBUG: all (incl. TRACE)",
                "type": "string",
                "enum": [
                    "ERROR",
                    "WARN",
                    "INFO",
                    "DEBUG"
                ],
                "default": "INFO"
            },
            "dateFrom": {
                "description": "0 or [number][smhdwMy] (where smhdwMy unit for second, minute, etc) or ISO 8601 timestamp",
                "type": "string",
                "pattern": "^([+-]?0|([+-]?[0-9]+[smhdwMy])+|\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}([,.]\\d{1,3})?)(Z|[+-]\\d{2}(:?\\d{2})?)?$"
            },
            "dateTo": {
                "description": "0 or [number][smhdwMy] (where smhdwMy unit for second, minute, etc) or ISO 8601 timestamp",
                "type": "string",
                "pattern": "^([+-]?0|([+-]?[0-9]+[smhdwMy])+|\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}([,.]\\d{1,3})?)(Z|[+-]\\d{2}(:?\\d{2})?)?$"
            },
            "timeZone": {
                "description": "see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones",
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255
            },
            "numOfLines": {
                "type": "number",
                "format": "utc-millisec",
                "minimum": 0
            },
            "limit": {
                "type": "number",
                "format": "utc-millisec",
                "minimum": 0
            }
        },
        "additionalProperties": false
    },
    "required": [
        "controllerId",
        "agentId",
        "dateFrom"
    ],
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100,
            "minLength": 1
        },
        "agentId": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255,
            "minLength": 1
        },
        "subagentId": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        }
    },
    "additionalProperties": false
}

Responses

Code	Description	Headers	Body
200	Content for download	Content-Disposition Content-Type	application/octet-stream
401	Unauthorized!		application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "accessToken": { "type": "string" }, "account": { "type": "string" }, "callerHostName": { "type": "string" }, "callerIpAddress": { "type": "string" }, "enableTouch": { "type": "boolean", "default": true }, "forcePasswordChange": { "type": "boolean", "default": false }, "hasRole": { "type": "boolean", "default": false }, "identityService": { "type": "string" }, "isApprovalRequestor": { "type": "boolean", "default": false }, "isApprover": { "type": "boolean", "default": false }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "message": { "type": "string" }, "role": { "type": "string" }, "sessionTimeout": { "type": "integer", "default": 1800 } } } { "account": "root", "callerHostName": "127.0.0.1", "callerIpAddress": "127.0.0.1", "enableTouch": true, "forcePasswordChange": false, "hasRole": false, "isApprovalRequestor": false, "isApprover": false, "isAuthenticated": false, "isPermitted": false, "message": "Access denied" } { "account": "root", "callerHostName": "127.0.0.1", "callerIpAddress": "127.0.0.1", "enableTouch": true, "forcePasswordChange": false, "hasRole": false, "isApprovalRequestor": false, "isApprover": false, "isAuthenticated": false, "isPermitted": false, "message": "Access denied" }
403	Forbidden! The user doesn't have sufficient permissions for 'download'		application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "accessToken": { "type": "string" }, "account": { "type": "string" }, "callerHostName": { "type": "string" }, "callerIpAddress": { "type": "string" }, "enableTouch": { "type": "boolean", "default": true }, "forcePasswordChange": { "type": "boolean", "default": false }, "hasRole": { "type": "boolean", "default": false }, "identityService": { "type": "string" }, "isApprovalRequestor": { "type": "boolean", "default": false }, "isApprover": { "type": "boolean", "default": false }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "message": { "type": "string" }, "role": { "type": "string" }, "sessionTimeout": { "type": "integer", "default": 1800 } } } { "accessToken": "550e8400-e29b-11d4-a716-446655440000", "account": "root", "apiCall": "./lock", "enableTouch": true, "forcePasswordChange": false, "hasRole": true, "isApprovalRequestor": false, "isApprover": false, "isAuthenticated": true, "isPermitted": false, "message": "Access denied", "role": "no_lock" } { "accessToken": "550e8400-e29b-11d4-a716-446655440000", "account": "root", "apiCall": "./lock", "enableTouch": true, "forcePasswordChange": false, "hasRole": true, "isApprovalRequestor": false, "isApprover": false, "isAuthenticated": true, "isPermitted": false, "message": "Access denied", "role": "no_lock" }
420	'download' 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": "download failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "download failed!" } }
433	4-eyes principle: Forbidden! The user needs approval process for 'download'		application/json model \| example { "title": "FourEyesResponse", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.security.foureyes.FourEyesResponse", "type": "object", "extends": { "javaType": "com.sos.joc.model.security.foureyes.ApprovalBase", "type": "object", "properties": { "requestor": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "requestUrl": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "requestBody": { "type": "object", "javaType": "com.sos.joc.model.security.foureyes.RequestBody", "additionalProperties": true }, "category": { "javaType": "com.sos.joc.model.audit.CategoryType", "type": "string", "enum": [ "INVENTORY", "CONTROLLER", "DAILYPLAN", "OTHERS", "DEPLOYMENT", "DOCUMENTATIONS", "CERTIFICATES", "IDENTITY", "SETTINGS", "MONITORING", "UNKNOWN" ] } }, "additionalProperties": false }, "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "message": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "approvers": { "type": "array", "items": { "javaType": "com.sos.joc.model.security.foureyes.Approver", "type": "object", "required": [ "accountName", "firstName", "lastName" ], "properties": { "accountName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "firstName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 30, "minLength": 1 }, "lastName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 30, "minLength": 1 }, "email": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255 } }, "additionalProperties": false } } }, "additionalProperties": false } { "deliveryDate": "2025-05-12T21:13:35Z", "accountName": "user1", "request": "./orders/add", "requestBody": { "controllerId": "standalone", "orders": [{ "workflowPath": "myWorkflow", "scheduledFor": "now" }] }, "category": "CONTROLLER", "objectType": "WORKFLOW" "objectName": "myWorkflow", "numOfObjects": 1, "action": "add orders" } { "deliveryDate": "2025-05-12T21:13:35Z", "accountName": "user1", "request": "./orders/add", "requestBody": { "controllerId": "standalone", "orders": [{ "workflowPath": "myWorkflow", "scheduledFor": "now" }] }, "category": "CONTROLLER", "objectType": "WORKFLOW" "objectName": "myWorkflow", "numOfObjects": 1, "action": "add orders" }
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": { "accessToken": { "type": "string" }, "account": { "type": "string" }, "callerHostName": { "type": "string" }, "callerIpAddress": { "type": "string" }, "enableTouch": { "type": "boolean", "default": true }, "forcePasswordChange": { "type": "boolean", "default": false }, "hasRole": { "type": "boolean", "default": false }, "identityService": { "type": "string" }, "isApprovalRequestor": { "type": "boolean", "default": false }, "isApprover": { "type": "boolean", "default": false }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "message": { "type": "string" }, "role": { "type": "string" }, "sessionTimeout": { "type": "integer", "default": 1800 } } } { "enableTouch": true, "forcePasswordChange": false, "hasRole": false, "isApprovalRequestor": false, "isApprover": false, "isAuthenticated": false, "isPermitted": false, "message": "SessionNotExistException: Session is broken and no longer valid. New login is neccessary" } { "enableTouch": true, "forcePasswordChange": false, "hasRole": false, "isApprovalRequestor": false, "isApprover": false, "isAuthenticated": false, "isPermitted": false, "message": "SessionNotExistException: Session is broken and no longer valid. New login is neccessary" }