JOC API

/workflows/order_count

POST

Returns number of orders of specified workflows

Parameters in the POST body schema

Name	Type	Description	Example
`controllerId`	required, string	Controller ID	myController
`workflowIds`	required, array[object]	Filtered response by a collection of workflowIds specified by its path and optional version	{ "path": "/path/to/workflow", "versionId": "c79caab4-4e72-4818-bae7-902f1037d8b6" }
`path`	required, string	Field for each item in `workflowIds` to specify the path of a workflow
`versionId`	optional, string	Field for each in `workflowIds` to specify the version of a workflow
`dateTo`	optional, string	The value has multiple formats Filters Orders whose schedule is before 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
`timeZone`	optional, string	If this parameter is set then it beats the time offset of absolute dates in `dateTo` See here the list for available time zones.	Europe/Berlin

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": "workflowIdsFilter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.workflow.WorkflowIdsFilter",
    "type": "object",
    "required": [
        "controllerId",
        "workflowIds"
    ],
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100,
            "minLength": 1
        },
        "workflowIds": {
            "type": "array",
            "uniqueItems": true,
            "minItems": 1,
            "items": {
                "javaType": "com.sos.controller.model.workflow.WorkflowId",
                "type": "object",
                "required": [
                    "path"
                ],
                "properties": {
                    "path": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255,
                        "minLength": 1
                    },
                    "versionId": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    }
                },
                "additionalProperties": false
            }
        }
    },
    "additionalProperties": false
}

{ "controllerId": "testsuite", "workflowIds": [{ "path": "/Examples.Unix/05_ScheduledExecution/jduScheduledWorkflowForkList", "versionId": "10ac4f2a-1977-4232-81cf-e90862477271" }, { "path": "/Examples.Unix/05_ScheduledExecution/jduScheduledWorkflowBusinessDays", "versionId": "10ac4f2a-1977-4232-81cf-e90862477271" }, { "path": "/Examples.Unix/05_ScheduledExecution/jduScheduledWorkflowDaily", "versionId": "10ac4f2a-1977-4232-81cf-e90862477271" }, { "path": "/Examples.Unix/05_ScheduledExecution/jduScheduledWorkflowCyclic", "versionId": "10ac4f2a-1977-4232-81cf-e90862477271" }], "dateTo": "1d", "timeZone": "Europe/Berlin" }

{
    "controllerId": "testsuite",
    "workflowIds": [{
        "path": "/Examples.Unix/05_ScheduledExecution/jduScheduledWorkflowForkList",
        "versionId": "10ac4f2a-1977-4232-81cf-e90862477271"
    }, {
        "path": "/Examples.Unix/05_ScheduledExecution/jduScheduledWorkflowBusinessDays",
        "versionId": "10ac4f2a-1977-4232-81cf-e90862477271"
    }, {
        "path": "/Examples.Unix/05_ScheduledExecution/jduScheduledWorkflowDaily",
        "versionId": "10ac4f2a-1977-4232-81cf-e90862477271"
    }, {
        "path": "/Examples.Unix/05_ScheduledExecution/jduScheduledWorkflowCyclic",
        "versionId": "10ac4f2a-1977-4232-81cf-e90862477271"
    }],
    "dateTo": "1d",
    "timeZone": "Europe/Berlin"
}

Responses

