JOC API

/job_chain/graph

POST

IN PROGRESS! Returns the location of the job chain graph. Access to graphiz is required.

Parameters in the POST body schema

Name	Type	Description	Example	Default
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`jobChain`	required, string	Specifies the job chain by its path	/sos/reporting/Inventory
`mime`	optional, string, enum[PNG,SVG]	The graph can have different output formats.		SVG

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": "graphFilter",
    "id": "schemas/jobChain/graphFilter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.jobChain.GraphFilter",
    "type": "object",
    "required": [
        "jobschedulerId",
        "jobChain"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string"
        },
        "jobChain": {
            "id": "schemas/common/path",
            "description": "absolute path based on live folder of a JobScheduler object.",
            "type": "string",
            "pattern": "/([^/]+/)*[^/]+"
        },
        "mime": {
            "id": "schemas/common/graphMimeFilter",
            "description": "Output format of the graph",
            "javaType": "com.sos.joc.model.jobChain.GraphMime",
            "type": "string",
            "enum": [
                "PNG",
                "SVG"
            ],
            "default": "SVG"
        }
    }
}

TODO

TODO

Responses

Code	Description	Body
200	Returns the location of the job chain graph.	application/json model \| example { "title": "graph", "id": "schemas/common/graph", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.jobChain.Graph", "type": "object", "required": [ "deliveryDate", "path", "url" ], "properties": { "deliveryDate": { "id": "schemas/common/deliveryDate", "description": "Current date of the JOC server/REST service. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "path": { "id": "schemas/common/path", "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "/([^/]+/)*[^/]+" }, "url": { "description": "relative url of the generated graph image to use as src in object or image tag", "type": "string" } } } TODO TODO
401	Unauthorized!	application/json model \| example { "title": "security", "id": "schemas/user/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 'graph'	application/json model \| example { "title": "security", "id": "schemas/user/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	'graph' failed!	application/json model \| example { "title": "error object with delivery date", "id": "schemas/common/error420", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Err420", "type": "object", "required": [ "deliveryDate", "error" ], "properties": { "deliveryDate": { "id": "schemas/common/deliveryDate", "description": "Current date of the JOC server/REST service. 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": { "id": "schemas/common/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": "graph failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "graph failed!" } }
440	Login Timeout! The client's session has expired and must log in again.	application/json model \| example { "title": "security", "id": "schemas/user/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 }