JOC API

/yade/transfer

POST

Gets file transfer

Parameters in the POST body schema

Name	Type	Description	Example	Default
`transferId`	required; integer	The id of a YADE transfer	42
`compact`	optional, boolean	A compact response is returned if this parameter is true		false

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": "transferId",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.yade.TransferId",
    "type": "object",
    "required": [
        "transferId"
    ],
    "properties": {
        "transferId": {
            "type": "number",
            "format": "utc-millisec",
            "minimum": 0
        },
        "compact": {
            "description": "controls if the object's data is compact or detailed",
            "type": "boolean",
            "default": false
        }
    },
    "additionalProperties": false
}

Responses

Code	Description	Body
200	Each transfer can have a compact or detailed response. It depends on the parameter `compact`. The compact view has the following fields surveyDate id historyId controllerId profile state _operation workflowPath orderId job jobPosition numOfFiles start end error The detailed view has the following fields in addition to the compact view source account host port protocol target account host port protocol jump host user port protocol	application/json model \| example { "title": "save and response configuration", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.yade.Transfer", "type": "object", "description": "compact=true -> required fields + possibly numOfFiles, end, error", "required": [ "id", "surveyDate", "historyId", "controllerId", "profile", "state", "_operation", "workflowPath", "orderId", "job", "jobPosition", "start" ], "properties": { "surveyDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "id": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "profile": { "type": "string" }, "state": { "javaType": "com.sos.joc.model.yade.TransferState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "description": "0=SUCCESSFUL, 1=INCOMPLETE, 2=FAILED", "type": "integer" }, "_text": { "javaType": "com.sos.joc.model.yade.TransferStateText", "type": "string", "enum": [ "SUCCESSFUL", "FAILED", "INCOMPLETE" ] } } }, "_operation": { "description": "must have the same entries as com.sos.yade.commons.Yade.TransferOperation", "javaType": "com.sos.joc.model.yade.Operation", "type": "string", "enum": [ "UNKNOWN", "COPY", "MOVE", "GETLIST", "RENAME", "COPYTOINTERNET", "COPYFROMINTERNET", "REMOVE" ] }, "start": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "end": { "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" } } }, "source": { "javaType": "com.sos.joc.model.yade.ProtocolFragment", "type": "object", "properties": { "host": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "protocol": { "javaType": "com.sos.joc.model.yade.Protocol", "type": "string", "enum": [ "LOCAL", "FTP", "FTPS", "SFTP", "HTTP", "HTTPS", "WEBDAV", "WEBDAVS", "SMB", "UNKNOWN" ] }, "port": { "type": "integer", "minimum": 0, "maximum": 65535 }, "account": { "type": "string", "maxLength": 255 } } }, "target": { "javaType": "com.sos.joc.model.yade.ProtocolFragment", "type": "object", "properties": { "host": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "protocol": { "javaType": "com.sos.joc.model.yade.Protocol", "type": "string", "enum": [ "LOCAL", "FTP", "FTPS", "SFTP", "HTTP", "HTTPS", "WEBDAV", "WEBDAVS", "SMB", "UNKNOWN" ] }, "port": { "type": "integer", "minimum": 0, "maximum": 65535 }, "account": { "type": "string", "maxLength": 255 } } }, "jump": { "javaType": "com.sos.joc.model.yade.ProtocolFragment", "type": "object", "properties": { "host": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "protocol": { "javaType": "com.sos.joc.model.yade.Protocol", "type": "string", "enum": [ "LOCAL", "FTP", "FTPS", "SFTP", "HTTP", "HTTPS", "WEBDAV", "WEBDAVS", "SMB", "UNKNOWN" ] }, "port": { "type": "integer", "minimum": 0, "maximum": 65535 }, "account": { "type": "string", "maxLength": 255 } } }, "numOfFiles": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "controllerId": { "type": "string", "pattern": "^[^/\\<>?:\"\|]$", "maxLength": 100 }, "workflowPath": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "orderId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "job": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "jobPosition": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255 }, "historyId": { "type": "number", "format": "utc-millisec", "minimum": 0 } } }
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 'transfer'	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	'transfer' 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": "transfer failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "transfer 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 }