JOC API

/inventory/changes

POST

shows one or more changes

Parameters in the POST body schema

"lastPublishedBy": {

Name	Type	Description	Example	Default
`names`	optional, array	An array of names (string) of changes to receive information for.	"names" : ["myFirstChange"] }
`states`	optional, array	The states to filter the results. If no states are set all states will be considered.	"states" : ["OPEN","CLOSED"]
`owner`	optional, string	Filter for the owner of the given change.
`lastPublishedBy`	optional, string	Filter for the account the change was last published by.
`created`	optional, object	filter for changes being created in the specified timespan.
`from`	required, string	allowed formats are: ISO format yyyy-mm-dd HH:MM[:SS] now now + HH:MM[:SS] now + SECONDS
`to`	required, string	allowed formats are: ISO format yyyy-mm-dd HH:MM[:SS] now now + HH:MM[:SS] now + SECONDS
`modified`	optional, object	filter for changes being modified in the specified timespan.
`from`	required, string	allowed formats are: ISO format yyyy-mm-dd HH:MM[:SS] now now + HH:MM[:SS] now + SECONDS
`to`	required, string	allowed formats are: ISO format yyyy-mm-dd HH:MM[:SS] now now + HH:MM[:SS] now + SECONDS
`closed`	optional, object	filter for changes being closed in the specified timespan.
`from`	required, string	allowed formats are: ISO format yyyy-mm-dd HH:MM[:SS] now now + HH:MM[:SS] now + SECONDS
`to`	required, string	allowed formats are: ISO format yyyy-mm-dd HH:MM[:SS] now now + HH:MM[:SS] now + SECONDS
`details`	optional, boolean	A switch to receive additional details about items assigned to the change.		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": "changes",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.inventory.changes.ShowChangesFilter",
    "type": "object",
    "properties": {
        "names": {
            "type": "array",
            "uniqueItems": true,
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 100
            }
        },
        "states": {
            "type": "array",
            "uniqueItems": true,
            "items": {
                "javaType": "com.sos.joc.model.inventory.changes.common.ChangeState",
                "type": "string",
                "enum": [
                    "OPEN",
                    "CLOSED",
                    "PUBLISHED"
                ]
            }
        },
        "owner": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "lastPublishedBy": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "created": {
            "javaType": "com.sos.joc.model.inventory.changes.common.Timespan",
            "type": "object",
            "required": [
                "from"
            ],
            "properties": {
                "from": {
                    "description": "ISO format yyyy-mm-dd HH:MM[:SS] or now or now + HH:MM[:SS] or now + SECONDS or empty",
                    "type": "string",
                    "pattern": "^(now(\\s*\\+\\s*(\\d{1,2}:\\d{1,2}(:\\d{1,2})?|\\d+)?)?||never|\\d{4}-\\d{2}-\\d{2}\\s\\d{1,2}:\\d{1,2}(:\\d{1,2})?)$"
                },
                "to": {
                    "description": "ISO format yyyy-mm-dd HH:MM[:SS] or now or now + HH:MM[:SS] or now + SECONDS or empty",
                    "type": "string",
                    "pattern": "^(now(\\s*\\+\\s*(\\d{1,2}:\\d{1,2}(:\\d{1,2})?|\\d+)?)?||never|\\d{4}-\\d{2}-\\d{2}\\s\\d{1,2}:\\d{1,2}(:\\d{1,2})?)$"
                }
            },
            "additionalProperties": false
        },
        "modified": {
            "javaType": "com.sos.joc.model.inventory.changes.common.Timespan",
            "type": "object",
            "required": [
                "from"
            ],
            "properties": {
                "from": {
                    "description": "ISO format yyyy-mm-dd HH:MM[:SS] or now or now + HH:MM[:SS] or now + SECONDS or empty",
                    "type": "string",
                    "pattern": "^(now(\\s*\\+\\s*(\\d{1,2}:\\d{1,2}(:\\d{1,2})?|\\d+)?)?||never|\\d{4}-\\d{2}-\\d{2}\\s\\d{1,2}:\\d{1,2}(:\\d{1,2})?)$"
                },
                "to": {
                    "description": "ISO format yyyy-mm-dd HH:MM[:SS] or now or now + HH:MM[:SS] or now + SECONDS or empty",
                    "type": "string",
                    "pattern": "^(now(\\s*\\+\\s*(\\d{1,2}:\\d{1,2}(:\\d{1,2})?|\\d+)?)?||never|\\d{4}-\\d{2}-\\d{2}\\s\\d{1,2}:\\d{1,2}(:\\d{1,2})?)$"
                }
            },
            "additionalProperties": false
        },
        "closed": {
            "javaType": "com.sos.joc.model.inventory.changes.common.Timespan",
            "type": "object",
            "required": [
                "from"
            ],
            "properties": {
                "from": {
                    "description": "ISO format yyyy-mm-dd HH:MM[:SS] or now or now + HH:MM[:SS] or now + SECONDS or empty",
                    "type": "string",
                    "pattern": "^(now(\\s*\\+\\s*(\\d{1,2}:\\d{1,2}(:\\d{1,2})?|\\d+)?)?||never|\\d{4}-\\d{2}-\\d{2}\\s\\d{1,2}:\\d{1,2}(:\\d{1,2})?)$"
                },
                "to": {
                    "description": "ISO format yyyy-mm-dd HH:MM[:SS] or now or now + HH:MM[:SS] or now + SECONDS or empty",
                    "type": "string",
                    "pattern": "^(now(\\s*\\+\\s*(\\d{1,2}:\\d{1,2}(:\\d{1,2})?|\\d+)?)?||never|\\d{4}-\\d{2}-\\d{2}\\s\\d{1,2}:\\d{1,2}(:\\d{1,2})?)$"
                }
            },
            "additionalProperties": false
        },
        "details": {
            "type": "boolean",
            "default": false
        }
    },
    "additionalProperties": false
}

