JOC API

/orders/p

POST

Returns a collection of orders (permanent part) filtered by a period or job chains

Parameters in the POST body schema

Name	Type	Description	Example	Default
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`compact`	optional, boolean	Response has a compact version if this parameter is true		false
`regex`	optional, string	Regular expression to filter the collection	.*
`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" }]
`folders`	optional, array	collection of folder objects	[{ "folder": "/sos", "recursive": true }]

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": "orders filter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.order.OrdersFilter",
    "type": "object",
    "required": [
        "jobschedulerId"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "orders": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.order.OrderPath",
                "type": "object",
                "required": [
                    "jobChain"
                ],
                "properties": {
                    "jobChain": {
                        "description": "absolute path based on live folder of a JobScheduler object.",
                        "type": "string",
                        "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
                        "maxLength": 255
                    },
                    "orderId": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    }
                }
            }
        },
        "excludeOrders": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.order.OrderPath",
                "type": "object",
                "required": [
                    "jobChain"
                ],
                "properties": {
                    "jobChain": {
                        "description": "absolute path based on live folder of a JobScheduler object.",
                        "type": "string",
                        "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
                        "maxLength": 255
                    },
                    "orderId": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    }
                }
            }
        },
        "compact": {
            "description": "controls if the object view is compact or detailed",
            "type": "boolean",
            "default": false
        },
        "regex": {
            "description": "regular expression to filter JobScheduler objects by matching the path",
            "type": "string",
            "pattern": "^((?!<script( |>)|<svg/on).)*$"
        },
        "processingStates": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.order.OrderStateFilter",
                "type": "string",
                "enum": [
                    "PENDING",
                    "RUNNING",
                    "SUSPENDED",
                    "SETBACK",
                    "BLACKLIST",
                    "WAITINGFORRESOURCE"
                ]
            }
        },
        "types": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.order.OrderType",
                "type": "string",
                "description": "the type of the order",
                "enum": [
                    "PERMANENT",
                    "AD_HOC",
                    "FILE_ORDER"
                ]
            }
        },
        "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
        },
        "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
                    }
                }
            }
        },
        "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
            }
        },
        "runTimeIsTemporary": {
            "type": "boolean"
        }
    }
}

{ "jobschedulerId": "scheduler", "compact": true, "orders": [{ "jobChain": "/test/chain1", "orderId": "foo1" }, { "jobChain": "/test/chain1", "orderId": "foo2" }, { "jobChain": "/test/chain2" }] }

{
    "jobschedulerId": "scheduler",
    "compact": true,
    "orders": [{
        "jobChain": "/test/chain1",
        "orderId": "foo1"
    }, {
        "jobChain": "/test/chain1",
        "orderId": "foo2"
    }, {
        "jobChain": "/test/chain2"
    }]
}

Responses