JOC API

/orders/history

POST

Order history

Parameters in the POST body schema

Name	Type	Description	Example	Default
`controllerId`	optional, string	Controller ID	myController
`orders`	optional, array	Filters result to orders specified by its workflow path and an optional order id. If the "orderId" is undefined then all orders of the specified workflow path are included in the response. If this parameter is specified then the parameters `folders`, `excludeWorkflows`, `orderId` and `workflowPath` are ignored.	[{ "workflowPath": "/path/to/workflow", "orderId":"myOrder" }]
`excludeWorkflows`	optional, array	The specified workflows are excluded in the response. This parameter will be ignored if `orders` parameter is set.	["/path/to/workflow"]
`dateFrom`	optional, 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
`completedDateFrom`	optional, 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
`completedDateTo`	optional, string	The value has multiple formats similiar to the `completedDateFrom` 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
`orderId`	optional, string	Limits result to a specified glob pattern of an Order ID that supports '' and '?' as wildcards where : match zero or more characters ? : match any single character	"test"
`workflowPath`	optional, string	Limits result to a specified glob pattern of a Workflow path that supports '' and '?' as wildcards where : match zero or more characters ? : match any single character	"my*Workflow"
`workflowName`	optional, string	Limits result to a specified glob pattern of a Workflow name that supports '' and '?' as wildcards where : match zero or more characters ? : match any single character	"my*Workflow"
`folders`	optional, array[object]	Limits the result to a collection of folders	[{ "folder": "/sos", "recursive": true }]
`limit`	optional, integer	Limits the number of resulting items, -1=unlimited	5000	10000
`historyStates`	optional, array[string] contains SUCCESSFUL, FAILED and/or INCOMPLETE	Limits result to specified states	["SUCCESSFUL"]
`historyIds`	optional; array[integer]	The history ids of orders If this parameter is specified then all other parameters except `controllerId` are ignored.	[4711]

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": "orders filter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.order.OrdersFilter",
    "type": "object",
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "orders": {
            "type": "array",
            "uniqueItems": true,
            "items": {
                "javaType": "com.sos.joc.model.order.OrderPath",
                "type": "object",
                "required": [
                    "workflowPath"
                ],
                "properties": {
                    "workflowPath": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "orderId": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    }
                }
            }
        },
        "excludeWorkflows": {
            "type": "array",
            "uniqueItems": true,
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255,
                "minLength": 1
            }
        },
        "compact": {
            "description": "controls if the object's data is compact or detailed",
            "type": "boolean",
            "default": false
        },
        "orderId": {
            "description": "pattern with wildcards '*' and '?' where '*' match zero or more characters and '?' match any single character",
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "workflowPath": {
            "description": "pattern with wildcards '*' and '?' where '*' match zero or more characters and '?' match any single character",
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "workflowName": {
            "description": "pattern with wildcards '*' and '?' where '*' match zero or more characters and '?' match any single character",
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "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})?)?$"
        },
        "completedDateFrom": {
            "alias": "endDateFrom",
            "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})?)?$"
        },
        "completedDateTo": {
            "alias": "endDateTo",
            "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"
        },
        "folders": {
            "type": "array",
            "items": {
                "type": "object",
                "javaType": "com.sos.joc.model.common.Folder",
                "required": [
                    "folder"
                ],
                "properties": {
                    "folder": {
                        "description": "absolute path of an object.",
                        "type": "string",
                        "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
                        "maxLength": 255,
                        "minLength": 1
                    },
                    "recursive": {
                        "type": "boolean",
                        "default": true
                    }
                },
                "additionalProperties": false
            }
        },
        "limit": {
            "description": "only for db history urls to restrict the number of responsed records; -1=unlimited",
            "type": "integer",
            "default": 10000
        },
        "historyStates": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.common.HistoryStateText",
                "type": "string",
                "enum": [
                    "SUCCESSFUL",
                    "INCOMPLETE",
                    "FAILED"
                ]
            }
        },
        "historyIds": {
            "type": "array",
            "items": {
                "type": "number",
                "format": "utc-millisec",
                "minimum": 0
            }
        }
    }
}

{ "controllerId": "controller", "orders": [{ "workflowPath": "chain1", "orderId": "foo1" }, { "workflowPath": "chain1", "orderId": "foo2" }, { "workflowPath": "chain2" }] }

