JOC API

/inventory/search

POST

Searches inventory objects

Parameters in the POST body schema

Name	Type	Description	Example	Default
`controllerId`	optional, 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]
`returnType`	optional, string	Possible values WORKFLOW LOCK FILEORDERSOURCE JOBRESOURCE NOTICEBOARD SCHEDULE JOBTEMPLATE INCLUDESCRIPT CALENDAR (returns both working-day and non-working-day calendars) WORKINGDAYSCALENDAR (returns only working-day calendars) NONWORKINGDAYSCALENDAR (returns only non-working-day calendars) REPORT
`deployedOrReleased`	optional, boolean			false
`undeployedOrUnreleased`	optional, boolean			false
`valid`	optional, boolean	Considered only if `undeployedOrUnreleased` is true		false
`advanched`	optional, object
`agentName`	optional, string	Supports glob patterns. See the `search` parameter for syntax details.
`jobName`	optional, string	Supports glob patterns. See the `search` parameter for syntax details.
`jobNameExactMatch`	optional, boolean			false
`jobCriticality`	optional, string	Possible values: NORMAL, CRITICAL
`jobCountFrom`	optional, integer
`jobCountTo`	optional, integer
`argumentName`	optional, string	Supports glob patterns. See the `search` parameter for syntax details.
`argumentValue`	optional, string	Supports glob patterns. See the `search` parameter for syntax details.
`envName`	optional, string	Supports glob patterns. See the `search` parameter for syntax details.
`envValue`	optional, string	Supports glob patterns. See the `search` parameter for syntax details.
`fileOrderSource`	optional, string	Supports glob patterns. See the `search` parameter for syntax details.
`schedule`	optional, string	Supports glob patterns. See the `search` parameter for syntax details.
`includeScript`	optional, string	Supports glob patterns. See the `search` parameter for syntax details.
`jobResource`	optional, string	Supports glob patterns. See the `search` parameter for syntax details.
`jobTemplate`	optional, string	Supports glob patterns. See the `search` parameter for syntax details.
`workflow`	optional, string	Supports glob patterns. See the `search` parameter for syntax details.
`lock`	optional, string	Supports glob patterns. See the `search` parameter for syntax details.
`noticeboard`	optional, string	Supports glob patterns. See the `search` parameter for syntax details.
`calendar`	optional, string	Supports glob patterns. See the `search` parameter for syntax details.

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 Inventory search",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.inventory.search.RequestSearchFilter",
    "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": [
        "returnType"
    ],
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "deployedOrReleased": {
            "type": "boolean",
            "default": false
        },
        "undeployedOrUnreleased": {
            "type": "boolean",
            "default": false
        },
        "valid": {
            "description": "considered only if 'undeployedOrUnreleased' is true",
            "type": "boolean"
        },
        "returnType": {
            "javaType": "com.sos.joc.model.inventory.search.RequestSearchReturnType",
            "type": "string",
            "enum": [
                "WORKFLOW",
                "FILEORDERSOURCE",
                "JOBRESOURCE",
                "JOBTEMPLATE",
                "NOTICEBOARD",
                "LOCK",
                "SCHEDULE",
                "INCLUDESCRIPT",
                "CALENDAR",
                "WORKINGDAYSCALENDAR",
                "NONWORKINGDAYSCALENDAR",
                "REPORT"
            ]
        }
    },
    "additionalProperties": false
}

TODO

