JOC API

/workflows/search

POST

Searches deployed workflows

Parameters in the POST body schema

Name	Type	Description	Example	Default
`controllerId`	required, string	Controller ID	myController
`search`	optional, string	Limits result to a specified glob pattern that supports '' and '?' as wildcards where : match zero or more characters ? : match any single character	test
`folders`	optional, array[string]
`states`	optional, array	Filtered all workflows with states such as IN_SYNC NOT_IN_SYNC SUSPENDED OUTSTANDING	["SUSPENDED"]
`instructionStates`	optional, array	Filtered all workflows with instruction states such as SKIPPED STOPPED	["SKIPPED", "STOPPED"]
`tags`	optional, array[string]	Tag names
`advanched`	optional, object
`agentName`	optional, string
`jobName`	optional, string
`jobNameExactMatch`	optional, boolean			false
`jobCriticality`	optional, string	Possible values: NORMAL, CRITICAL
`jobCountFrom`	optional, integer
`jobCountTo`	optional, integer
`argumentName`	optional, string
`argumentValue`	optional, string
`envName`	optional, string
`envValue`	optional, string
`fileOrderSource`	optional, string
`schedule`	optional, string
`includeScript`	optional, string
`jobResource`	optional, string
`jobTemplate`	optional, string
`lock`	optional, string
`noticeboard`	optional, string
`calendar`	optional, string

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": "Filter workflow search",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.workflow.search.WorkflowSearchFilter",
    "type": "object",
    "extends": {
        "javaType": "com.sos.joc.model.inventory.search.RequestBaseSearchFilter",
        "type": "object",
        "properties": {
            "search": {
                "description": "pattern with wildcards '*' and '?' where '*' match zero or more characters and '?' match any single character",
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255
            },
            "folders": {
                "type": "array",
                "items": {
                    "description": "absolute path of an object.",
                    "type": "string",
                    "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
                    "maxLength": 255,
                    "minLength": 1
                }
            },
            "tags": {
                "type": "array",
                "items": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255,
                    "minLength": 1
                }
            },
            "advanced": {
                "javaType": "com.sos.joc.model.inventory.search.RequestSearchAdvancedItem",
                "type": "object",
                "properties": {
                    "agentName": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "workflow": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "fileOrderSource": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "lock": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "schedule": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "includeScript": {
                        "alias": "includeScripts",
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "calendar": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "noticeBoard": {
                        "alias": "noticeBoards",
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "jobResource": {
                        "alias": "jobResources",
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "jobTemplate": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "jobName": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "jobNameExactMatch": {
                        "type": "boolean",
                        "default": false
                    },
                    "jobCriticality": {
                        "javaType": "com.sos.inventory.model.job.JobCriticality",
                        "type": "string",
                        "enum": [
                            "NORMAL",
                            "CRITICAL"
                        ]
                    },
                    "jobCountFrom": {
                        "type": "integer",
                        "minimum": 0
                    },
                    "jobCountTo": {
                        "type": "integer",
                        "minimum": 0
                    },
                    "jobScript": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "argumentName": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "argumentValue": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "envName": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "envValue": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    }
                },
                "additionalProperties": false
            }
        },
        "additionalProperties": false
    },
    "required": [
        "controllerId"
    ],
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100,
            "minLength": 1
        },
        "states": {
            "type": "array",
            "items": {
                "javaType": "com.sos.controller.model.common.SyncStateText",
                "description": "SUSPENDED, OUTSTANDING only for Workflows",
                "type": "string",
                "enum": [
                    "IN_SYNC",
                    "NOT_IN_SYNC",
                    "NOT_DEPLOYED",
                    "SUSPENDED",
                    "OUTSTANDING",
                    "UNKNOWN"
                ]
            }
        },
        "instructionStates": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.workflow.search.InstructionStateText",
                "type": "string",
                "enum": [
                    "SKIPPED",
                    "STOPPED"
                ]
            }
        }
    },
    "additionalProperties": false
}

{ "folders": ["/test"], "controllerId": "standalone", "states": ["IN_SYNC", "SUSPENDED"], "instructionStates": ["SKIPPED", "STOPPED"] }

{
    "folders": ["/test"],
    "controllerId": "standalone",
    "states": ["IN_SYNC", "SUSPENDED"],
    "instructionStates": ["SKIPPED", "STOPPED"]
}

Responses

Code	Description	Body
200		application/json model \| example { "title": "Inventory search response", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.inventory.search.ResponseSearch", "type": "object", "required": [ "deliveryDate" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "results": { "type": "array", "items": { "javaType": "com.sos.joc.model.inventory.search.ResponseSearchItem", "type": "object", "extends": { "javaType": "com.sos.joc.model.inventory.search.ResponseBaseSearchItem", "type": "object", "required": [ "name", "path", "objectType" ], "properties": { "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "name": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "objectType": { "javaType": "com.sos.joc.model.inventory.common.ConfigurationType", "type": "string", "enum": [ "FOLDER", "WORKFLOW", "JOBCLASS", "JOBRESOURCE", "LOCK", "NOTICEBOARD", "FILEORDERSOURCE", "WORKINGDAYSCALENDAR", "NONWORKINGDAYSCALENDAR", "SCHEDULE", "INCLUDESCRIPT", "JOBTEMPLATE", "DEPLOYMENTDESCRIPTOR", "DESCRIPTORFOLDER" ] } }, "additionalProperties": false }, "required": [ "name", "path", "objectType" ], "properties": { "id": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "valid": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deployed": { "type": "boolean" }, "released": { "type": "boolean" }, "hasDeployments": { "type": "boolean" }, "hasReleases": { "type": "boolean" }, "controllerId": { "type": "string", "pattern": "^[^/\\<>?:\"\|]*$", "maxLength": 100 }, "permitted": { "type": "boolean" } }, "additionalProperties": false } } }, "additionalProperties": false } TODO TODO
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 'search'	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	'search' 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": "search failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "search 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 }