JOC API

/inventory/deployables

POST

Gets deployable objects

Parameters in the POST body schema

Name	Type	Description	Example	Default
`folder`	required, string	Absolute path of a folder
`recursive`	optional, boolean	reads folder recursive		false
`objectTypes`	optional, array	Object types of depoyable configuration item. Possible value are "WORKFLOW" "JOBRESOURCE" "LOCK" "NOTICEBOARD" "FILEORDERSOURCE"	["WORKFLOW"]
`onlyValidObjects`	optional, boolean	Limits response to valid configurations only.		false
`withRemovedObjects`	optional, boolean	If true, result include removed configuration items		false
`withoutDrafts`	optional, boolean	If false, draft versions are returned		false
`withoutDeployed`	optional, boolean	If false, deployed items are returned		false
`latest`	optional, boolean	If true, only the latest deployed items are returned This value is only considered if `withoutDeployed` is false		false
`controllerId`	optional, string	If the controllerId is specified than the deployment status will be checked

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 Deployables",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.inventory.deploy.DeployablesFilter",
    "type": "object",
    "required": [
        "folder"
    ],
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "folder": {
            "description": "absolute path of an object.",
            "type": "string",
            "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
            "maxLength": 255,
            "minLength": 1
        },
        "recursive": {
            "type": "boolean",
            "default": false
        },
        "objectTypes": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.inventory.common.ConfigurationType",
                "type": "string",
                "enum": [
                    "FOLDER",
                    "WORKFLOW",
                    "JOBCLASS",
                    "JOBRESOURCE",
                    "LOCK",
                    "NOTICEBOARD",
                    "FILEORDERSOURCE",
                    "WORKINGDAYSCALENDAR",
                    "NONWORKINGDAYSCALENDAR",
                    "SCHEDULE",
                    "INCLUDESCRIPT",
                    "JOBTEMPLATE"
                ]
            }
        },
        "onlyValidObjects": {
            "type": "boolean",
            "default": false
        },
        "withRemovedObjects": {
            "type": "boolean",
            "default": false
        },
        "withoutDrafts": {
            "type": "boolean",
            "default": false
        },
        "withoutDeployed": {
            "type": "boolean",
            "default": false
        },
        "latest": {
            "description": "only relevant for deployed objects",
            "type": "boolean",
            "default": false
        }
    }
}

{ "onlyValidObjects": true, "withVersions": true, "folder": "/", "objectTypes": ["WORKFLOW"] }

{
    "onlyValidObjects": true,
    "withVersions": true,
    "folder": "/",
    "objectTypes": ["WORKFLOW"]
}

Responses

