JOC API

/inventory/deployment/deploy

POST

Signs and deploys objects

Parameters in the POST body schema

Name	Type	Description	Example	Default
`controllerIds`	required, array	Filter collection of JS7 Controllers, specified by their controllerId.	"controllerIds" : [ "testsuite", "standalone" ]
`addOrdersDateFrom`	optional, string	Sets the starting date for orders to be added to the daily plan. The API accepts a date in the format YYYY-MM-DD or the string 'now' to indicate to add orders starting from the time of deployment. Previously planned or submitted orders will be canceled.	"addOrdersDateFrom" : "now"
`store`	required anyOf(`store`, `delete`), object	Filter collection of deployable objects to add or update, specified by their paths and object types.	"store" : { "draftConfigurations" : [{ ...example see below... ], "deployConfigurations" : [{ ...example see below... ] }
`draftConfigurations`	required anyOf(`draftConfigurations`, `deployConfigurations`), array	An array of draft configuration of deployable objects.
`configuration`	required, object	A configuration or a Folder specified by its `path` and `objectType`. If draft configurations are specified by a folder, all draft items from the folder will be processed.	"configuration" : { "path" : "/myWorkflows/ifElseWorkflow/workflow_10", "objectType" : "WORKFLOW" }
`path`	required, string		"path" : "/myWorkflows/ifElseWorkflow/workflow_10"
`objectType`	required, string	Subset of deployable objects from the enum ConfigurationType. The subset consist of WORKFLOW, NOTICEBOARD, LOCK, FILEORDERSOURCE and FOLDER.	"objectType" : "WORKFLOW"
`recursive`	optional, boolean	Decides if a given folder should be processed recursively.	"recursive" : true	false
`deployConfigurations`	required anyOf(`draftConfigurations`, `deployConfigurations`), array	An array of deployed configuration objects.
`configuration`	required, object	An deployed configuration specified by its `path`, `objectType` and `commitId` OR a folder specified by `path` and `objectType` only. If deployed configurations are specified by a folder, all latest deployments of the items from the folder will be processed.	"configuration" : { "path" : "/myWorkflows/ifElseWorkflow/workflow_12", "objectType" : "WORKFLOW", "commitId" : "4273b6c6-c354-4fcd-afdb-2758088abe4a" }
`path`	required, string
`objectType`	required, enum	see above.
`commitId`	required, string	The `commitId` of the deployment of the deployed configuration. If no commitId is set the latest deployment of the configuration will be processed.	"commitId" : "4273b6c6-c354-4fcd-afdb-2758088abe4a"
`recursive`	optional, boolean	Decides if a given folder should be processed recursively.	"recursive" : true	false
`delete`	required anyOf(`store`, `delete`), object	Filter collection of deployed objects to delete, specified by their paths and object types. All selected objects will be deleted from all known controllers, not just from the selected ones.	"delete" : { "deployConfigurations" : [{ ...example see below... ] }
`deployConfigurations`	required, array	An array of deployed configuration objects.
`configuration`	required, object	see above.	"configuration" : { "path" : "/myWorkflows/ifElseWorkflow/workflow_12", "objectType" : "WORKFLOW", "commitId" : "4273b6c6-c354-4fcd-afdb-2758088abe4a" }
`path`	required, string
`objectType`	required, enum	see above.
`commitId`	required, string	see above.	"commitId" : "4273b6c6-c354-4fcd-afdb-2758088abe4a"
`recursive`	optional, boolean	see above.	"recursive" : true	false
`auditLog`	optional, object	Object that contains `comment`, `timeSpent` and `ticketLink`.	{ "comment": "Operational requirement!", "timeSpent": 2 }
`comment`	optional, string	Field in `auditLog` to comment this action, e.g. the reason.
`timeSpent`	optional, integer	Field in `auditLog` to enter the time spent in minutes.
`ticketLink`	optional, string	Field in `auditLog` to enter a link to a corresponding ticket.

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": "deploy",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.publish.DeployFilter",
    "type": "object",
    "anyOf": [{
        "required": [
            "controllerIds",
            "store"
        ]
    }, {
        "required": [
            "controllerIds",
            "delete"
        ]
    }],
    "properties": {
        "controllerIds": {
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "store": {
            "javaType": "com.sos.joc.model.publish.DeployablesValidFilter",
            "type": "object",
            "anyOf": [{
                "required": [
                    "draftConfigurations"
                ]
            }, {
                "required": [
                    "deployConfigurations"
                ]
            }],
            "properties": {
                "draftConfigurations": {
                    "type": "array",
                    "items": {
                        "javaType": "com.sos.joc.model.publish.Config",
                        "type": "object",
                        "required": [
                            "configuration"
                        ],
                        "properties": {
                            "configuration": {
                                "javaType": "com.sos.joc.model.publish.Configuration",
                                "type": "object",
                                "required": [
                                    "path",
                                    "objectType"
                                ],
                                "properties": {
                                    "path": {
                                        "description": "absolute path of an object.",
                                        "type": "string",
                                        "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
                                        "maxLength": 255,
                                        "minLength": 1
                                    },
                                    "objectType": {
                                        "javaType": "com.sos.joc.model.inventory.common.ConfigurationType",
                                        "type": "string",
                                        "enum": [
                                            "FOLDER",
                                            "WORKFLOW",
                                            "JOBCLASS",
                                            "JOBRESOURCE",
                                            "LOCK",
                                            "NOTICEBOARD",
                                            "FILEORDERSOURCE",
                                            "WORKINGDAYSCALENDAR",
                                            "NONWORKINGDAYSCALENDAR",
                                            "SCHEDULE",
                                            "JOB"
                                        ]
                                    },
                                    "commitId": {
                                        "type": "string",
                                        "pattern": "^[^<>]*$",
                                        "maxLength": 255
                                    },
                                    "recursive": {
                                        "type": "boolean",
                                        "default": false
                                    }
                                }
                            }
                        }
                    }
                },
                "deployConfigurations": {
                    "type": "array",
                    "items": {
                        "javaType": "com.sos.joc.model.publish.Config",
                        "type": "object",
                        "required": [
                            "configuration"
                        ],
                        "properties": {
                            "configuration": {
                                "javaType": "com.sos.joc.model.publish.Configuration",
                                "type": "object",
                                "required": [
                                    "path",
                                    "objectType"
                                ],
                                "properties": {
                                    "path": {
                                        "description": "absolute path of an object.",
                                        "type": "string",
                                        "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
                                        "maxLength": 255,
                                        "minLength": 1
                                    },
                                    "objectType": {
                                        "javaType": "com.sos.joc.model.inventory.common.ConfigurationType",
                                        "type": "string",
                                        "enum": [
                                            "FOLDER",
                                            "WORKFLOW",
                                            "JOBCLASS",
                                            "JOBRESOURCE",
                                            "LOCK",
                                            "NOTICEBOARD",
                                            "FILEORDERSOURCE",
                                            "WORKINGDAYSCALENDAR",
                                            "NONWORKINGDAYSCALENDAR",
                                            "SCHEDULE",
                                            "JOB"
                                        ]
                                    },
                                    "commitId": {
                                        "type": "string",
                                        "pattern": "^[^<>]*$",
                                        "maxLength": 255
                                    },
                                    "recursive": {
                                        "type": "boolean",
                                        "default": false
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "delete": {
            "javaType": "com.sos.joc.model.publish.DeployDeleteFilter",
            "type": "object",
            "required": [
                "deployConfigurations"
            ],
            "properties": {
                "deployConfigurations": {
                    "type": "array",
                    "items": {
                        "javaType": "com.sos.joc.model.publish.Config",
                        "type": "object",
                        "required": [
                            "configuration"
                        ],
                        "properties": {
                            "configuration": {
                                "javaType": "com.sos.joc.model.publish.Configuration",
                                "type": "object",
                                "required": [
                                    "path",
                                    "objectType"
                                ],
                                "properties": {
                                    "path": {
                                        "description": "absolute path of an object.",
                                        "type": "string",
                                        "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
                                        "maxLength": 255,
                                        "minLength": 1
                                    },
                                    "objectType": {
                                        "javaType": "com.sos.joc.model.inventory.common.ConfigurationType",
                                        "type": "string",
                                        "enum": [
                                            "FOLDER",
                                            "WORKFLOW",
                                            "JOBCLASS",
                                            "JOBRESOURCE",
                                            "LOCK",
                                            "NOTICEBOARD",
                                            "FILEORDERSOURCE",
                                            "WORKINGDAYSCALENDAR",
                                            "NONWORKINGDAYSCALENDAR",
                                            "SCHEDULE",
                                            "JOB"
                                        ]
                                    },
                                    "commitId": {
                                        "type": "string",
                                        "pattern": "^[^<>]*$",
                                        "maxLength": 255
                                    },
                                    "recursive": {
                                        "type": "boolean",
                                        "default": false
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "addOrdersDateFrom": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "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
                }
            }
        }
    }
}

{ "controllerIds": [{ "controllerId": "js7-cluster" }, { "controllerId": "standalone" }], "store": { "draftConfigurations": [{ "draftConfiguration": { "path": "/myWorkflows/ifElseWorkflow/workflow_10", "objectType": "WORKFLOW" } }, { "draftConfiguration": { "path": "/myWorkflows/ifElseWorkflow/workflow_16", "objectType": "WORKFLOW" } }], "deployConfigurations": [{ "deployConfiguration": { "path": "/myWorkflows/ifElseWorkflow/workflow_12", "objectType": "WORKFLOW", "commitId": "4273b6c6-c354-4fcd-afdb-2758088abe4a" } }] }, "delete": { "deployConfigurations": [{ "deployConfiguration": { "path": "/myWorkflows/forkJoinWorkflows/workflow_88", "objectType": "WORKFLOW" } }] } }

{
    "controllerIds": [{
        "controllerId": "js7-cluster"
    }, {
        "controllerId": "standalone"
    }],
    "store": {
        "draftConfigurations": [{
            "draftConfiguration": {
                "path": "/myWorkflows/ifElseWorkflow/workflow_10",
                "objectType": "WORKFLOW"
            }
        }, {
            "draftConfiguration": {
                "path": "/myWorkflows/ifElseWorkflow/workflow_16",
                "objectType": "WORKFLOW"
            }
        }],
        "deployConfigurations": [{
            "deployConfiguration": {
                "path": "/myWorkflows/ifElseWorkflow/workflow_12",
                "objectType": "WORKFLOW",
                "commitId": "4273b6c6-c354-4fcd-afdb-2758088abe4a"
            }
        }]
    },
    "delete": {
        "deployConfigurations": [{
            "deployConfiguration": {
                "path": "/myWorkflows/forkJoinWorkflows/workflow_88",
                "objectType": "WORKFLOW"
            }
        }]
    }
}

Responses

Code	Description	Body
200	Confirm deploy successfully	application/json model \| example { "title": "ok answer", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Ok", "type": "object", "required": [ "deliveryDate", "ok" ], "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" }, "ok": { "type": "boolean" } } } { "deliveryDate": "2020-05-05T21:13:35Z", "ok": true } { "deliveryDate": "2020-05-05T21:13:35Z", "ok": true }
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 'deploy'	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	'deploy' 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": "deploy failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "deploy 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 }