JOC API

/yade/transfer/order

POST

sends parametrisized order information for "resume order" dialog

Parameters in the POST body schema

Name	Type	Description	Example
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`transferId`	required; integer	The id of a YADE transfer	42
`fileIds`	optional; array	The ids of files. If this parameter undefined or empty then all files of the transfer are considered	[3,5,81]

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": "modify transfer",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.yade.ModifyTransfer",
    "type": "object",
    "required": [
        "jobschedulerId",
        "transferId"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "transferId": {
            "type": "number",
            "format": "utc-millisec",
            "minimum": 0
        },
        "fileIds": {
            "type": "array",
            "items": {
                "type": "number",
                "format": "utc-millisec",
                "minimum": 0
            }
        }
    }
}

Responses

Code	Description	Body
200		application/json model \| example { "title": "order with delivery date (volatile part)", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.order.OrderV200", "type": "object", "required": [ "deliveryDate", "order" ], "properties": { "deliveryDate": { "description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "order": { "javaType": "com.sos.joc.model.order.OrderV", "type": "object", "allOf": [{ "description": "compact=true then ONLY path, id, jobChain, _type, surveyDate, state, processingState, runTimeIsTemporary, job(except blacklisted orders) are required and only title, processedBy, configurationStatus are optional", "required": [ "path", "orderId", "jobChain", "surveyDate", "state", "processingState", "_type", "runTimeIsTemporary" ] }, { "oneOf": [{ "description": "pending order", "required": [ "nextStartTime" ] }, { "description": "running order", "required": [ "historyId", "startedAt", "taskId", "inProcessSince" ] }, { "description": "suspended, waitingForResource, blacklist order", "required": [ "historyId", "startedAt" ] }, { "description": "setback order", "required": [ "historyId", "startedAt", "setback" ] }] }], "properties": { "path": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "orderId": { "type": "string" }, "jobChain": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "priority": { "type": "integer", "minimum": 0 }, "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).)$" } } } }, "_type": { "javaType": "com.sos.joc.model.order.OrderType", "type": "string", "description": "the type of the order", "enum": [ "PERMANENT", "AD_HOC", "FILE_ORDER" ] }, "surveyDate": { "description": "Current date of the JobScheduler Master/Agent. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "state": { "description": "the name of the node", "type": "string" }, "title": { "type": "string" }, "job": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "stateText": { "type": "string" }, "configurationStatus": { "javaType": "com.sos.joc.model.common.ConfigurationState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "description": "4=ok; 5=replacement_is_standing_by,removing_delayed; 2=error_in_configuration_file,changed_file_not_loaded,resource_is_missing", "type": "integer" }, "_text": { "javaType": "com.sos.joc.model.common.ConfigurationStateText", "type": "string", "enum": [ "ERROR_IN_CONFIGURATION_FILE", "CHANGED_FILE_NOT_LOADED", "REMOVING_DELAYED", "RESOURCE_IS_MISSING", "REPLACEMENT_IS_STANDING_BY", "OK" ] }, "message": { "description": "contains e.g. error message", "type": "string" } } }, "endState": { "description": "the name of the end node", "type": "string" }, "processingState": { "javaType": "com.sos.joc.model.order.OrderState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "description": "0=running, 4=active, 3=initialized, 2=under_construction/stopped/not_initialized", "type": "integer" }, "_text": { "javaType": "com.sos.joc.model.order.OrderStateText", "type": "string", "enum": [ "PENDING", "RUNNING", "SUSPENDED", "SETBACK", "BLACKLIST", "JOB_NOT_IN_PERIOD", "NODE_DELAY", "WAITING_FOR_LOCK", "WAITING_FOR_PROCESS", "WAITING_FOR_AGENT", "JOB_CHAIN_STOPPED", "NODE_STOPPED", "JOB_STOPPED", "WAITING_FOR_TASK" ] }, "manually": { "type": "boolean" } } }, "nextStartTime": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "nextStartNever": { "type": "boolean" }, "historyId": { "description": "for all orders except pending orders", "type": "string" }, "startedAt": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "processedBy": { "description": "ONLY for running or blacklist order, contains Host/port of an active cluster member or URL of a JobScheduler Agent", "type": "string" }, "taskId": { "description": "ONLY for running order", "type": "string" }, "inProcessSince": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "setback": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "lock": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "processClass": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "runTimeIsTemporary": { "type": "boolean", "default": false }, "documentation": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 } } } } }
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 'order'	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	'order' 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": "order failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "order 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 }