{ "names": [ "myFirstChange" ], "details": true }

{
    "names": [
        "myFirstChange"
    ],
    "details": true
}

Responses

Code	Description	Body
200		application/json model \| example { "title": "changes", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.inventory.changes.ShowChangesResponse", "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" }, "changes": { "type": "array", "items": { "javaType": "com.sos.joc.model.inventory.changes.common.Change", "type": "object", "extends": { "javaType": "com.sos.joc.model.inventory.changes.common.ChangeIdentifier", "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "pattern": "^[^<>]$", "maxLength": 100 }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "state": { "javaType": "com.sos.joc.model.inventory.changes.common.ChangeState", "type": "string", "enum": [ "OPEN", "CLOSED", "PUBLISHED" ] } }, "additionalProperties": false }, "required": [ "name" ], "properties": { "created": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "modified": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "closed": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "owner": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "lastPublishedBy": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "configurations": { "type": "array", "uniqueItems": true, "items": { "javaType": "com.sos.joc.model.inventory.changes.common.ChangeItem", "type": "object", "required": [ "name", "objectType" ], "properties": { "name": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "objectType": { "javaType": "com.sos.joc.model.inventory.common.ConfigurationType", "type": "string", "enum": [ "FOLDER", "WORKFLOW", "JOBCLASS", "JOBRESOURCE", "LOCK", "NOTICEBOARD", "FILEORDERSOURCE", "WORKINGDAYSCALENDAR", "NONWORKINGDAYSCALENDAR", "SCHEDULE", "INCLUDESCRIPT", "JOBTEMPLATE", "DEPLOYMENTDESCRIPTOR", "DESCRIPTORFOLDER" ] }, "valid": { "type": "boolean", "default": false }, "deployed": { "type": "boolean", "default": false }, "released": { "type": "boolean", "default": false } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } { "deliveryDate": "2024-10-22T12:23:31.651+00:00", "changes": [{ "created": "2024-09-17T13:11:47.000+00:00", "modified": "2024-09-17T13:11:47.000+00:00", "owner": "root", "configurations": [{ "name": "wf_lock_test", "path": "/2024/misc/wf_lock_test", "objectType": "WORKFLOW", "valid": true, "deployed": false, "released": false }, { "name": "wf_fos_test", "path": "/2024/misc/wf_fos_test", "objectType": "WORKFLOW", "valid": true, "deployed": true, "released": false }, { "name": "wf_total_test", "path": "/2024/misc/wf_total_test", "objectType": "WORKFLOW", "valid": true, "deployed": false, "released": false }, { "name": "wf_test", "path": "/2024/misc/wf_test", "objectType": "WORKFLOW", "valid": true, "deployed": false, "released": false }, { "name": "wf_test_2_expect", "path": "/2024/misc/wf_test_2_expect", "objectType": "WORKFLOW", "valid": true, "deployed": true, "released": false }, { "name": "wf_aoi_test", "path": "/2024/misc/wf_aoi_test", "objectType": "WORKFLOW", "valid": true, "deployed": false, "released": false }, { "name": "wf_jt_job", "path": "/2024/misc/wf_jt_job", "objectType": "WORKFLOW", "valid": true, "deployed": false, "released": false }], "name": "myFirstChange", "title": "this is my first change", "state": "OPEN" }] } { "deliveryDate": "2024-10-22T12:23:31.651+00:00", "changes": [{ "created": "2024-09-17T13:11:47.000+00:00", "modified": "2024-09-17T13:11:47.000+00:00", "owner": "root", "configurations": [{ "name": "wf_lock_test", "path": "/2024/misc/wf_lock_test", "objectType": "WORKFLOW", "valid": true, "deployed": false, "released": false }, { "name": "wf_fos_test", "path": "/2024/misc/wf_fos_test", "objectType": "WORKFLOW", "valid": true, "deployed": true, "released": false }, { "name": "wf_total_test", "path": "/2024/misc/wf_total_test", "objectType": "WORKFLOW", "valid": true, "deployed": false, "released": false }, { "name": "wf_test", "path": "/2024/misc/wf_test", "objectType": "WORKFLOW", "valid": true, "deployed": false, "released": false }, { "name": "wf_test_2_expect", "path": "/2024/misc/wf_test_2_expect", "objectType": "WORKFLOW", "valid": true, "deployed": true, "released": false }, { "name": "wf_aoi_test", "path": "/2024/misc/wf_aoi_test", "objectType": "WORKFLOW", "valid": true, "deployed": false, "released": false }, { "name": "wf_jt_job", "path": "/2024/misc/wf_jt_job", "objectType": "WORKFLOW", "valid": true, "deployed": false, "released": false }], "name": "myFirstChange", "title": "this is my first change", "state": "OPEN" }] }
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 'changes'	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	'changes' 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": "changes failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "changes 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 }