JOC API

/yade/transfers

POST

Responds YADE transfers

Parameters in the POST body schema

Name	Type	Description	Example	Default
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`transferIds`	optional; array of integers	The ids of YADE transfers	[4711]
`compact`	optional, boolean	Response has a compact version if this parameter is true		false
`dateFrom`	optional, string	The value has multiple formats a format for a date in ISO 8601 format where the time offset and milliseconds are optional, e.g. YYYY-MM-DDThh:mm:ss[.s][Z (Z means +00)] YYYY-MM-DDThh:mm:ss[.s][+01:00] YYYY-MM-DDThh:mm:ss[.s][+0100] YYYY-MM-DDThh:mm:ss[.s][+01] a format for a time period in relative to the current time, e.g. 6h, 12h, 1d, 1w can specify in addition with a time offset 0 or digits followed by a letter are expected where the letter has to be: s (seconds) m (minutes) h (hours) d (days) w (weeks) M (months) y (years) a time offset is optional (e.g. 2d+02:00) it can be also specify with the parameter `timeZone` if `timeZone` undefined then UTC is used the value 0 means the current time Returns only collection items younger than this date.	1d
`dateTo`	optional, string	The value has multiple formats like the `dateFrom` parameter Return only collection items older than this date.	0
`timeZone`	optional, string	If this parameter is set then it beats the time offset in `dateFrom` and `dateTo` See here the list for available time zones.	Berlin/Europe
`operations`	optional, array	Filtered all YADE history item with operations such as COPY MOVE GETLIST RENAME	["COPY"]
`states`	optional, array	Filtered all YADE transfer items with states such as SUCCESS FAILED INCOMPLETE	["SUCCESS"]
`mandator`	optional; string	Filtered all YADE history item with the mandator
`sources`	optional, array	Filtered response by source host and/or protocol	[{ "host": "localhost", "protocol": "SFTP" }]
`targets`	optional, array	Filtered response by target host and/or protocol	[{ "host": "localhost" }]
`hasIntervention`	optional, boolean	Filters transfers which were intervened
`isIntervention`	optional, boolean	Filters transfers which are interventions
`profiles`	optional; array	Filters all transfers by a collection of specified configuration profiles.	[ "copy-per-SFTP-from-HostA-to-HostB", "copy-per-SFTP-from-HostA-to-HostC" ]
`sourceFilesRegex`	optional, string	Filtered response source files by a regular expression
`targetFilesRegex`	optional, string	Filtered response target files by a regular expression
`sourceFiles`	optional, array	Filtered response by source files. This parameter beats `sourceFilesRegex`	[ "/path/to/source" ]
`targetFiles`	optional, array	Filtered response by target files. This parameter beats `targetFilesRegex`	[ "/path/to/target" ]
`limit`	optional, integer	Restricts the number of responsed records, -1=unlimited	5000	10000

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": "yade filter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.yade.TransferFilter",
    "type": "object",
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "transferIds": {
            "type": "array",
            "items": {
                "type": "number",
                "format": "utc-millisec",
                "minimum": 0
            }
        },
        "compact": {
            "description": "controls if the object view is compact or detailed",
            "type": "boolean",
            "default": false
        },
        "regex": {
            "description": "regular expression to filter JobScheduler objects by matching the path",
            "type": "string",
            "pattern": "^((?!<script( |>)|<svg/on).)*$"
        },
        "profiles": {
            "type": "array",
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 100
            }
        },
        "mandator": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "states": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.yade.TransferStateText",
                "type": "string",
                "enum": [
                    "SUCCESSFUL",
                    "FAILED",
                    "INCOMPLETE"
                ]
            }
        },
        "operations": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.yade.Operation",
                "type": "string",
                "enum": [
                    "COPY",
                    "MOVE",
                    "GETLIST",
                    "RENAME",
                    "COPYTOINTERNET",
                    "COPYFROMINTERNET"
                ]
            }
        },
        "dateFrom": {
            "description": "0 or [number][smhdwMy] (where smhdwMy unit for second, minute, etc) or ISO 8601 timestamp",
            "type": "string",
            "pattern": "^([+-]?0|([+-]?[0-9]+[smhdwMy])+|\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}([,.]\\d{1,3})?)(Z|[+-]\\d{2}(:?\\d{2})?)?$"
        },
        "dateTo": {
            "description": "0 or [number][smhdwMy] (where smhdwMy unit for second, minute, etc) or ISO 8601 timestamp",
            "type": "string",
            "pattern": "^([+-]?0|([+-]?[0-9]+[smhdwMy])+|\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}([,.]\\d{1,3})?)(Z|[+-]\\d{2}(:?\\d{2})?)?$"
        },
        "timeZone": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "limit": {
            "description": "only for db history urls to restrict the number of responsed records; -1=unlimited",
            "type": "integer",
            "default": 10000
        },
        "hasIntervention": {
            "type": "boolean"
        },
        "isIntervention": {
            "type": "boolean"
        },
        "sources": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.yade.ProtocolFragment",
                "type": "object",
                "description": "compact=true -> only required fields",
                "required": [
                    "protocol",
                    "host"
                ],
                "properties": {
                    "host": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "protocol": {
                        "javaType": "com.sos.joc.model.yade.Protocol",
                        "type": "string",
                        "enum": [
                            "LOCAL",
                            "FTP",
                            "FTPS",
                            "SFTP",
                            "HTTP",
                            "HTTPS",
                            "WEBDAV",
                            "WEBDAVS",
                            "SMB"
                        ]
                    },
                    "port": {
                        "type": "integer",
                        "minimum": 0
                    },
                    "account": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    }
                }
            }
        },
        "targets": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.yade.ProtocolFragment",
                "type": "object",
                "description": "compact=true -> only required fields",
                "required": [
                    "protocol",
                    "host"
                ],
                "properties": {
                    "host": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "protocol": {
                        "javaType": "com.sos.joc.model.yade.Protocol",
                        "type": "string",
                        "enum": [
                            "LOCAL",
                            "FTP",
                            "FTPS",
                            "SFTP",
                            "HTTP",
                            "HTTPS",
                            "WEBDAV",
                            "WEBDAVS",
                            "SMB"
                        ]
                    },
                    "port": {
                        "type": "integer",
                        "minimum": 0
                    },
                    "account": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    }
                }
            }
        },
        "sourceFilesRegex": {
            "description": "regular expression to filter JobScheduler objects by matching the path",
            "type": "string",
            "pattern": "^((?!<script( |>)|<svg/on).)*$"
        },
        "targetFilesRegex": {
            "description": "regular expression to filter JobScheduler objects by matching the path",
            "type": "string",
            "pattern": "^((?!<script( |>)|<svg/on).)*$"
        },
        "sourceFiles": {
            "type": "array",
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$"
            }
        },
        "targetFiles": {
            "type": "array",
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$"
            }
        }
    }
}

