JOC API

/inventory/workflows/update

POST

Updates workflows from job templates

Parameters in the POST body schema

Name	Type	Description	Example	Default
`workflowPaths`	optional, array[string]	Paths or names of workflows. The parameter `folder` is ignored if this parameter is defined.	[ "/sos/myWorkflow", "/sos/myWorkflow2" ]
`folder`	required, string	Absolute path of a folder
`recursive`	optional, boolean	reads folder recursive		false
`overwriteNotification`	optional, boolean	If true than the notification of the job template overwrites the notication of the job		false
`overwriteAdmissionTime`	optional, boolean	If true than admission time of the job template overwrites the admission time of the job		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": "Filter for Workflows updates from JobTemplates in specified folder",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.jobtemplate.propagate.WorkflowPropagateFilter",
    "type": "object",
    "extends": {
        "javaType": "com.sos.joc.model.jobtemplate.propagate.JobTemplatesPropagateBaseFilter",
        "type": "object",
        "properties": {
            "overwriteNotification": {
                "type": "boolean",
                "default": false
            },
            "overwriteAdmissionTime": {
                "type": "boolean",
                "default": false
            },
            "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
                    }
                }
            }
        },
        "additionalProperties": false
    },
    "properties": {
        "workflowPaths": {
            "type": "array",
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255,
                "minLength": 1
            }
        },
        "folder": {
            "description": "absolute path of an object.",
            "type": "string",
            "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
            "maxLength": 255,
            "minLength": 1
        },
        "recursive": {
            "type": "boolean",
            "default": false
        }
    },
    "additionalProperties": false
}

Responses

