JOC API

/inventory/deployable

POST

Gets deployable object

Parameters in the POST body schema

Name	Type	Description	Default
`path`	string	Path of the configuration item
`objectType`	string	Object type of the configuration item. Possible value are "WORKFLOW" "JOBRESOURCE" "LOCK" "NOTICEBOARD" "FILEORDERSOURCE"
`onlyValidObjects`	optional, boolean	Limits response to valid configurations only.	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

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 for deploy",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.inventory.deploy.DeployableFilter",
    "type": "object",
    "description": "",
    "extends": {
        "javaType": "com.sos.joc.model.inventory.common.RequestFilter",
        "type": "object",
        "anyOf": [{
            "required": [
                "id"
            ]
        }, {
            "required": [
                "path",
                "objectType"
            ]
        }],
        "properties": {
            "controllerId": {
                "type": "string",
                "pattern": "^[^/\\<>?:\"|*]*$",
                "maxLength": 100
            },
            "id": {
                "type": "number",
                "format": "utc-millisec",
                "minimum": 0
            },
            "path": {
                "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"
                ]
            },
            "auditLog": {
                "javaType": "com.sos.joc.model.audit.AuditParams",
                "type": "object",
                "properties": {
                    "comment": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "timeSpent": {
                        "type": "integer",
                        "minimum": 0
                    },
                    "ticketLink": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    }
                }
            }
        }
    },
    "anyOf": [{
        "required": [
            "id"
        ]
    }, {
        "required": [
            "path",
            "objectType"
        ]
    }],
    "properties": {
        "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
        }
    }
}

TODO

TODO

Responses

Code	Description	Body
200	A deployabable object contains following fields depends on the requested parameters id folder objectName objectType valid deleted deployed deployablesVersions 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	application/json model \| example { "title": "ResponseDeployable", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.inventory.deploy.ResponseDeployable", "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" }, "deployable": { "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 } } } } } 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 'deployable'	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	'deployable' 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": "deployable failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "deployable 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 }