Responses

Code	Description	Body
200	Each transfer can have a compact or detailed response. It depends on the parameter `compact`. Fix required fields are surveyDate id parent_id profile mandator state jobschedulerId _operation source host target host protocol numOfFiles start end The detailed view has the following optional fields in addition to the compact view source user port protocol target user port jump host user port protocol jobChain order job	application/json model \| example { "title": "yade history", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.yade.Transfers", "type": "object", "required": [ "deliveryDate", "transfers" ], "properties": { "deliveryDate": { "description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "transfers": { "type": "array", "items": { "javaType": "com.sos.joc.model.yade.Transfer", "type": "object", "description": "compact=true -> required fields + possibly profile, mandator, target", "required": [ "_operation", "start", "source" ], "properties": { "surveyDate": { "description": "Date of the inventory data. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "id": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "parent_id": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "profile": { "type": "string" }, "mandator": { "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": { "javaType": "com.sos.joc.model.yade.Operation", "type": "string", "enum": [ "COPY", "MOVE", "GETLIST", "RENAME", "COPYTOINTERNET", "COPYFROMINTERNET" ] }, "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", "pattern": "^[^<>]$", "maxLength": 255 }, "message": { "type": "string" } } }, "source": { "javaType": "com.sos.joc.model.yade.ProtocolFragment", "type": "object", "description": "compact=true -> only required fields", "required": [ "protocol", "host" ], "properties": { "host": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "protocol": { "javaType": "com.sos.joc.model.yade.Protocol", "type": "string", "enum": [ "LOCAL", "FTP", "FTPS", "SFTP", "HTTP", "HTTPS", "WEBDAV", "WEBDAVS", "SMB" ] }, "port": { "type": "integer", "minimum": 0 }, "account": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } } }, "target": { "javaType": "com.sos.joc.model.yade.ProtocolFragment", "type": "object", "description": "compact=true -> only required fields", "required": [ "protocol", "host" ], "properties": { "host": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "protocol": { "javaType": "com.sos.joc.model.yade.Protocol", "type": "string", "enum": [ "LOCAL", "FTP", "FTPS", "SFTP", "HTTP", "HTTPS", "WEBDAV", "WEBDAVS", "SMB" ] }, "port": { "type": "integer", "minimum": 0 }, "account": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } } }, "jump": { "javaType": "com.sos.joc.model.yade.ProtocolFragment", "type": "object", "description": "compact=true -> only required fields", "required": [ "protocol", "host" ], "properties": { "host": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "protocol": { "javaType": "com.sos.joc.model.yade.Protocol", "type": "string", "enum": [ "LOCAL", "FTP", "FTPS", "SFTP", "HTTP", "HTTPS", "WEBDAV", "WEBDAVS", "SMB" ] }, "port": { "type": "integer", "minimum": 0 }, "account": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } } }, "numOfFiles": { "type": "integer", "minimum": 0 }, "hasIntervention": { "type": "boolean", "default": "false" }, "jobschedulerId": { "type": "string" }, "orderId": { "type": "string" }, "jobChain": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "jobChainNode": { "type": "string" }, "job": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|*]+)+)$", "maxLength": 255 }, "taskId": { "type": "number", "format": "utc-millisec", "minimum": 0 } } } } } }
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 'transfers'	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	'transfers' 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": "transfers failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "transfers 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 }