Code	Description	Body
200	The response contains subfolders and deployable objects. Each deployable object contains the following fields depends on the requested parameters id folder objectName objectType valid deleted deployed deployablesVersions syncState if controllerId is specified in the request It is an array where the first item is the draft if the draft is valid and `withoutDrafts` == false The draft item has the fields id versionDate If `withoutDeployed` == false then further items from previous deployments are included If `latest` == true then only the last deployments is included The deployed items have the fields id commitId deploymentId deploymentPath deploymentOperation versionDate versions - It is an array with the controllerIds where this iten was deployed A subfolder contains the following fields id folder objectName objectType deleted	application/json model \| example { "title": "ResponseDeployables", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.inventory.deploy.ResponseDeployables", "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" }, "name": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "folders": { "type": "array", "items": { "description": "response-deployables-schema.json" } }, "deployables": { "type": "array", "items": { "javaType": "com.sos.joc.model.inventory.deploy.ResponseDeployableTreeItem", "type": "object", "properties": { "id": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "folder": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "objectName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "account": { "type": "string", "pattern": "^[^<>]$", "maxLength": 100 }, "objectType": { "javaType": "com.sos.joc.model.inventory.common.ConfigurationType", "type": "string", "enum": [ "FOLDER", "WORKFLOW", "JOBCLASS", "JOBRESOURCE", "LOCK", "NOTICEBOARD", "FILEORDERSOURCE", "WORKINGDAYSCALENDAR", "NONWORKINGDAYSCALENDAR", "SCHEDULE", "INCLUDESCRIPT", "JOBTEMPLATE" ] }, "valid": { "type": "boolean" }, "deleted": { "type": "boolean" }, "syncState": { "javaType": "com.sos.controller.model.common.SyncState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "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" ] } } }, "deployed": { "type": "boolean" }, "deployablesVersions": { "type": "array", "items": { "javaType": "com.sos.joc.model.inventory.deploy.ResponseDeployableVersion", "type": "object", "properties": { "id": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "commitId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "deploymentId": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "deploymentPath": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "deploymentOperation": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "versionDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "versions": { "type": "array", "items": { "javaType": "com.sos.joc.model.inventory.common.ResponseItemDeployment", "type": "object", "properties": { "deploymentId": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "controllerId": { "type": "string", "pattern": "^[^/\\<>?:\"\|]$", "maxLength": 100 }, "version": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "deploymentDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" } } }, "uniqueItems": true } } }, "uniqueItems": true } } }, "uniqueItems": true } }, "additionalProperties": false } { "deliveryDate": "2021-12-14T01:39:55.7Z", "deployables": [{ "deleted": false, "deployablesVersions": [{ "commitId": "2369b498-312f-413f-82bc-149c9dda6328", "deploymentId": 26750, "deploymentOperation": "update", "deploymentPath": "/JS7Demo/01_HelloWorld/jdHelloRunningLog", "id": 1533, "versionDate": "2021-12-10T20:36:25Z", "versions": [{ "controllerId": "testsuite" }] }, { "commitId": "d07dfa23-5992-4bc8-8140-edf1be2bfda2", "deploymentId": 26520, "deploymentOperation": "update", "deploymentPath": "/JS7Demo/01_HelloWorld/jdHelloRunningLog", "id": 1533, "versionDate": "2021-12-10T18:39:20Z", "versions": [{ "controllerId": "testsuite" }] }, { "commitId": "92e0d370-532e-49a5-b82c-d4c2712c2ee9", "deploymentId": 26070, "deploymentOperation": "update", "deploymentPath": "/JS7Demo/01_HelloWorld/jdHelloRunningLog", "id": 1533, "versionDate": "2021-12-10T18:27:17Z", "versions": [{ "controllerId": "testsuite" }] }, { "commitId": "04e9c51b-ef2f-41e8-ae1f-39d475747ae9", "deploymentId": 23854, "deploymentOperation": "update", "deploymentPath": "/JS7Demo/01_HelloWorld/jdHelloRunningLog", "id": 1533, "versionDate": "2021-12-09T14:16:32Z", "versions": [{ "controllerId": "testsuite" }] }, { "commitId": "8341c9e7-fd0b-4d96-a649-25c6041a3e44", "deploymentId": 22971, "deploymentOperation": "update", "deploymentPath": "/JS7Demo/01_HelloWorld/jdHelloRunningLog", "id": 1533, "versionDate": "2021-11-26T20:59:40Z", "versions": [{ "controllerId": "testsuite" }] }], "deployed": true, "folder": "/JS7Demo/01_HelloWorld", "id": 1533, "objectName": "jdHelloRunningLog", "objectType": "WORKFLOW", "valid": true }, { "deleted": false, "deployablesVersions": [{ "commitId": "2369b498-312f-413f-82bc-149c9dda6328", "deploymentId": 26705, "deploymentOperation": "update", "deploymentPath": "/JS7Demo/01_HelloWorld/jdHelloWorld", "id": 1400, "versionDate": "2021-12-10T20:36:25Z", "versions": [{ "controllerId": "testsuite" }] }, { "commitId": "d07dfa23-5992-4bc8-8140-edf1be2bfda2", "deploymentId": 26523, "deploymentOperation": "update", "deploymentPath": "/JS7Demo/01_HelloWorld/jdHelloWorld", "id": 1400, "versionDate": "2021-12-10T18:39:20Z", "versions": [{ "controllerId": "testsuite" }] }, { "commitId": "92e0d370-532e-49a5-b82c-d4c2712c2ee9", "deploymentId": 26032, "deploymentOperation": "update", "deploymentPath": "/JS7Demo/01_HelloWorld/jdHelloWorld", "id": 1400, "versionDate": "2021-12-10T18:27:17Z", "versions": [{ "controllerId": "testsuite" }] }, { "commitId": "04e9c51b-ef2f-41e8-ae1f-39d475747ae9", "deploymentId": 23810, "deploymentOperation": "update", "deploymentPath": "/JS7Demo/01_HelloWorld/jdHelloWorld", "id": 1400, "versionDate": "2021-12-09T14:16:32Z", "versions": [{ "controllerId": "testsuite" }] }, { "commitId": "7062957a-b251-4061-ba1c-69dc710391b0", "deploymentId": 23168, "deploymentOperation": "update", "deploymentPath": "/JS7Demo/01_HelloWorld/jdHelloWorld", "id": 1400, "versionDate": "2021-11-28T08:57:15Z", "versions": [{ "controllerId": "testsuite" }] }], "deployed": true, "folder": "/JS7Demo/01_HelloWorld", "id": 1400, "objectName": "jdHelloWorld", "objectType": "WORKFLOW", "valid": true }], "folders": [], "name": "01_HelloWorld", "path": "/JS7Demo/01_HelloWorld" } { "deliveryDate": "2021-12-14T01:39:55.7Z", "deployables": [{ "deleted": false, "deployablesVersions": [{ "commitId": "2369b498-312f-413f-82bc-149c9dda6328", "deploymentId": 26750, "deploymentOperation": "update", "deploymentPath": "/JS7Demo/01_HelloWorld/jdHelloRunningLog", "id": 1533, "versionDate": "2021-12-10T20:36:25Z", "versions": [{ "controllerId": "testsuite" }] }, { "commitId": "d07dfa23-5992-4bc8-8140-edf1be2bfda2", "deploymentId": 26520, "deploymentOperation": "update", "deploymentPath": "/JS7Demo/01_HelloWorld/jdHelloRunningLog", "id": 1533, "versionDate": "2021-12-10T18:39:20Z", "versions": [{ "controllerId": "testsuite" }] }, { "commitId": "92e0d370-532e-49a5-b82c-d4c2712c2ee9", "deploymentId": 26070, "deploymentOperation": "update", "deploymentPath": "/JS7Demo/01_HelloWorld/jdHelloRunningLog", "id": 1533, "versionDate": "2021-12-10T18:27:17Z", "versions": [{ "controllerId": "testsuite" }] }, { "commitId": "04e9c51b-ef2f-41e8-ae1f-39d475747ae9", "deploymentId": 23854, "deploymentOperation": "update", "deploymentPath": "/JS7Demo/01_HelloWorld/jdHelloRunningLog", "id": 1533, "versionDate": "2021-12-09T14:16:32Z", "versions": [{ "controllerId": "testsuite" }] }, { "commitId": "8341c9e7-fd0b-4d96-a649-25c6041a3e44", "deploymentId": 22971, "deploymentOperation": "update", "deploymentPath": "/JS7Demo/01_HelloWorld/jdHelloRunningLog", "id": 1533, "versionDate": "2021-11-26T20:59:40Z", "versions": [{ "controllerId": "testsuite" }] }], "deployed": true, "folder": "/JS7Demo/01_HelloWorld", "id": 1533, "objectName": "jdHelloRunningLog", "objectType": "WORKFLOW", "valid": true }, { "deleted": false, "deployablesVersions": [{ "commitId": "2369b498-312f-413f-82bc-149c9dda6328", "deploymentId": 26705, "deploymentOperation": "update", "deploymentPath": "/JS7Demo/01_HelloWorld/jdHelloWorld", "id": 1400, "versionDate": "2021-12-10T20:36:25Z", "versions": [{ "controllerId": "testsuite" }] }, { "commitId": "d07dfa23-5992-4bc8-8140-edf1be2bfda2", "deploymentId": 26523, "deploymentOperation": "update", "deploymentPath": "/JS7Demo/01_HelloWorld/jdHelloWorld", "id": 1400, "versionDate": "2021-12-10T18:39:20Z", "versions": [{ "controllerId": "testsuite" }] }, { "commitId": "92e0d370-532e-49a5-b82c-d4c2712c2ee9", "deploymentId": 26032, "deploymentOperation": "update", "deploymentPath": "/JS7Demo/01_HelloWorld/jdHelloWorld", "id": 1400, "versionDate": "2021-12-10T18:27:17Z", "versions": [{ "controllerId": "testsuite" }] }, { "commitId": "04e9c51b-ef2f-41e8-ae1f-39d475747ae9", "deploymentId": 23810, "deploymentOperation": "update", "deploymentPath": "/JS7Demo/01_HelloWorld/jdHelloWorld", "id": 1400, "versionDate": "2021-12-09T14:16:32Z", "versions": [{ "controllerId": "testsuite" }] }, { "commitId": "7062957a-b251-4061-ba1c-69dc710391b0", "deploymentId": 23168, "deploymentOperation": "update", "deploymentPath": "/JS7Demo/01_HelloWorld/jdHelloWorld", "id": 1400, "versionDate": "2021-11-28T08:57:15Z", "versions": [{ "controllerId": "testsuite" }] }], "deployed": true, "folder": "/JS7Demo/01_HelloWorld", "id": 1400, "objectName": "jdHelloWorld", "objectType": "WORKFLOW", "valid": true }], "folders": [], "name": "01_HelloWorld", "path": "/JS7Demo/01_HelloWorld" }
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 'deployables'	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	'deployables' 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": "deployables failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "deployables 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 }