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\""
}
}
}
}
}]
}
|