JOC API

/job_chain/history

POST

Last 25 order history item of the job chain from JobScheduler

Parameters in the POST body schema

Name	Type	Description	Example	Default
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`jobChain`	required, string	Specifies the job chain by its path	/sos/reporting/Inventory
`maxLastHistoryItems`	optional, integer			25

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": "jobChainFilter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.jobChain.JobChainHistoryFilter",
    "type": "object",
    "required": [
        "jobschedulerId",
        "jobChain"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "jobChain": {
            "description": "absolute path based on live folder of a JobScheduler object.",
            "type": "string",
            "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
            "maxLength": 255
        },
        "maxLastHistoryItems": {
            "type": "integer",
            "minimum": 0
        }
    }
}

TODO

TODO

Responses

Code	Description	Body
200	TODO	application/json model \| example { "title": "history collection of orders", "$schema": "http://json-schema.org/draft-04/schema#", "description": "one item per started order", "javaType": "com.sos.joc.model.order.OrderHistory", "type": "object", "required": [ "deliveryDate", "history" ], "properties": { "deliveryDate": { "description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "history": { "type": "array", "items": { "javaType": "com.sos.joc.model.order.OrderHistoryItem", "type": "object", "required": [ "surveyDate", "path", "orderId", "jobChain", "startTime", "node", "state", "historyId" ], "properties": { "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" }, "jobschedulerId": { "type": "string" }, "path": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "orderId": { "type": "string" }, "jobChain": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "startTime": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "endTime": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "node": { "type": "string" }, "state": { "javaType": "com.sos.joc.model.common.HistoryState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "description": "0=successful, 1=incomplete, 2=failed with a green/yellow/red representation", "type": "integer" }, "_text": { "javaType": "com.sos.joc.model.common.HistoryStateText", "type": "string", "enum": [ "SUCCESSFUL", "INCOMPLETE", "FAILED" ] } } }, "historyId": { "type": "string" }, "children": { "type": "array", "items": { "description": "historyItem-schema.json" } } } } } } } { "deliveryDate": "2016-09-06T12:26:43Z", "history": [{ "historyId": 1014860, "jobChain": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/LaunchJobChains", "orderId": "Start", "node": "Success", "startTime": "2016-08-26 06:46:14Z", "endTime": "2016-08-26 06:46:23Z", "state": { "_text": "SUCCESSFUL", "severity": 0 } }, { "historyId": 1014861, "jobChain": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/LaunchJobChains", "orderId": "Start", "node": "Success", "startTime": "2016-08-26 06:48:23Z", "endTime": "2016-08-26 06:48:31Z", "state": { "_text": "SUCCESSFUL", "severity": 0 } }, { "historyId": 1014863, "jobChain": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/LaunchJobChains", "orderId": "Start", "node": "Success", "startTime": "2016-08-26 06:50:31Z", "endTime": "2016-08-26 06:50:40Z", "state": { "_text": "SUCCESSFUL", "severity": 0 } }, { "historyId": 1014865, "jobChain": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/LaunchJobChains", "orderId": "Start", "node": "Success", "startTime": "2016-08-26 06:52:40Z", "endTime": "2016-08-26 06:52:49Z", "state": { "_text": "SUCCESSFUL", "severity": 0 } }, { "historyId": 1014866, "jobChain": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/LaunchJobChains", "orderId": "Start", "node": "Success", "startTime": "2016-08-26 06:54:49Z", "endTime": "2016-08-26 06:54:57Z", "state": { "_text": "SUCCESSFUL", "severity": 0 } }, { "historyId": 1014869, "jobChain": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/LaunchJobChains", "orderId": "Start", "node": "Success", "startTime": "2016-08-26 06:56:57Z", "endTime": "2016-08-26 06:57:06Z", "state": { "_text": "SUCCESSFUL", "severity": 0 } }, { "historyId": 1014870, "jobChain": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/LaunchJobChains", "orderId": "Start", "node": "Success", "startTime": "2016-08-26 06:59:06Z", "endTime": "2016-08-26 06:59:15Z", "state": { "_text": "SUCCESSFUL", "severity": 0 } }, { "historyId": 1014874, "jobChain": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/LaunchJobChains", "orderId": "Start", "node": "Success", "startTime": "2016-08-26 07:01:15Z", "endTime": "2016-08-26 07:01:28Z", "state": { "_text": "SUCCESSFUL", "severity": 0 } }, { "historyId": 1014875, "jobChain": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/LaunchJobChains", "orderId": "Start", "node": "Success", "startTime": "2016-08-26 07:03:28Z", "endTime": "2016-08-26 07:03:35Z", "state": { "_text": "SUCCESSFUL", "severity": 0 } }, { "historyId": 1014876, "jobChain": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/LaunchJobChains", "orderId": "Start", "node": "Success", "startTime": "2016-08-26 07:05:35Z", "endTime": "2016-08-26 07:05:44Z", "state": { "_text": "SUCCESSFUL", "severity": 0 } }] } { "deliveryDate": "2016-09-06T12:26:43Z", "history": [{ "historyId": 1014860, "jobChain": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/LaunchJobChains", "orderId": "Start", "node": "Success", "startTime": "2016-08-26 06:46:14Z", "endTime": "2016-08-26 06:46:23Z", "state": { "_text": "SUCCESSFUL", "severity": 0 } }, { "historyId": 1014861, "jobChain": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/LaunchJobChains", "orderId": "Start", "node": "Success", "startTime": "2016-08-26 06:48:23Z", "endTime": "2016-08-26 06:48:31Z", "state": { "_text": "SUCCESSFUL", "severity": 0 } }, { "historyId": 1014863, "jobChain": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/LaunchJobChains", "orderId": "Start", "node": "Success", "startTime": "2016-08-26 06:50:31Z", "endTime": "2016-08-26 06:50:40Z", "state": { "_text": "SUCCESSFUL", "severity": 0 } }, { "historyId": 1014865, "jobChain": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/LaunchJobChains", "orderId": "Start", "node": "Success", "startTime": "2016-08-26 06:52:40Z", "endTime": "2016-08-26 06:52:49Z", "state": { "_text": "SUCCESSFUL", "severity": 0 } }, { "historyId": 1014866, "jobChain": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/LaunchJobChains", "orderId": "Start", "node": "Success", "startTime": "2016-08-26 06:54:49Z", "endTime": "2016-08-26 06:54:57Z", "state": { "_text": "SUCCESSFUL", "severity": 0 } }, { "historyId": 1014869, "jobChain": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/LaunchJobChains", "orderId": "Start", "node": "Success", "startTime": "2016-08-26 06:56:57Z", "endTime": "2016-08-26 06:57:06Z", "state": { "_text": "SUCCESSFUL", "severity": 0 } }, { "historyId": 1014870, "jobChain": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/LaunchJobChains", "orderId": "Start", "node": "Success", "startTime": "2016-08-26 06:59:06Z", "endTime": "2016-08-26 06:59:15Z", "state": { "_text": "SUCCESSFUL", "severity": 0 } }, { "historyId": 1014874, "jobChain": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/LaunchJobChains", "orderId": "Start", "node": "Success", "startTime": "2016-08-26 07:01:15Z", "endTime": "2016-08-26 07:01:28Z", "state": { "_text": "SUCCESSFUL", "severity": 0 } }, { "historyId": 1014875, "jobChain": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/LaunchJobChains", "orderId": "Start", "node": "Success", "startTime": "2016-08-26 07:03:28Z", "endTime": "2016-08-26 07:03:35Z", "state": { "_text": "SUCCESSFUL", "severity": 0 } }, { "historyId": 1014876, "jobChain": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/LaunchJobChains", "orderId": "Start", "node": "Success", "startTime": "2016-08-26 07:05:35Z", "endTime": "2016-08-26 07:05:44Z", "state": { "_text": "SUCCESSFUL", "severity": 0 } }] }
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 'history'	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	'history' 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": "history failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "history 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 }