Code	Description	Body
200	The response reports the changes of the requested workflows. The report for each workflow has the following fields path state ("SKIPPED", "UPTODATE", "CHANGED", "PERMISSION_DENIED") jobs (is a map where the key is the job name. Each job report has the following fields) jobTemplateName (optional, only if the job was created by a job template) state ("SKIPPED", "UPTODATE", "CHANGED", "TEMPLATE_REFERENCE_DELETED", "PERMISSION_DENIED")	application/json model \| example { "title": "JobTemplate propagate report", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.jobtemplate.propagate.Report", "type": "object", "required": [ "deliveryDate" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "workflows": { "type": "array", "items": { "javaType": "com.sos.joc.model.jobtemplate.propagate.WorkflowReport", "type": "object", "required": [ "workflowName" ], "properties": { "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "state": { "javaType": "com.sos.joc.model.jobtemplate.propagate.JobReportState", "type": "object", "properties": { "severity": { "type": "integer", "minimum": 0 }, "_text": { "javaType": "com.sos.joc.model.jobtemplate.propagate.JobReportStateText", "type": "string", "enum": [ "SKIPPED", "UPTODATE", "CONFLICT", "CHANGED", "TEMPLATE_REFERENCE_DELETED", "PERMISSION_DENIED" ] }, "message": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false }, "jobs": { "type": "object", "javaType": "com.sos.joc.model.jobtemplate.propagate.JobReports", "additionalProperties": { "javaType": "com.sos.joc.model.jobtemplate.propagate.JobReport", "type": "object", "properties": { "jobTemplatePath": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "state": { "javaType": "com.sos.joc.model.jobtemplate.propagate.JobReportState", "type": "object", "properties": { "severity": { "type": "integer", "minimum": 0 }, "_text": { "javaType": "com.sos.joc.model.jobtemplate.propagate.JobReportStateText", "type": "string", "enum": [ "SKIPPED", "UPTODATE", "CONFLICT", "CHANGED", "TEMPLATE_REFERENCE_DELETED", "PERMISSION_DENIED" ] }, "message": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false }, "actions": { "type": "object", "javaType": "com.sos.joc.model.jobtemplate.propagate.Actions", "properties": { "addRequiredArguments": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.job.Environment", "type": "object", "additionalProperties": { "type": "string" } }, "deleteArguments": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.job.Environment", "type": "object", "additionalProperties": { "type": "string" } }, "changes": { "type": "array", "items": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255, "minLength": 1 } } }, "additionalProperties": false } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } { "deliveryDate": "2022-08-19T14:16:28.382+00:00", "workflows": [{ "path": "/oh/w1", "state": { "severity": 6, "_text": "SKIPPED" }, "jobs": { "job1": { "state": { "severity": 6, "_text": "SKIPPED", "message": "Job 'job1' is not created from a job template" } }, "job2": { "state": { "severity": 6, "_text": "SKIPPED", "message": "Job 'job2' is not created from a job template" } } } }, { "path": "/path/without/folder/permissions/wTest", "state": { "severity": 2, "_text": "PERMISSION_DENIED" }, "jobs": {} }, { "path": "/oh/w2", "state": { "severity": 6, "_text": "UPTODATE" }, "jobs": { "job1": { "state": { "severity": 6, "_text": "SKIPPED", "message": "Job 'job1' is not created from the job templates [jt1, jt3]" } }, "job2": { "jobTemplatePath": "/oh/jt1", "state": { "severity": 6, "_text": "UPTODATE", "message": "Job 'job2' is created from the job template 'jt1'. Updating the job is not necessary because version is up to date." } } } }, { "path": "/oh/w3", "state": { "severity": 2, "_text": "UPTODATE" }, "jobs": { "job1": { "state": { "severity": 6, "_text": "SKIPPED", "message": "Job 'job1' is not created from a job template" } }, "job2": { "jobTemplatePath": "/oh/jt1", "state": { "severity": 6, "_text": "UPTODATE", "message": "Job 'job2' is created from the job template 'jt1'. Updating the job is not necessary because version is up to date." } } } }, { "path": "/oh2/wJobTemplate", "state": { "severity": 5, "_text": "CHANGED" }, "jobs": { "job1": { "jobTemplatePath": "/oh/jt1", "state": { "severity": 6, "_text": "UPTODATE", "message": "Job 'job1' is created from the job template 'jt1'. Updating the job is not necessary because version is up to date." } }, "job2": { "jobTemplatePath": "/oh/jt1", "state": { "severity": 5, "_text": "CHANGED" }, "actions": { "addRequiredArguments": { "source_file": "\"\"" }, "deleteArguments": { "hello": "\"world\"" } } } } }] } { "deliveryDate": "2022-08-19T14:16:28.382+00:00", "workflows": [{ "path": "/oh/w1", "state": { "severity": 6, "_text": "SKIPPED" }, "jobs": { "job1": { "state": { "severity": 6, "_text": "SKIPPED", "message": "Job 'job1' is not created from a job template" } }, "job2": { "state": { "severity": 6, "_text": "SKIPPED", "message": "Job 'job2' is not created from a job template" } } } }, { "path": "/path/without/folder/permissions/wTest", "state": { "severity": 2, "_text": "PERMISSION_DENIED" }, "jobs": {} }, { "path": "/oh/w2", "state": { "severity": 6, "_text": "UPTODATE" }, "jobs": { "job1": { "state": { "severity": 6, "_text": "SKIPPED", "message": "Job 'job1' is not created from the job templates [jt1, jt3]" } }, "job2": { "jobTemplatePath": "/oh/jt1", "state": { "severity": 6, "_text": "UPTODATE", "message": "Job 'job2' is created from the job template 'jt1'. Updating the job is not necessary because version is up to date." } } } }, { "path": "/oh/w3", "state": { "severity": 2, "_text": "UPTODATE" }, "jobs": { "job1": { "state": { "severity": 6, "_text": "SKIPPED", "message": "Job 'job1' is not created from a job template" } }, "job2": { "jobTemplatePath": "/oh/jt1", "state": { "severity": 6, "_text": "UPTODATE", "message": "Job 'job2' is created from the job template 'jt1'. Updating the job is not necessary because version is up to date." } } } }, { "path": "/oh2/wJobTemplate", "state": { "severity": 5, "_text": "CHANGED" }, "jobs": { "job1": { "jobTemplatePath": "/oh/jt1", "state": { "severity": 6, "_text": "UPTODATE", "message": "Job 'job1' is created from the job template 'jt1'. Updating the job is not necessary because version is up to date." } }, "job2": { "jobTemplatePath": "/oh/jt1", "state": { "severity": 5, "_text": "CHANGED" }, "actions": { "addRequiredArguments": { "source_file": "\"\"" }, "deleteArguments": { "hello": "\"world\"" } } } } }] }
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 'update'	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	'update' 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": "update failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "update 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 }