Code	Description	Body
200	Each workflow have following fields path versionId numOfOrders blocked failed inProgress pending prompting running scheduled suspended terminated waiting	application/json model \| example { "title": "workflows order count", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.workflow.WorkflowsOrderCount", "type": "object", "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" }, "workflows": { "type": "array", "items": { "type": "object", "javaType": "com.sos.joc.model.workflow.WorkflowOrderCount", "properties": { "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "versionId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "numOfOrders": { "javaType": "com.sos.joc.model.order.OrdersSummary", "type": "object", "properties": { "pending": { "type": "integer", "minimum": 0 }, "scheduled": { "type": "integer", "minimum": 0 }, "inProgress": { "type": "integer", "minimum": 0 }, "running": { "type": "integer", "minimum": 0 }, "prompting": { "type": "integer", "minimum": 0 }, "suspended": { "type": "integer", "minimum": 0 }, "waiting": { "type": "integer", "minimum": 0 }, "blocked": { "type": "integer", "minimum": 0 }, "failed": { "type": "integer", "minimum": 0 }, "terminated": { "type": "integer", "minimum": 0 } } } }, "additionalProperties": false } }, "numOfAllOrders": { "javaType": "com.sos.joc.model.order.OrdersSummary", "type": "object", "properties": { "pending": { "type": "integer", "minimum": 0 }, "scheduled": { "type": "integer", "minimum": 0 }, "inProgress": { "type": "integer", "minimum": 0 }, "running": { "type": "integer", "minimum": 0 }, "prompting": { "type": "integer", "minimum": 0 }, "suspended": { "type": "integer", "minimum": 0 }, "waiting": { "type": "integer", "minimum": 0 }, "blocked": { "type": "integer", "minimum": 0 }, "failed": { "type": "integer", "minimum": 0 }, "terminated": { "type": "integer", "minimum": 0 } } } }, "additionalProperties": false } { "deliveryDate": "2021-10-05T13:54:10.791Z", "surveyDate": "2021-10-05T13:54:03.41Z", "workflows": [{ "numOfOrders": { "blocked": 0, "failed": 0, "inProgress": 0, "pending": 0, "prompting": 0, "running": 0, "scheduled": 1, "suspended": 0, "terminated": 0, "waiting": 0 }, "path": "jduScheduledWorkflowDaily", "versionId": "10ac4f2a-1977-4232-81cf-e90862477271" }, { "numOfOrders": { "blocked": 0, "failed": 0, "inProgress": 0, "pending": 0, "prompting": 0, "running": 0, "scheduled": 1, "suspended": 0, "terminated": 0, "waiting": 0 }, "path": "jduScheduledWorkflowForkList", "versionId": "10ac4f2a-1977-4232-81cf-e90862477271" }, { "numOfOrders": { "blocked": 0, "failed": 0, "inProgress": 0, "pending": 0, "prompting": 0, "running": 0, "scheduled": 0, "suspended": 0, "terminated": 0, "waiting": 0 }, "path": "jduScheduledWorkflowCyclic", "versionId": "10ac4f2a-1977-4232-81cf-e90862477271" }, { "numOfOrders": { "blocked": 0, "failed": 0, "inProgress": 0, "pending": 0, "prompting": 0, "running": 0, "scheduled": 0, "suspended": 0, "terminated": 0, "waiting": 0 }, "path": "jduScheduledWorkflowBusinessDays", "versionId": "10ac4f2a-1977-4232-81cf-e90862477271" }] } { "deliveryDate": "2021-10-05T13:54:10.791Z", "surveyDate": "2021-10-05T13:54:03.41Z", "workflows": [{ "numOfOrders": { "blocked": 0, "failed": 0, "inProgress": 0, "pending": 0, "prompting": 0, "running": 0, "scheduled": 1, "suspended": 0, "terminated": 0, "waiting": 0 }, "path": "jduScheduledWorkflowDaily", "versionId": "10ac4f2a-1977-4232-81cf-e90862477271" }, { "numOfOrders": { "blocked": 0, "failed": 0, "inProgress": 0, "pending": 0, "prompting": 0, "running": 0, "scheduled": 1, "suspended": 0, "terminated": 0, "waiting": 0 }, "path": "jduScheduledWorkflowForkList", "versionId": "10ac4f2a-1977-4232-81cf-e90862477271" }, { "numOfOrders": { "blocked": 0, "failed": 0, "inProgress": 0, "pending": 0, "prompting": 0, "running": 0, "scheduled": 0, "suspended": 0, "terminated": 0, "waiting": 0 }, "path": "jduScheduledWorkflowCyclic", "versionId": "10ac4f2a-1977-4232-81cf-e90862477271" }, { "numOfOrders": { "blocked": 0, "failed": 0, "inProgress": 0, "pending": 0, "prompting": 0, "running": 0, "scheduled": 0, "suspended": 0, "terminated": 0, "waiting": 0 }, "path": "jduScheduledWorkflowBusinessDays", "versionId": "10ac4f2a-1977-4232-81cf-e90862477271" }] }
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 'order_count'	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	'order_count' 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": "order_count failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "order_count 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 }