JOC API

/calendars/import

POST

Imports Calendar export file (see ./calendars/export)

Parameters in the POST body schema

Name	Type	Description	Example
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`calendars`	required, object	Calendars object
`auditLog`	optional, object	Object which contains `comment`, `timeSpent` and `ticketLink`.	{ "comment":"It was not really necessary!", "timeSpent":2 }
`comment`	optional, string	Field in `auditLog` to comment this action, e.g. the reason.
`timeSpent`	optional, string	Field in `auditLog` to enter the time spent in minutes.	5
`ticketLink`	optional, string	Field in `auditLog` to enter a link to a corresponding ticket.

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": "calendarImportFilter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.calendar.CalendarImportFilter",
    "type": "object",
    "required": [
        "jobschedulerId"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "calendars": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.calendar.Calendar",
                "type": "object",
                "properties": {
                    "id": {
                        "type": "number",
                        "format": "utc-millisec",
                        "minimum": 0
                    },
                    "path": {
                        "description": "absolute path based on live folder of a JobScheduler object.",
                        "type": "string",
                        "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
                        "maxLength": 255
                    },
                    "name": {
                        "type": "string",
                        "pattern": "^[^/\\<>?:\"|*]*$",
                        "maxLength": 255
                    },
                    "basedOn": {
                        "description": "absolute path based on live folder of a JobScheduler object.",
                        "type": "string",
                        "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
                        "maxLength": 255
                    },
                    "documentation": {
                        "description": "absolute path based on live folder of a JobScheduler object.",
                        "type": "string",
                        "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
                        "maxLength": 255
                    },
                    "type": {
                        "javaType": "com.sos.joc.model.calendar.CalendarType",
                        "type": "string",
                        "enum": [
                            "WORKING_DAYS",
                            "NON_WORKING_DAYS",
                            "JOB",
                            "ORDER",
                            "SCHEDULE"
                        ],
                        "default": "WORKING_DAYS"
                    },
                    "category": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "title": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "from": {
                        "description": "ISO date YYYY-MM-DD",
                        "type": "string",
                        "format": "date"
                    },
                    "to": {
                        "description": "ISO date YYYY-MM-DD",
                        "type": "string",
                        "format": "date"
                    },
                    "periods": {
                        "type": "array",
                        "items": {
                            "javaType": "com.sos.joc.model.calendar.Period",
                            "type": "object",
                            "properties": {
                                "singleStart": {
                                    "type": "string",
                                    "pattern": "^[0-9:]*$"
                                },
                                "begin": {
                                    "type": "string",
                                    "pattern": "^[0-9:]*$"
                                },
                                "end": {
                                    "type": "string",
                                    "pattern": "^[0-9:]*$"
                                },
                                "repeat": {
                                    "type": "string",
                                    "pattern": "^[0-9:]*$"
                                },
                                "absoluteRepeat": {
                                    "type": "string",
                                    "pattern": "^[0-9:]*$"
                                },
                                "whenHoliday": {
                                    "type": "string",
                                    "pattern": "^[^<>]*$",
                                    "maxLength": 255
                                }
                            }
                        }
                    },
                    "includes": {
                        "javaType": "com.sos.joc.model.calendar.Frequencies",
                        "type": "object",
                        "properties": {
                            "dates": {
                                "type": "array",
                                "items": {
                                    "description": "ISO date YYYY-MM-DD",
                                    "type": "string",
                                    "format": "date"
                                }
                            },
                            "weekdays": {
                                "type": "array",
                                "items": {
                                    "javaType": "com.sos.joc.model.calendar.WeekDays",
                                    "type": "object",
                                    "required": [
                                        "days"
                                    ],
                                    "properties": {
                                        "from": {
                                            "description": "ISO date YYYY-MM-DD",
                                            "type": "string",
                                            "format": "date"
                                        },
                                        "to": {
                                            "description": "ISO date YYYY-MM-DD",
                                            "type": "string",
                                            "format": "date"
                                        },
                                        "days": {
                                            "type": "array",
                                            "items": {
                                                "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)",
                                                "type": "integer",
                                                "minimum": 0,
                                                "maximum": 7
                                            }
                                        }
                                    }
                                }
                            },
                            "monthdays": {
                                "type": "array",
                                "items": {
                                    "javaType": "com.sos.joc.model.calendar.MonthDays",
                                    "type": "object",
                                    "properties": {
                                        "from": {
                                            "description": "ISO date YYYY-MM-DD",
                                            "type": "string",
                                            "format": "date"
                                        },
                                        "to": {
                                            "description": "ISO date YYYY-MM-DD",
                                            "type": "string",
                                            "format": "date"
                                        },
                                        "days": {
                                            "type": "array",
                                            "items": {
                                                "description": "digit from 1-31",
                                                "type": "integer",
                                                "minimum": 1,
                                                "maximum": 31
                                            }
                                        },
                                        "weeklyDays": {
                                            "type": "array",
                                            "items": {
                                                "javaType": "com.sos.joc.model.calendar.WeeklyDay",
                                                "type": "object",
                                                "properties": {
                                                    "day": {
                                                        "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)",
                                                        "type": "integer",
                                                        "minimum": 0,
                                                        "maximum": 7
                                                    },
                                                    "weekOfMonth": {
                                                        "type": "integer",
                                                        "minimum": 1,
                                                        "maximum": 5
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            "ultimos": {
                                "type": "array",
                                "items": {
                                    "javaType": "com.sos.joc.model.calendar.MonthDays",
                                    "type": "object",
                                    "properties": {
                                        "from": {
                                            "description": "ISO date YYYY-MM-DD",
                                            "type": "string",
                                            "format": "date"
                                        },
                                        "to": {
                                            "description": "ISO date YYYY-MM-DD",
                                            "type": "string",
                                            "format": "date"
                                        },
                                        "days": {
                                            "type": "array",
                                            "items": {
                                                "description": "digit from 1-31",
                                                "type": "integer",
                                                "minimum": 1,
                                                "maximum": 31
                                            }
                                        },
                                        "weeklyDays": {
                                            "type": "array",
                                            "items": {
                                                "javaType": "com.sos.joc.model.calendar.WeeklyDay",
                                                "type": "object",
                                                "properties": {
                                                    "day": {
                                                        "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)",
                                                        "type": "integer",
                                                        "minimum": 0,
                                                        "maximum": 7
                                                    },
                                                    "weekOfMonth": {
                                                        "type": "integer",
                                                        "minimum": 1,
                                                        "maximum": 5
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            "months": {
                                "type": "array",
                                "items": {
                                    "javaType": "com.sos.joc.model.calendar.Months",
                                    "type": "object",
                                    "required": [
                                        "months"
                                    ],
                                    "properties": {
                                        "months": {
                                            "type": "array",
                                            "items": {
                                                "type": "integer",
                                                "minimum": 1,
                                                "maximum": 12
                                            }
                                        },
                                        "from": {
                                            "description": "ISO date YYYY-MM-DD",
                                            "type": "string",
                                            "format": "date"
                                        },
                                        "to": {
                                            "description": "ISO date YYYY-MM-DD",
                                            "type": "string",
                                            "format": "date"
                                        },
                                        "weekdays": {
                                            "type": "array",
                                            "items": {
                                                "javaType": "com.sos.joc.model.calendar.WeekDays",
                                                "type": "object",
                                                "required": [
                                                    "days"
                                                ],
                                                "properties": {
                                                    "from": {
                                                        "description": "ISO date YYYY-MM-DD",
                                                        "type": "string",
                                                        "format": "date"
                                                    },
                                                    "to": {
                                                        "description": "ISO date YYYY-MM-DD",
                                                        "type": "string",
                                                        "format": "date"
                                                    },
                                                    "days": {
                                                        "type": "array",
                                                        "items": {
                                                            "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)",
                                                            "type": "integer",
                                                            "minimum": 0,
                                                            "maximum": 7
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "monthdays": {
                                            "type": "array",
                                            "items": {
                                                "javaType": "com.sos.joc.model.calendar.MonthDays",
                                                "type": "object",
                                                "properties": {
                                                    "from": {
                                                        "description": "ISO date YYYY-MM-DD",
                                                        "type": "string",
                                                        "format": "date"
                                                    },
                                                    "to": {
                                                        "description": "ISO date YYYY-MM-DD",
                                                        "type": "string",
                                                        "format": "date"
                                                    },
                                                    "days": {
                                                        "type": "array",
                                                        "items": {
                                                            "description": "digit from 1-31",
                                                            "type": "integer",
                                                            "minimum": 1,
                                                            "maximum": 31
                                                        }
                                                    },
                                                    "weeklyDays": {
                                                        "type": "array",
                                                        "items": {
                                                            "javaType": "com.sos.joc.model.calendar.WeeklyDay",
                                                            "type": "object",
                                                            "properties": {
                                                                "day": {
                                                                    "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)",
                                                                    "type": "integer",
                                                                    "minimum": 0,
                                                                    "maximum": 7
                                                                },
                                                                "weekOfMonth": {
                                                                    "type": "integer",
                                                                    "minimum": 1,
                                                                    "maximum": 5
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "ultimos": {
                                            "type": "array",
                                            "items": {
                                                "javaType": "com.sos.joc.model.calendar.MonthDays",
                                                "type": "object",
                                                "properties": {
                                                    "from": {
                                                        "description": "ISO date YYYY-MM-DD",
                                                        "type": "string",
                                                        "format": "date"
                                                    },
                                                    "to": {
                                                        "description": "ISO date YYYY-MM-DD",
                                                        "type": "string",
                                                        "format": "date"
                                                    },
                                                    "days": {
                                                        "type": "array",
                                                        "items": {
                                                            "description": "digit from 1-31",
                                                            "type": "integer",
                                                            "minimum": 1,
                                                            "maximum": 31
                                                        }
                                                    },
                                                    "weeklyDays": {
                                                        "type": "array",
                                                        "items": {
                                                            "javaType": "com.sos.joc.model.calendar.WeeklyDay",
                                                            "type": "object",
                                                            "properties": {
                                                                "day": {
                                                                    "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)",
                                                                    "type": "integer",
                                                                    "minimum": 0,
                                                                    "maximum": 7
                                                                },
                                                                "weekOfMonth": {
                                                                    "type": "integer",
                                                                    "minimum": 1,
                                                                    "maximum": 5
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            "holidays": {
                                "type": "array",
                                "items": {
                                    "javaType": "com.sos.joc.model.calendar.Holidays",
                                    "type": "object",
                                    "properties": {
                                        "nationalCalendar": {
                                            "type": "string",
                                            "pattern": "^[^<>]*$",
                                            "maxLength": 255
                                        },
                                        "dates": {
                                            "type": "array",
                                            "items": {
                                                "description": "ISO date YYYY-MM-DD",
                                                "type": "string",
                                                "format": "date"
                                            }
                                        }
                                    }
                                }
                            },
                            "repetitions": {
                                "type": "array",
                                "items": {
                                    "javaType": "com.sos.joc.model.calendar.Repetition",
                                    "type": "object",
                                    "required": [
                                        "repetition"
                                    ],
                                    "properties": {
                                        "from": {
                                            "description": "ISO date YYYY-MM-DD",
                                            "type": "string",
                                            "format": "date"
                                        },
                                        "to": {
                                            "description": "ISO date YYYY-MM-DD",
                                            "type": "string",
                                            "format": "date"
                                        },
                                        "repetition": {
                                            "javaType": "com.sos.joc.model.calendar.RepetitionText",
                                            "type": "string",
                                            "enum": [
                                                "DAILY",
                                                "WEEKLY",
                                                "MONTHLY",
                                                "YEARLY"
                                            ]
                                        },
                                        "step": {
                                            "type": "integer",
                                            "minimum": 1,
                                            "default": 1
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "excludes": {
                        "javaType": "com.sos.joc.model.calendar.Frequencies",
                        "type": "object",
                        "properties": {
                            "dates": {
                                "type": "array",
                                "items": {
                                    "description": "ISO date YYYY-MM-DD",
                                    "type": "string",
                                    "format": "date"
                                }
                            },
                            "weekdays": {
                                "type": "array",
                                "items": {
                                    "javaType": "com.sos.joc.model.calendar.WeekDays",
                                    "type": "object",
                                    "required": [
                                        "days"
                                    ],
                                    "properties": {
                                        "from": {
                                            "description": "ISO date YYYY-MM-DD",
                                            "type": "string",
                                            "format": "date"
                                        },
                                        "to": {
                                            "description": "ISO date YYYY-MM-DD",
                                            "type": "string",
                                            "format": "date"
                                        },
                                        "days": {
                                            "type": "array",
                                            "items": {
                                                "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)",
                                                "type": "integer",
                                                "minimum": 0,
                                                "maximum": 7
                                            }
                                        }
                                    }
                                }
                            },
                            "monthdays": {
                                "type": "array",
                                "items": {
                                    "javaType": "com.sos.joc.model.calendar.MonthDays",
                                    "type": "object",
                                    "properties": {
                                        "from": {
                                            "description": "ISO date YYYY-MM-DD",
                                            "type": "string",
                                            "format": "date"
                                        },
                                        "to": {
                                            "description": "ISO date YYYY-MM-DD",
                                            "type": "string",
                                            "format": "date"
                                        },
                                        "days": {
                                            "type": "array",
                                            "items": {
                                                "description": "digit from 1-31",
                                                "type": "integer",
                                                "minimum": 1,
                                                "maximum": 31
                                            }
                                        },
                                        "weeklyDays": {
                                            "type": "array",
                                            "items": {
                                                "javaType": "com.sos.joc.model.calendar.WeeklyDay",
                                                "type": "object",
                                                "properties": {
                                                    "day": {
                                                        "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)",
                                                        "type": "integer",
                                                        "minimum": 0,
                                                        "maximum": 7
                                                    },
                                                    "weekOfMonth": {
                                                        "type": "integer",
                                                        "minimum": 1,
                                                        "maximum": 5
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            "ultimos": {
                                "type": "array",
                                "items": {
                                    "javaType": "com.sos.joc.model.calendar.MonthDays",
                                    "type": "object",
                                    "properties": {
                                        "from": {
                                            "description": "ISO date YYYY-MM-DD",
                                            "type": "string",
                                            "format": "date"
                                        },
                                        "to": {
                                            "description": "ISO date YYYY-MM-DD",
                                            "type": "string",
                                            "format": "date"
                                        },
                                        "days": {
                                            "type": "array",
                                            "items": {
                                                "description": "digit from 1-31",
                                                "type": "integer",
                                                "minimum": 1,
                                                "maximum": 31
                                            }
                                        },
                                        "weeklyDays": {
                                            "type": "array",
                                            "items": {
                                                "javaType": "com.sos.joc.model.calendar.WeeklyDay",
                                                "type": "object",
                                                "properties": {
                                                    "day": {
                                                        "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)",
                                                        "type": "integer",
                                                        "minimum": 0,
                                                        "maximum": 7
                                                    },
                                                    "weekOfMonth": {
                                                        "type": "integer",
                                                        "minimum": 1,
                                                        "maximum": 5
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            "months": {
                                "type": "array",
                                "items": {
                                    "javaType": "com.sos.joc.model.calendar.Months",
                                    "type": "object",
                                    "required": [
                                        "months"
                                    ],
                                    "properties": {
                                        "months": {
                                            "type": "array",
                                            "items": {
                                                "type": "integer",
                                                "minimum": 1,
                                                "maximum": 12
                                            }
                                        },
                                        "from": {
                                            "description": "ISO date YYYY-MM-DD",
                                            "type": "string",
                                            "format": "date"
                                        },
                                        "to": {
                                            "description": "ISO date YYYY-MM-DD",
                                            "type": "string",
                                            "format": "date"
                                        },
                                        "weekdays": {
                                            "type": "array",
                                            "items": {
                                                "javaType": "com.sos.joc.model.calendar.WeekDays",
                                                "type": "object",
                                                "required": [
                                                    "days"
                                                ],
                                                "properties": {
                                                    "from": {
                                                        "description": "ISO date YYYY-MM-DD",
                                                        "type": "string",
                                                        "format": "date"
                                                    },
                                                    "to": {
                                                        "description": "ISO date YYYY-MM-DD",
                                                        "type": "string",
                                                        "format": "date"
                                                    },
                                                    "days": {
                                                        "type": "array",
                                                        "items": {
                                                            "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)",
                                                            "type": "integer",
                                                            "minimum": 0,
                                                            "maximum": 7
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "monthdays": {
                                            "type": "array",
                                            "items": {
                                                "javaType": "com.sos.joc.model.calendar.MonthDays",
                                                "type": "object",
                                                "properties": {
                                                    "from": {
                                                        "description": "ISO date YYYY-MM-DD",
                                                        "type": "string",
                                                        "format": "date"
                                                    },
                                                    "to": {
                                                        "description": "ISO date YYYY-MM-DD",
                                                        "type": "string",
                                                        "format": "date"
                                                    },
                                                    "days": {
                                                        "type": "array",
                                                        "items": {
                                                            "description": "digit from 1-31",
                                                            "type": "integer",
                                                            "minimum": 1,
                                                            "maximum": 31
                                                        }
                                                    },
                                                    "weeklyDays": {
                                                        "type": "array",
                                                        "items": {
                                                            "javaType": "com.sos.joc.model.calendar.WeeklyDay",
                                                            "type": "object",
                                                            "properties": {
                                                                "day": {
                                                                    "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)",
                                                                    "type": "integer",
                                                                    "minimum": 0,
                                                                    "maximum": 7
                                                                },
                                                                "weekOfMonth": {
                                                                    "type": "integer",
                                                                    "minimum": 1,
                                                                    "maximum": 5
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "ultimos": {
                                            "type": "array",
                                            "items": {
                                                "javaType": "com.sos.joc.model.calendar.MonthDays",
                                                "type": "object",
                                                "properties": {
                                                    "from": {
                                                        "description": "ISO date YYYY-MM-DD",
                                                        "type": "string",
                                                        "format": "date"
                                                    },
                                                    "to": {
                                                        "description": "ISO date YYYY-MM-DD",
                                                        "type": "string",
                                                        "format": "date"
                                                    },
                                                    "days": {
                                                        "type": "array",
                                                        "items": {
                                                            "description": "digit from 1-31",
                                                            "type": "integer",
                                                            "minimum": 1,
                                                            "maximum": 31
                                                        }
                                                    },
                                                    "weeklyDays": {
                                                        "type": "array",
                                                        "items": {
                                                            "javaType": "com.sos.joc.model.calendar.WeeklyDay",
                                                            "type": "object",
                                                            "properties": {
                                                                "day": {
                                                                    "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)",
                                                                    "type": "integer",
                                                                    "minimum": 0,
                                                                    "maximum": 7
                                                                },
                                                                "weekOfMonth": {
                                                                    "type": "integer",
                                                                    "minimum": 1,
                                                                    "maximum": 5
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            "holidays": {
                                "type": "array",
                                "items": {
                                    "javaType": "com.sos.joc.model.calendar.Holidays",
                                    "type": "object",
                                    "properties": {
                                        "nationalCalendar": {
                                            "type": "string",
                                            "pattern": "^[^<>]*$",
                                            "maxLength": 255
                                        },
                                        "dates": {
                                            "type": "array",
                                            "items": {
                                                "description": "ISO date YYYY-MM-DD",
                                                "type": "string",
                                                "format": "date"
                                            }
                                        }
                                    }
                                }
                            },
                            "repetitions": {
                                "type": "array",
                                "items": {
                                    "javaType": "com.sos.joc.model.calendar.Repetition",
                                    "type": "object",
                                    "required": [
                                        "repetition"
                                    ],
                                    "properties": {
                                        "from": {
                                            "description": "ISO date YYYY-MM-DD",
                                            "type": "string",
                                            "format": "date"
                                        },
                                        "to": {
                                            "description": "ISO date YYYY-MM-DD",
                                            "type": "string",
                                            "format": "date"
                                        },
                                        "repetition": {
                                            "javaType": "com.sos.joc.model.calendar.RepetitionText",
                                            "type": "string",
                                            "enum": [
                                                "DAILY",
                                                "WEEKLY",
                                                "MONTHLY",
                                                "YEARLY"
                                            ]
                                        },
                                        "step": {
                                            "type": "integer",
                                            "minimum": 1,
                                            "default": 1
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "usedBy": {
                        "javaType": "com.sos.joc.model.calendar.UsedBy",
                        "type": "object",
                        "properties": {
                            "deliveryDate": {
                                "description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ",
                                "type": "string",
                                "format": "date-time"
                            },
                            "jobs": {
                                "type": "array",
                                "items": {
                                    "description": "absolute path based on live folder of a JobScheduler object.",
                                    "type": "string",
                                    "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
                                    "maxLength": 255
                                }
                            },
                            "orders": {
                                "type": "array",
                                "items": {
                                    "description": "absolute path based on live folder of a JobScheduler object.",
                                    "type": "string",
                                    "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
                                    "maxLength": 255
                                }
                            },
                            "schedules": {
                                "type": "array",
                                "items": {
                                    "description": "absolute path based on live folder of a JobScheduler object.",
                                    "type": "string",
                                    "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
                                    "maxLength": 255
                                }
                            }
                        }
                    }
                }
            }
        },
        "auditLog": {
            "javaType": "com.sos.joc.model.audit.AuditParams",
            "type": "object",
            "properties": {
                "comment": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                },
                "timeSpent": {
                    "type": "integer",
                    "minimum": 0
                },
                "ticketLink": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                }
            }
        }
    }
}

Responses

Code	Description	Body
200	Confirm import successfully	application/json model \| example { "title": "ok answer", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Ok", "type": "object", "required": [ "deliveryDate", "ok" ], "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" }, "ok": { "type": "boolean" } } } { "deliveryDate": "2016-05-05T21:13:35Z", "ok": true } { "deliveryDate": "2016-05-05T21:13:35Z", "ok": true }
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 'import'	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 }
419	It returns an array of error items for each failed command at bulk operations.	application/json model \| { "title": "errors", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Errs", "type": "object", "required": [ "deliveryDate", "errors" ], "properties": { "deliveryDate": { "description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "errors": { "type": "array", "items": { "javaType": "com.sos.joc.model.common.Err419", "type": "object", "required": [ "surveyDate", "path", "code", "message" ], "properties": { "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" }, "path": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|*]+)+)$", "maxLength": 255 }, "code": { "type": "string" }, "message": { "type": "string" } } } } } }
420	'import' 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": "import failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "import 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 }