JOC API

/yade/transfers

POST

Gets file transfers

Parameters in the POST body schema

Name	Type	Description	Example	Default
`controllerId`	optional, string	Controller ID	myController
`compact`	optional, boolean	A compact response is returned if this parameter is true		false
`dateFrom`	optional, string	The value has multiple formats Filters items starting from a date. an ISO 8601 date format with the time offset and milliseconds being 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 period relative to the current time, e.g. 6h, 12h, 1d, 1w that specifies the quantity followed by a qualifier: 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 also be specified with the parameter `timeZone` if `timeZone` is undefined then UTC is used the value 0 indicates the current time	1d
`dateTo`	optional, string	The value has multiple formats similiar to the `dateFrom` parameter Filters items ending before a date.	0
`timeZone`	optional, string	If this parameter is set then it beats the time offset in `dateFrom` and `dateTo` See the list for available time zones.	Europe/Berlin
`operations`	optional, array	Limits result to specified operations COPY MOVE GETLIST RENAME	["COPY"]
`states`	optional, array	Limits result to states SUCCESS FAILED INCOMPLETE	["SUCCESS"]
`sources`	optional, array	Limits result to source host and/or protocol	[{ "host": "localhost", "protocol": "SFTP" }]
`targets`	optional, array	Limits result to target host and/or protocol	[{ "host": "localhost" }]
`profiles`	optional, array[string]	Limits result to a specified glob pattern of configuration profiles that supports '' and '?' as wildcards where : match zero or more characters ? : match any single character	[ "copy-per-SFTP-from-HostA-to-HostB", "copy-per-SFTP-from-HostA-to-HostC" ]
`sourceFiles`	optional, array[string]	Limits result to a specified glob pattern of source files that supports '' and '?' as wildcards where : match zero or more characters ? : match any single character	"testsource"
`targetFiles`	optional, array[string]	Limits result to a specified glob pattern of target files that supports '' and '?' as wildcards where : match zero or more characters ? : match any single character	"my*targetfile"
`workflowNames`	optional, array[string]	Limits result to a specified glob pattern of workflow names that supports '' and '?' as wildcards where : match zero or more characters ? : match any single character	"my*workflow"
`limit`	optional, integer	Limits the number of resulting items, -1=unlimited	5000	10000

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": "file transfer filter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.yade.TransferFilter",
    "type": "object",
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "compact": {
            "description": "controls if the object's data is compact or detailed",
            "type": "boolean",
            "default": false
        },
        "regex": {
            "description": "regular expression to filter Controller objects by matching the path",
            "type": "string"
        },
        "profiles": {
            "type": "array",
            "items": {
                "description": "pattern with wildcards '*' and '?' where '*' match zero or more characters and '?' match any single character",
                "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",
                    "UNKNOWN"
                ]
            }
        },
        "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": {
            "description": "see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones",
            "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
        },
        "sources": {
            "type": "array",
            "items": {
                "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
                    }
                }
            }
        },
        "targets": {
            "type": "array",
            "items": {
                "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
                    }
                }
            }
        },
        "sourceFiles": {
            "type": "array",
            "items": {
                "description": "pattern with wildcards '*' and '?' where '*' match zero or more characters and '?' match any single character",
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255
            }
        },
        "targetFiles": {
            "type": "array",
            "items": {
                "description": "pattern with wildcards '*' and '?' where '*' match zero or more characters and '?' match any single character",
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255
            }
        },
        "workflowNames": {
            "type": "array",
            "items": {
                "description": "pattern with wildcards '*' and '?' where '*' match zero or more characters and '?' match any single character",
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255
            }
        }
    },
    "additionalProperties": false
}

{ "controllerId": "testsuite", "limit": 5000, "dateFrom": "-7d", "timeZone": "Europe/Berlin" }