TODO

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" ] }, "group": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "ordering": { "type": "integer", "minimum": 0 } }, "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": { "accessToken": { "type": "string" }, "account": { "type": "string" }, "callerHostName": { "type": "string" }, "callerIpAddress": { "type": "string" }, "enableTouch": { "type": "boolean", "default": true }, "forcePasswordChange": { "type": "boolean", "default": false }, "hasRole": { "type": "boolean", "default": false }, "identityService": { "type": "string" }, "isApprovalRequestor": { "type": "boolean", "default": false }, "isApprover": { "type": "boolean", "default": false }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "message": { "type": "string" }, "role": { "type": "string" }, "sessionTimeout": { "type": "integer", "default": 1800 } } } { "account": "root", "callerHostName": "127.0.0.1", "callerIpAddress": "127.0.0.1", "enableTouch": true, "forcePasswordChange": false, "hasRole": false, "isApprovalRequestor": false, "isApprover": false, "isAuthenticated": false, "isPermitted": false, "message": "Access denied" } { "account": "root", "callerHostName": "127.0.0.1", "callerIpAddress": "127.0.0.1", "enableTouch": true, "forcePasswordChange": false, "hasRole": false, "isApprovalRequestor": false, "isApprover": false, "isAuthenticated": false, "isPermitted": false, "message": "Access denied" }
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": { "accessToken": { "type": "string" }, "account": { "type": "string" }, "callerHostName": { "type": "string" }, "callerIpAddress": { "type": "string" }, "enableTouch": { "type": "boolean", "default": true }, "forcePasswordChange": { "type": "boolean", "default": false }, "hasRole": { "type": "boolean", "default": false }, "identityService": { "type": "string" }, "isApprovalRequestor": { "type": "boolean", "default": false }, "isApprover": { "type": "boolean", "default": false }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "message": { "type": "string" }, "role": { "type": "string" }, "sessionTimeout": { "type": "integer", "default": 1800 } } } { "accessToken": "550e8400-e29b-11d4-a716-446655440000", "account": "root", "apiCall": "./lock", "enableTouch": true, "forcePasswordChange": false, "hasRole": true, "isApprovalRequestor": false, "isApprover": false, "isAuthenticated": true, "isPermitted": false, "message": "Access denied", "role": "no_lock" } { "accessToken": "550e8400-e29b-11d4-a716-446655440000", "account": "root", "apiCall": "./lock", "enableTouch": true, "forcePasswordChange": false, "hasRole": true, "isApprovalRequestor": false, "isApprover": false, "isAuthenticated": true, "isPermitted": false, "message": "Access denied", "role": "no_lock" }
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!" } }
433	4-eyes principle: Forbidden! The user needs approval process for 'search'	application/json model \| example { "title": "FourEyesResponse", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.security.foureyes.FourEyesResponse", "type": "object", "extends": { "javaType": "com.sos.joc.model.security.foureyes.ApprovalBase", "type": "object", "properties": { "requestor": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "requestUrl": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "requestBody": { "type": "object", "javaType": "com.sos.joc.model.security.foureyes.RequestBody", "additionalProperties": true }, "category": { "javaType": "com.sos.joc.model.audit.CategoryType", "type": "string", "enum": [ "INVENTORY", "CONTROLLER", "DAILYPLAN", "OTHERS", "DEPLOYMENT", "DOCUMENTATIONS", "CERTIFICATES", "IDENTITY", "SETTINGS", "MONITORING", "UNKNOWN" ] } }, "additionalProperties": false }, "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "message": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "approvers": { "type": "array", "items": { "javaType": "com.sos.joc.model.security.foureyes.Approver", "type": "object", "required": [ "accountName", "firstName", "lastName" ], "properties": { "accountName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "firstName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 30, "minLength": 1 }, "lastName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 30, "minLength": 1 }, "email": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255 } }, "additionalProperties": false } } }, "additionalProperties": false } { "deliveryDate": "2025-05-12T21:13:35Z", "accountName": "user1", "request": "./orders/add", "requestBody": { "controllerId": "standalone", "orders": [{ "workflowPath": "myWorkflow", "scheduledFor": "now" }] }, "category": "CONTROLLER", "objectType": "WORKFLOW" "objectName": "myWorkflow", "numOfObjects": 1, "action": "add orders" } { "deliveryDate": "2025-05-12T21:13:35Z", "accountName": "user1", "request": "./orders/add", "requestBody": { "controllerId": "standalone", "orders": [{ "workflowPath": "myWorkflow", "scheduledFor": "now" }] }, "category": "CONTROLLER", "objectType": "WORKFLOW" "objectName": "myWorkflow", "numOfObjects": 1, "action": "add orders" }
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": { "accessToken": { "type": "string" }, "account": { "type": "string" }, "callerHostName": { "type": "string" }, "callerIpAddress": { "type": "string" }, "enableTouch": { "type": "boolean", "default": true }, "forcePasswordChange": { "type": "boolean", "default": false }, "hasRole": { "type": "boolean", "default": false }, "identityService": { "type": "string" }, "isApprovalRequestor": { "type": "boolean", "default": false }, "isApprover": { "type": "boolean", "default": false }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "message": { "type": "string" }, "role": { "type": "string" }, "sessionTimeout": { "type": "integer", "default": 1800 } } } { "enableTouch": true, "forcePasswordChange": false, "hasRole": false, "isApprovalRequestor": false, "isApprover": false, "isAuthenticated": false, "isPermitted": false, "message": "SessionNotExistException: Session is broken and no longer valid. New login is neccessary" } { "enableTouch": true, "forcePasswordChange": false, "hasRole": false, "isApprovalRequestor": false, "isApprover": false, "isAuthenticated": false, "isPermitted": false, "message": "SessionNotExistException: Session is broken and no longer valid. New login is neccessary" }