JOC API

/inventory/releasables

POST

Gets releasable objects

Parameters in the POST body schema

Name	Type	Description	Example	Default
`folder`	required, string	Absolute path of a folder
`recursive`	optional, boolean	reads folder recursive		false
`objectTypes`	optional, array	Object types of releasable configuration item. Possible value are "WORKINGDAYSCALENDAR" "NONWORKINGDAYSCALENDAR" "SCHEDULE" "JOBTEMPLATE" "INCLUDESCRIPT"	["WORKINGDAYSCALENDAR", "NONWORKINGDAYSCALENDAR"]
`onlyValidObjects`	optional, boolean	Limits response to valid configurations only.		false
`withRemovedObjects`	optional, boolean	If true, result include removed configuration items		false
`withoutDrafts`	optional, boolean	'releasableVersions' array contains drafts if this parameter is false		false
`withoutReleased`	optional, boolean	'releasableVersions' array contains released items if this parameter is false		false

Request

Name

Description

Example

Type

Constraints

Default

Headers

X-Access-Token*

Request requires authentication!

550e8400-e29b-11d4-a716-446655440000

string

Body

application/json

model | example

{
    "title": "Filter Releasables",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.inventory.release.ReleasablesFilter",
    "type": "object",
    "required": [
        "folder"
    ],
    "properties": {
        "folder": {
            "description": "absolute path of an object.",
            "type": "string",
            "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
            "maxLength": 255,
            "minLength": 1
        },
        "recursive": {
            "type": "boolean",
            "default": false
        },
        "objectTypes": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.inventory.common.ConfigurationType",
                "type": "string",
                "enum": [
                    "FOLDER",
                    "WORKFLOW",
                    "JOBCLASS",
                    "JOBRESOURCE",
                    "LOCK",
                    "NOTICEBOARD",
                    "FILEORDERSOURCE",
                    "WORKINGDAYSCALENDAR",
                    "NONWORKINGDAYSCALENDAR",
                    "SCHEDULE",
                    "INCLUDESCRIPT",
                    "JOBTEMPLATE"
                ]
            }
        },
        "onlyValidObjects": {
            "type": "boolean",
            "default": false
        },
        "withRemovedObjects": {
            "type": "boolean",
            "default": false
        },
        "withoutDrafts": {
            "type": "boolean",
            "default": false
        },
        "withoutReleased": {
            "type": "boolean",
            "default": false
        }
    }
}

TODO

TODO

Responses

Code	Description	Body
200	The response contains subfolders and releasable objects. Each releasable object contains the following fields depends on the requested parameters id folder objectName objectType valid deleted released releasableVersions It is an array where the first item is the draft if the draft is valid and `withoutDrafts` == false The draft item has the fields id versionDate If `withoutReleased` == false then a further item of a previous release is included The released item has the fields id releaseId releasePath versionDate A subfolder contains the following fields id folder objectName objectType deleted	application/json model \| example { "title": "ResponseReleasables", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.inventory.release.ResponseReleasables", "type": "object", "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "name": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "folders": { "type": "array", "items": { "description": "response-releasables-schema.json" } }, "releasables": { "type": "array", "items": { "javaType": "com.sos.joc.model.inventory.release.ResponseReleasableTreeItem", "type": "object", "properties": { "id": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "folder": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "objectName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "account": { "type": "string", "pattern": "^[^<>]$", "maxLength": 100 }, "objectType": { "javaType": "com.sos.joc.model.inventory.common.ConfigurationType", "type": "string", "enum": [ "FOLDER", "WORKFLOW", "JOBCLASS", "JOBRESOURCE", "LOCK", "NOTICEBOARD", "FILEORDERSOURCE", "WORKINGDAYSCALENDAR", "NONWORKINGDAYSCALENDAR", "SCHEDULE", "INCLUDESCRIPT", "JOBTEMPLATE" ] }, "valid": { "type": "boolean" }, "deleted": { "type": "boolean" }, "released": { "type": "boolean" }, "releasableVersions": { "type": "array", "items": { "javaType": "com.sos.joc.model.inventory.release.ResponseReleasableVersion", "type": "object", "properties": { "id": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "releaseId": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "releasePath": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "versionDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" } } }, "uniqueItems": true } } }, "uniqueItems": true } } } TODO TODO
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 'releasables'	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	'releasables' 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": "releasables failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "releasables 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 }