{
    "controllerId": "testsuite",
    "limit": 5000,
    "dateFrom": "-7d",
    "timeZone": "Europe/Berlin"
}

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": "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": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "transfers": { "type": "array", "items": { "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 } } } } } } { "deliveryDate": "2021-06-09T08:25:04.202Z", "transfers": [{ "_operation": "MOVE", "controllerId": "testsuite", "end": "2021-05-27T21:40:17Z", "error": {}, "historyId": 358062, "id": 1, "job": "transferFile", "jobPosition": "0", "numOfFiles": 1, "orderId": "#2021-05-27#F1622151608-pdfFilesCsv:4.csv", "profile": "product_demo_to_demo_file_path_sftp", "source": { "account": ".", "host": "agent-2-0-primary", "port": 0, "protocol": "LOCAL" }, "start": "2021-05-27T21:40:15Z", "state": { "_text": "SUCCESSFUL", "severity": 6 }, "surveyDate": "2021-05-27T21:40:17Z", "target": { "account": "sos", "host": "centostest_primary.sos", "port": 22, "protocol": "SFTP" }, "workflowPath": "/pdwWatchFileAndTransferFile" }, { "_operation": "MOVE", "controllerId": "testsuite", "end": "2021-05-27T21:40:17Z", "error": {}, "historyId": 358063, "id": 2, "job": "transferFile", "jobPosition": "0", "numOfFiles": 1, "orderId": "#2021-05-27#F1622151608-pdfFilesCsv:3.csv", "profile": "product_demo_to_demo_file_path_sftp", "source": { "account": ".", "host": "agent-2-0-primary", "port": 0, "protocol": "LOCAL" }, "start": "2021-05-27T21:40:15Z", "state": { "_text": "SUCCESSFUL", "severity": 6 }, "surveyDate": "2021-05-27T21:40:17Z", "target": { "account": "sos", "host": "centostest_primary.sos", "port": 22, "protocol": "SFTP" }, "workflowPath": "/pdwWatchFileAndTransferFile" }, { "_operation": "MOVE", "controllerId": "testsuite", "end": "2021-05-27T21:40:17Z", "error": {}, "historyId": 358064, "id": 3, "job": "transferFile", "jobPosition": "0", "numOfFiles": 1, "orderId": "#2021-05-27#F1622151608-pdfFilesCsv:2.csv", "profile": "product_demo_to_demo_file_path_sftp", "source": { "account": ".", "host": "agent-2-0-primary", "port": 0, "protocol": "LOCAL" }, "start": "2021-05-27T21:40:15Z", "state": { "_text": "SUCCESSFUL", "severity": 6 }, "surveyDate": "2021-05-27T21:40:17Z", "target": { "account": "sos", "host": "centostest_primary.sos", "port": 22, "protocol": "SFTP" }, "workflowPath": "/pdwWatchFileAndTransferFile" }, { "_operation": "MOVE", "controllerId": "testsuite", "end": "2021-05-27T21:40:17Z", "error": {}, "historyId": 358065, "id": 4, "job": "transferFile", "jobPosition": "0", "numOfFiles": 1, "orderId": "#2021-05-27#F1622151608-pdfFilesCsv:1.csv", "profile": "product_demo_to_demo_file_path_sftp", "source": { "account": ".", "host": "agent-2-0-primary", "port": 0, "protocol": "LOCAL" }, "start": "2021-05-27T21:40:15Z", "state": { "_text": "SUCCESSFUL", "severity": 6 }, "surveyDate": "2021-05-27T21:40:17Z", "target": { "account": "sos", "host": "centostest_primary.sos", "port": 22, "protocol": "SFTP" }, "workflowPath": "/pdwWatchFileAndTransferFile" }, { "_operation": "MOVE", "controllerId": "testsuite", "end": "2021-05-27T21:40:17Z", "error": {}, "hasIntervention": false, "historyId": 358066, "id": 5, "job": "transferFile", "jobPosition": "0", "numOfFiles": 1, "orderId": "#2021-05-27#F1622151608-pdfFilesCsv:5.csv", "profile": "product_demo_to_demo_file_path_sftp", "source": { "account": ".", "host": "agent-2-0-primary", "port": 0, "protocol": "LOCAL" }, "start": "2021-05-27T21:40:15Z", "state": { "_text": "SUCCESSFUL", "severity": 6 }, "surveyDate": "2021-05-27T21:40:17Z", "target": { "account": "sos", "host": "centostest_primary.sos", "port": 22, "protocol": "SFTP" }, "workflowPath": "/pdwWatchFileAndTransferFile" }] } { "deliveryDate": "2021-06-09T08:25:04.202Z", "transfers": [{ "_operation": "MOVE", "controllerId": "testsuite", "end": "2021-05-27T21:40:17Z", "error": {}, "historyId": 358062, "id": 1, "job": "transferFile", "jobPosition": "0", "numOfFiles": 1, "orderId": "#2021-05-27#F1622151608-pdfFilesCsv:4.csv", "profile": "product_demo_to_demo_file_path_sftp", "source": { "account": ".", "host": "agent-2-0-primary", "port": 0, "protocol": "LOCAL" }, "start": "2021-05-27T21:40:15Z", "state": { "_text": "SUCCESSFUL", "severity": 6 }, "surveyDate": "2021-05-27T21:40:17Z", "target": { "account": "sos", "host": "centostest_primary.sos", "port": 22, "protocol": "SFTP" }, "workflowPath": "/pdwWatchFileAndTransferFile" }, { "_operation": "MOVE", "controllerId": "testsuite", "end": "2021-05-27T21:40:17Z", "error": {}, "historyId": 358063, "id": 2, "job": "transferFile", "jobPosition": "0", "numOfFiles": 1, "orderId": "#2021-05-27#F1622151608-pdfFilesCsv:3.csv", "profile": "product_demo_to_demo_file_path_sftp", "source": { "account": ".", "host": "agent-2-0-primary", "port": 0, "protocol": "LOCAL" }, "start": "2021-05-27T21:40:15Z", "state": { "_text": "SUCCESSFUL", "severity": 6 }, "surveyDate": "2021-05-27T21:40:17Z", "target": { "account": "sos", "host": "centostest_primary.sos", "port": 22, "protocol": "SFTP" }, "workflowPath": "/pdwWatchFileAndTransferFile" }, { "_operation": "MOVE", "controllerId": "testsuite", "end": "2021-05-27T21:40:17Z", "error": {}, "historyId": 358064, "id": 3, "job": "transferFile", "jobPosition": "0", "numOfFiles": 1, "orderId": "#2021-05-27#F1622151608-pdfFilesCsv:2.csv", "profile": "product_demo_to_demo_file_path_sftp", "source": { "account": ".", "host": "agent-2-0-primary", "port": 0, "protocol": "LOCAL" }, "start": "2021-05-27T21:40:15Z", "state": { "_text": "SUCCESSFUL", "severity": 6 }, "surveyDate": "2021-05-27T21:40:17Z", "target": { "account": "sos", "host": "centostest_primary.sos", "port": 22, "protocol": "SFTP" }, "workflowPath": "/pdwWatchFileAndTransferFile" }, { "_operation": "MOVE", "controllerId": "testsuite", "end": "2021-05-27T21:40:17Z", "error": {}, "historyId": 358065, "id": 4, "job": "transferFile", "jobPosition": "0", "numOfFiles": 1, "orderId": "#2021-05-27#F1622151608-pdfFilesCsv:1.csv", "profile": "product_demo_to_demo_file_path_sftp", "source": { "account": ".", "host": "agent-2-0-primary", "port": 0, "protocol": "LOCAL" }, "start": "2021-05-27T21:40:15Z", "state": { "_text": "SUCCESSFUL", "severity": 6 }, "surveyDate": "2021-05-27T21:40:17Z", "target": { "account": "sos", "host": "centostest_primary.sos", "port": 22, "protocol": "SFTP" }, "workflowPath": "/pdwWatchFileAndTransferFile" }, { "_operation": "MOVE", "controllerId": "testsuite", "end": "2021-05-27T21:40:17Z", "error": {}, "hasIntervention": false, "historyId": 358066, "id": 5, "job": "transferFile", "jobPosition": "0", "numOfFiles": 1, "orderId": "#2021-05-27#F1622151608-pdfFilesCsv:5.csv", "profile": "product_demo_to_demo_file_path_sftp", "source": { "account": ".", "host": "agent-2-0-primary", "port": 0, "protocol": "LOCAL" }, "start": "2021-05-27T21:40:15Z", "state": { "_text": "SUCCESSFUL", "severity": 6 }, "surveyDate": "2021-05-27T21:40:17Z", "target": { "account": "sos", "host": "centostest_primary.sos", "port": 22, "protocol": "SFTP" }, "workflowPath": "/pdwWatchFileAndTransferFile" }] }
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 'transfers'	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	'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": "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": "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": "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 }