{
    "controllerId": "controller",
    "orders": [{
        "workflowPath": "chain1",
        "orderId": "foo1"
    }, {
        "workflowPath": "chain1",
        "orderId": "foo2"
    }, {
        "workflowPath": "chain2"
    }]
}

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": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "history": { "type": "array", "items": { "javaType": "com.sos.joc.model.order.OrderHistoryItem", "type": "object", "required": [ "surveyDate", "orderId", "workflow", "startTime", "plannedTime", "position", "sequence", "state", "orderState", "historyId" ], "properties": { "surveyDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "controllerId": { "type": "string" }, "orderId": { "type": "string" }, "tags": { "type": "array", "uniqueItems": true, "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 } }, "workflow": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "startTime": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "plannedTime": { "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" }, "position": { "type": "string" }, "sequence": { "type": "integer", "minimum": 0 }, "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" ] } } }, "orderState": { "javaType": "com.sos.joc.model.order.OrderState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.joc.model.order.OrderStateText", "type": "string", "enum": [ "PLANNED", "PENDING", "SCHEDULED", "RUNNING", "INPROGRESS", "PROMPTING", "SUSPENDED", "FAILED", "WAITING", "BLOCKED", "CANCELLED", "FINISHED", "BROKEN", "UNKNOWN" ] }, "_reason": { "javaType": "com.sos.joc.model.order.OrderWaitingReason", "type": "string", "enum": [ "DELAYED_AFTER_ERROR", "FORKED", "EXPECTING_NOTICES", "WAITING_FOR_LOCK", "BETWEEN_CYCLES" ] } }, "additionalProperties": false }, "historyId": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "children": { "type": "array", "items": { "description": "orderHistoryItem-schema.json" } }, "arguments": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.common.Variables", "type": "object", "additionalProperties": true } } } }, "workflowTagsPerWorkflow": { "description": "a map of workflowName -> tags-array", "javaType": "com.sos.joc.model.common.WorkflowTags", "type": "object", "additionalProperties": { "type": "array", "uniqueItems": true, "items": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255 } } } }, "additionalProperties": false } { "deliveryDate": "2021-04-16T22:05:28.245+0000", "history": [{ "surveyDate": "2021-04-16T20:12:47.000+0000", "controllerId": "controller", "orderId": "#2021-04-16#P0000000004-schedule24", "workflow": "/Demo/MutualExclusion/demo1-pdlSharedLockSerial_002", "startTime": "2021-04-16T20:12:02.000+0000", "plannedTime": "2021-04-16T20:12:02.000+0000", "endTime": "2021-04-16T20:12:46.000+0000", "sequence": 0, "state": { "severity": 6, "_text": "SUCCESSFUL" }, "orderState": { "severity": 6, "_text": "FINISHED" }, "historyId": 29, "children": [] }, { "surveyDate": "2021-04-15T20:12:23.000+0000", "controllerId": "controller", "orderId": "#2021-04-15#P0000000003-demoPdwForm", "workflow": "/Demo/ParallelExecution/demo-pdwFork", "startTime": "2021-04-15T20:12:00.000+0000", "plannedTime": "2021-04-15T20:12:00.000+0000", "endTime": "2021-04-15T20:12:22.000+0000", "sequence": 0, "state": { "severity": 6, "_text": "SUCCESSFUL" }, "orderState": { "severity": 6, "_text": "FINISHED" }, "historyId": 26, "children": [] }, { "surveyDate": "2021-04-14T20:22:42.000+0000", "controllerId": "controller", "orderId": "#2021-04-14#P0000000001-pdfExclusive", "workflow": "/Demo/MutualExclusion/demo1-pdlExclusiveLockSerial_002", "startTime": "2021-04-14T20:22:00.000+0000", "plannedTime": "2021-04-14T20:22:00.000+0000", "endTime": "2021-04-14T20:22:41.000+0000", "sequence": 0, "state": { "severity": 6, "_text": "SUCCESSFUL" }, "orderState": { "severity": 6, "_text": "FINISHED" }, "historyId": 23, "children": [] }, { "surveyDate": "2021-04-14T18:00:50.000+0000", "controllerId": "controller", "orderId": "#2021-04-14#T8423216948-root", "workflow": "/Demo/ParallelExecution/demo-pwdForkNested", "startTime": "2021-04-14T18:00:17.000+0000", "plannedTime": "2021-04-14T18:00:17.000+0000", "endTime": "2021-04-14T18:00:49.000+0000", "sequence": 0, "state": { "severity": 6, "_text": "SUCCESSFUL" }, "orderState": { "severity": 6, "_text": "FINISHED" }, "historyId": 2, "children": [] }, { "surveyDate": "2021-04-14T18:00:48.000+0000", "controllerId": "controller", "orderId": "#2021-04-14#T8423212514-root", "workflow": "/Demo/ParallelExecution/demo-pwdForkNested", "startTime": "2021-04-14T18:00:14.000+0000", "plannedTime": "2021-04-14T18:00:14.000+0000", "endTime": "2021-04-14T18:00:47.000+0000", "sequence": 0, "state": { "severity": 6, "_text": "SUCCESSFUL" }, "orderState": { "severity": 6, "_text": "FINISHED" }, "historyId": 1, "children": [] }] } { "deliveryDate": "2021-04-16T22:05:28.245+0000", "history": [{ "surveyDate": "2021-04-16T20:12:47.000+0000", "controllerId": "controller", "orderId": "#2021-04-16#P0000000004-schedule24", "workflow": "/Demo/MutualExclusion/demo1-pdlSharedLockSerial_002", "startTime": "2021-04-16T20:12:02.000+0000", "plannedTime": "2021-04-16T20:12:02.000+0000", "endTime": "2021-04-16T20:12:46.000+0000", "sequence": 0, "state": { "severity": 6, "_text": "SUCCESSFUL" }, "orderState": { "severity": 6, "_text": "FINISHED" }, "historyId": 29, "children": [] }, { "surveyDate": "2021-04-15T20:12:23.000+0000", "controllerId": "controller", "orderId": "#2021-04-15#P0000000003-demoPdwForm", "workflow": "/Demo/ParallelExecution/demo-pdwFork", "startTime": "2021-04-15T20:12:00.000+0000", "plannedTime": "2021-04-15T20:12:00.000+0000", "endTime": "2021-04-15T20:12:22.000+0000", "sequence": 0, "state": { "severity": 6, "_text": "SUCCESSFUL" }, "orderState": { "severity": 6, "_text": "FINISHED" }, "historyId": 26, "children": [] }, { "surveyDate": "2021-04-14T20:22:42.000+0000", "controllerId": "controller", "orderId": "#2021-04-14#P0000000001-pdfExclusive", "workflow": "/Demo/MutualExclusion/demo1-pdlExclusiveLockSerial_002", "startTime": "2021-04-14T20:22:00.000+0000", "plannedTime": "2021-04-14T20:22:00.000+0000", "endTime": "2021-04-14T20:22:41.000+0000", "sequence": 0, "state": { "severity": 6, "_text": "SUCCESSFUL" }, "orderState": { "severity": 6, "_text": "FINISHED" }, "historyId": 23, "children": [] }, { "surveyDate": "2021-04-14T18:00:50.000+0000", "controllerId": "controller", "orderId": "#2021-04-14#T8423216948-root", "workflow": "/Demo/ParallelExecution/demo-pwdForkNested", "startTime": "2021-04-14T18:00:17.000+0000", "plannedTime": "2021-04-14T18:00:17.000+0000", "endTime": "2021-04-14T18:00:49.000+0000", "sequence": 0, "state": { "severity": 6, "_text": "SUCCESSFUL" }, "orderState": { "severity": 6, "_text": "FINISHED" }, "historyId": 2, "children": [] }, { "surveyDate": "2021-04-14T18:00:48.000+0000", "controllerId": "controller", "orderId": "#2021-04-14#T8423212514-root", "workflow": "/Demo/ParallelExecution/demo-pwdForkNested", "startTime": "2021-04-14T18:00:14.000+0000", "plannedTime": "2021-04-14T18:00:14.000+0000", "endTime": "2021-04-14T18:00:47.000+0000", "sequence": 0, "state": { "severity": 6, "_text": "SUCCESSFUL" }, "orderState": { "severity": 6, "_text": "FINISHED" }, "historyId": 1, "children": [] }] }
401	Unauthorized!	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false }
403	Forbidden! The user doesn't have sufficient permissions for 'history'	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "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 ...", "role": "all", "isAuthenticated": true, "isPermitted": false } { "user": "root", "message": "You don't have sufficient permissions for ...", "role": "all", "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": "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": "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": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "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", "role": "all", "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Session has expired. Please log in again", "role": "all", "isAuthenticated": false, "isPermitted": false }