JOC API

/documentations/quick/search

POST

Searches documentations

Parameters in the POST body schema

Name	Type	Description	Example	Default
`search`	required, string	Limits result to a specified glob pattern that supports '' and '?' as wildcards where : match zero or more characters ? : match any single character	test

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 deployed objects search",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.common.DeployedObjectQuickSearchFilter",
    "type": "object",
    "extends": {
        "javaType": "com.sos.joc.model.inventory.search.RequestBaseQuickSearchFilter",
        "type": "object",
        "required": [
            "search"
        ],
        "description": "returnType can only be set with starting a new search, i. e. empty token",
        "properties": {
            "search": {
                "description": "pattern with wildcards '*' and '?' where '*' match zero or more characters and '?' match any single character",
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255
            },
            "token": {
                "type": "string",
                "pattern": "^[0-9a-fA-F]*$",
                "maxLength": 64
            },
            "quit": {
                "type": "boolean",
                "default": false
            }
        },
        "additionalProperties": false
    },
    "required": [
        "search",
        "controllerId"
    ],
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100,
            "minLength": 1
        }
    },
    "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.ResponseQuickSearch", "type": "object", "required": [ "deliveryDate", "token" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "token": { "type": "string", "pattern": "^[0-9a-fA-F]$", "maxLength": 64 }, "results": { "type": "array", "items": { "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 } } }, "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 }