JOC API

/jobstreams/start

POST

Start job streams identified by the job stream starter name.

Parameters in the POST body schema

Name	Type	Description	Example
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`jobstreamStarters`	required, Object	List of job stream starters that should be started	[{"name":"Test", "params":[{"name":"param1","value":"new value of param1"},{"name":"param2","value":"new value of param2"}]}]
`starterName`	optional (one of starterName and jobStreamStarterId is required), String	The starter that have this name wil be started.	myName
`jobStreamStarterId`	optional (one of starterName and jobStreamStarterId is required), String	The starter that have id this name wil be started.	4711
`params`	optional, Object	A list of name value pairs.	[{"name":"param1","value":"new value of param1"},{"name":"param2","value":"new value of param2"}]
`jobStream`	optional, string	>To put the jobStream name into the audit log	myJobStream
`auditLog`	optional, object	Object which contains `comment`, `timeSpent` and `ticketLink`.	{ "comment":"It was not really necessary!", "timeSpent":2 }
`comment`	optional, string	Field in `auditLog` to comment this action, e.g. the reason.
`timeSpent`	optional, string	Field in `auditLog` to enter the time spent in minutes.	5
`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

access_token*

Request requires authentication! This header is deprecated. Please use X-Access-Token

550e8400-e29b-11d4-a716-446655440000

string

Body

application/json

model | example

{
    "title": "JobStream Starters",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "description": "List of all JobStream Starters",
    "javaType": "com.sos.joc.model.jobstreams.JobStreamStartersSelector",
    "type": "object",
    "required": [
        "jobschedulerId"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "jobStream": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "jobstreamStarters": {
            "type": "array",
            "items": {
                "description": "List of all jobStream starters",
                "javaType": "com.sos.joc.model.jobstreams.JobStreamStartData",
                "type": "object",
                "properties": {
                    "jobStreamStarterId": {
                        "type": "number",
                        "format": "utc-millisec",
                        "minimum": 0
                    },
                    "starterName": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "params": {
                        "type": "array",
                        "items": {
                            "javaType": "com.sos.joc.model.common.NameValuePair",
                            "type": "object",
                            "required": [
                                "name",
                                "value"
                            ],
                            "properties": {
                                "name": {
                                    "type": "string",
                                    "pattern": "^[^<>]*$",
                                    "maxLength": 255
                                },
                                "value": {
                                    "type": "string",
                                    "pattern": "^(?s)((?!<script( |>)|<svg/on).)*$"
                                }
                            }
                        }
                    }
                }
            }
        },
        "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
                }
            }
        }
    }
}

{ "jobschedulerId": "scheduler_joc_cockpit", "jobstreamStarters": [{ "starterName": "Test", "params": [{ "name": "param1", "value": "new value of param1" }, { "name": "param2", "value": "new value of param2" }] }] }

{
    "jobschedulerId": "scheduler_joc_cockpit",
    "jobstreamStarters": [{
        "starterName": "Test",
        "params": [{
            "name": "param1",
            "value": "new value of param1"
        }, {
            "name": "param2",
            "value": "new value of param2"
        }]
    }]
}

Responses

Code	Description	Body
200		application/json model \| example { "title": "JobStream Starters", "$schema": "http://json-schema.org/draft-04/schema#", "description": "List of all JobStream Starters", "javaType": "com.sos.joc.model.jobstreams.JobStreamStartersStarted", "type": "object", "required": [ "jobschedulerId" ], "properties": { "deliveryDate": { "description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "jobschedulerId": { "type": "string", "pattern": "^[^/\\<>?:\"\|]$", "maxLength": 100 }, "jobstreamStarted": { "type": "array", "items": { "description": "Reset Workflow, unconsume expressions", "javaType": "com.sos.joc.model.jobstreams.JobStreamStarted", "type": "object", "required": [ "jobschedulerId" ], "properties": { "jobStreamStarterId": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "starterName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "starterExists": { "type": "boolean" }, "session": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "params": { "type": "array", "items": { "javaType": "com.sos.joc.model.common.NameValuePair", "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "value": { "type": "string", "pattern": "^(?s)((?!<script( \|>)\|<svg/on).)$" } } } } } } } } }
401	Unauthorized!	application/json model \| example { "title": "security", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "hasRole": { "type": "boolean", "default": false }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Oops!", "hasRole": false, "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Oops!", "hasRole": false, "isAuthenticated": false, "isPermitted": false }
403	Forbidden! The user doesn't have sufficient permissions for 'start'	application/json model \| example { "title": "security", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "hasRole": { "type": "boolean", "default": false }, "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 ...", "hasRole": false, "isAuthenticated": true, "isPermitted": false } { "user": "root", "message": "You don't have sufficient permissions for ...", "hasRole": false, "isAuthenticated": true, "isPermitted": false }
420	'start' 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": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "surveyDate": { "description": "is also required for permanent or volatile requests", "type": "string", "format": "date-time" }, "error": { "javaType": "com.sos.joc.model.common.Err", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255 }, "message": { "type": "string" } } } } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "start failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "start failed!" } }
440	Login Timeout! The client's session has expired and must log in again.	application/json model \| example { "title": "security", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "hasRole": { "type": "boolean", "default": false }, "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", "hasRole": false, "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Session has expired. Please log in again", "hasRole": false, "isAuthenticated": false, "isPermitted": false }