JOC API

/yade/files

POST

Responds transferred files

Parameters in the POST body schema

Name	Type	Description	Example	Default
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`compact`	optional, boolean	Response has a compact version if this parameter is true		false
`transferIds`	optional; array of integers	The ids of YADE transfers	[4711]
`interventionTransferIds`	optional; array of integers	The id of a intervened YADE transfer	[4711]
`states`	optional, array	Filtered all YADE history item with transfer states such as UNDEFINED WAITING TRANSFERRING IN_PROGRESS TRANSFERRED SUCCESS SKIPPED FAILED ABORTED COMPRESSED NOT_OVERWRITTEN DELETED RENAMED IGNORED_DUE_TO_ZEROBYTE_CONSTRAINT SETBACK POLLING	["SUCCESS"]
`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.FilesFilter",
    "type": "object",
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "fileIds": {
            "type": "array",
            "items": {
                "type": "number",
                "format": "utc-millisec",
                "minimum": 0
            }
        },
        "transferIds": {
            "type": "array",
            "items": {
                "type": "number",
                "format": "utc-millisec",
                "minimum": 0
            }
        },
        "interventionTransferIds": {
            "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).)*$"
        },
        "states": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.yade.FileTransferStateText",
                "type": "string",
                "enum": [
                    "UNDEFINED",
                    "WAITING",
                    "TRANSFERRING",
                    "IN_PROGRESS",
                    "TRANSFERRED",
                    "SUCCESS",
                    "SKIPPED",
                    "FAILED",
                    "ABORTED",
                    "COMPRESSED",
                    "NOT_OVERWRITTEN",
                    "DELETED",
                    "RENAMED",
                    "IGNORED_DUE_TO_ZEROBYTE_CONSTRAINT",
                    "ROLLED_BACK",
                    "POLLING"
                ]
            }
        },
        "sourceFiles": {
            "type": "array",
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$"
            }
        },
        "targetFiles": {
            "type": "array",
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$"
            }
        },
        "limit": {
            "description": "only for db history urls to restrict the number of responsed records; -1=unlimited",
            "type": "integer",
            "default": 10000
        }
    }
}

Responses

Code	Description	Body
200		application/json model \| example { "title": "yade files", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.yade.TransferFiles", "type": "object", "required": [ "deliveryDate", "files" ], "properties": { "deliveryDate": { "description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "files": { "type": "array", "items": { "javaType": "com.sos.joc.model.yade.TransferFile", "type": "object", "description": "compact=true -> required fields + possibly targetPath", "required": [ "transferId", "sourcePath" ], "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 }, "transferId": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "interventionTransferId": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "state": { "javaType": "com.sos.joc.model.yade.FileTransferState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "description": "0=transferred,compressed,remaned,success 1=skipped,ignored_due_to_zerobyte_contraint,not_overwritten, 3=undefined, 2=failed,aborted,deleted, 5=waiting,transferring,in_progress,setback,polling", "type": "integer" }, "_text": { "javaType": "com.sos.joc.model.yade.FileTransferStateText", "type": "string", "enum": [ "UNDEFINED", "WAITING", "TRANSFERRING", "IN_PROGRESS", "TRANSFERRED", "SUCCESS", "SKIPPED", "FAILED", "ABORTED", "COMPRESSED", "NOT_OVERWRITTEN", "DELETED", "RENAMED", "IGNORED_DUE_TO_ZEROBYTE_CONSTRAINT", "ROLLED_BACK", "POLLING" ] } } }, "integrityHash": { "type": "string" }, "modificationDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "size": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "error": { "javaType": "com.sos.joc.model.common.Err", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255 }, "message": { "type": "string" } } }, "sourcePath": { "type": "string" }, "sourceName": { "type": "string" }, "targetPath": { "type": "string" }, "targetName": { "type": "string" } } } } } }
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 'files'	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	'files' 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": "files failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "files 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 }