JOC API

/audit_log

POST

Responds the audit log

Parameters in the POST body schema

Name	Type	Description	Example	Default
`jobschedulerId`	optional, string	JobScheduler Master ID	scheduler
`dateFrom`	optional, string	The value has multiple formats a format for a date in ISO 8601 format where the time offset and milliseconds are 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 time period in relative to the current time, e.g. 6h, 12h, 1d, 1w can specify in addition with a time offset 0 or digits followed by a letter are expected where the letter has to be: 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 be also specify with the parameter `timeZone` if `timeZone` undefined then UTC is used the value 0 means the current time Returns only collection items younger than this date.	1d
`dateTo`	optional, string	The value has multiple formats like the `dateFrom` parameter Return only collection items older than this date.	0
`timeZone`	optional, string	If this parameter is set then it beats the time offset in `dateFrom` and `dateTo` See here the list for available time zones.	Berlin/Europe
`regex`	optional, string	Regular expression to filter the collection	.*
`folders`	optional, array	collection of folder objects	[{ "folder": "/sos", "recursive": true }]
`requests`	optional, array	Field to search for request URLs.	[ "./jobscheduler/terminate", "./jobscheduler/restart" ]
`jobs`	optional, array	Filtered response by a collection of jobs specified by its job path. Other parameters such as `folders`, `excludeJobs` and `regex` are ignored if this parameter is defined.	[{ "job":"/sos/reporting/Inventory" }]
`orders`	optional, array	Filtered response by a collection of orders specified by its job chain path and an optional order id. If "orderId" is undefined then all orders of the specified job chain are included in the response. If "orderId" is specified then parameters such as `folders`, `types`, `excludeOrders` and `regex` are ignored.	[{ "jobChain":"/sos/reporting/Inventory", "orderId":"Inventory" }]
`calendars`	optional, array	Filtered response by a collection of calendars specified by its calendar path. Some other parameters such as `calendarIds`, `folders`, `regex`, `type` and `categories` are ignored if this parameter is defined.	[ "/sos/myCalendar", "/sos/myCalendar2" ]
`ticketLink`	optional, string	Field to search for a ticket link.
`account`	optional, string	Only items of the specified account are sent
`limit`	optional, integer	Restricts the number of responsed records, -1=unlimited	5000	10000

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": "auditLogFilter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.audit.AuditLogFilter",
    "type": "object",
    "required": [
        "jobschedulerId"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "jobs": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.audit.JobPath",
                "type": "object",
                "required": [
                    "job"
                ],
                "properties": {
                    "job": {
                        "description": "path with possibly % for sql like syntax in search requests",
                        "type": "string",
                        "pattern": "^[^\\<>?:\"|*]+$",
                        "maxLength": 255
                    }
                }
            }
        },
        "jobStreams": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.audit.JobStreamPath",
                "type": "object",
                "required": [
                    "jobStream"
                ],
                "properties": {
                    "jobStream": {
                        "description": "path with possibly % for sql like syntax in search requests",
                        "type": "string",
                        "pattern": "^[^\\<>?:\"|*]+$",
                        "maxLength": 255
                    }
                }
            }
        },
        "orders": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.audit.OrderPath",
                "type": "object",
                "properties": {
                    "jobChain": {
                        "description": "path with possibly % for sql like syntax in search requests",
                        "type": "string",
                        "pattern": "^[^\\<>?:\"|*]+$",
                        "maxLength": 255
                    },
                    "orderId": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    }
                }
            }
        },
        "calendars": {
            "type": "array",
            "items": {
                "description": "path with possibly % for sql like syntax in search requests",
                "type": "string",
                "pattern": "^[^\\<>?:\"|*]+$",
                "maxLength": 255
            }
        },
        "folders": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.common.Folder",
                "type": "object",
                "required": [
                    "folder"
                ],
                "properties": {
                    "folder": {
                        "description": "absolute path based on live folder of a JobScheduler object.",
                        "type": "string",
                        "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
                        "maxLength": 255
                    },
                    "recursive": {
                        "type": "boolean",
                        "default": true
                    }
                }
            }
        },
        "account": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "requests": {
            "type": "array",
            "items": {
                "description": "path with possibly % for sql like syntax in search requests",
                "type": "string",
                "pattern": "^[^\\<>?:\"|*]+$",
                "maxLength": 255
            }
        },
        "regex": {
            "description": "regular expression to filter JobScheduler objects by matching the path",
            "type": "string",
            "pattern": "^((?!<script( |>)|<svg/on).)*$"
        },
        "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": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "limit": {
            "description": "restricts the number of responsed records; -1=unlimited",
            "type": "integer",
            "default": 10000
        },
        "ticketLink": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        }
    }
}

Responses

Code	Description	Body
200	Each audit log entry has the following fields. Required fields are account request (webservice url) created (timestamp of the request) comment Optional fields are parameters (from post body of the request) job (if the object is a job) jobChain (if the object is a job chain or an order) orderId (if the object is an order)	application/json model \| example { "title": "auditLog", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.audit.AuditLog", "type": "object", "required": [ "deliveryDate", "auditLog" ], "properties": { "deliveryDate": { "description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "auditLog": { "type": "array", "items": { "javaType": "com.sos.joc.model.audit.AuditLogItem", "type": "object", "required": [ "account", "request", "created" ], "properties": { "account": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "request": { "type": "string", "pattern": "^[^<>]$", "maxLength": 50 }, "created": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "jobschedulerId": { "type": "string", "pattern": "^[^/\\<>?:\"\|]$", "maxLength": 100 }, "comment": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "parameters": { "description": "JSON object as string, parameter of request", "type": "string" }, "job": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "jobChain": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "jobStream": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "orderId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "calendar": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "timeSpent": { "type": "integer", "minimum": 0 }, "ticketLink": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255 } } } } } }
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 'audit_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	'audit_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": "audit_log failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "audit_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 }