JOC API

/inventory/path

POST

Delivers the path of an object, specified by its name and object type

Parameters in the POST body schema

Name	Type	Description	Example	Default
`name`	required, string	The `name` (unique identifier) of the inventory object.	"name": "myWorkflow"
`objectType`	required, string	String representation of the `objectType` from the enum ConfigurationType. The Enum consist of: "FOLDER" "WORKFLOW" "JOBRESOURCE" "NOTICEBOARD" "LOCK" "FILEORDERSOURCE" "WORKINGDAYSCALENDAR" "NONWORKINGDAYSCALENDAR" "SCHEDULE" "JOBTEMPLATE" "INCLUDESCRIPT"	"objectType" : "WORKFLOW"
`useDrafts`	boolean, optional	This property decides if delivered paths for the object will be determined from draft state or from released/deployed state of the object.	"useDrafts" : true	false

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": "delivers path of an inventory object by name and object type",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.inventory.path.PathFilter",
    "type": "object",
    "required": [
        "name",
        "objectType"
    ],
    "properties": {
        "name": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "objectType": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "useDrafts": {
            "type": "boolean",
            "default": false
        }
    }
}

{ "name": "test_wf", "objectType": "WORKFLOW", "useDrafts": true }

{
    "name": "test_wf",
    "objectType": "WORKFLOW",
    "useDrafts": true
}

Responses

Code	Description	Body
200		application/json model \| example { "title": "delivers path of an inventory object by name and object type", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.inventory.path.PathResponse", "type": "object", "properties": { "path": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255 }, "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" } } } { "path": "/_2021_01_18/test_wf", "deliveryDate": "2021-01-27T13:41:45.919Z" } { "path": "/_2021_01_18/test_wf", "deliveryDate": "2021-01-27T13:41:45.919Z" }
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 'path'	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	'path' 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": "path failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "path 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 }