JOC API

/plans/ids

POST

Gets plan Ids

Parameters in the POST body schema

Name	Type	Description	Example	Default
`controllerId`	required, string	Controller ID	myController
`planSchemaIds`	optional, array[string]	Filtered plans with schema id such as Global DailyPlan
`noticeSpaceKeys`	optional, array[string]	This parameter is ignored for the ‘Global’ schema because it doesn't have a plan key. Plan keys of the 'DailyPlan' schema have the format YYYY-MM-DD. Each string of the array can be a glob pattern of that supports '' and '?' as wildcards where : match zero or more characters ? : match any single character	["2025-02-*"]
`onlyOpenPlans`	optional, boolean	Limits results to open plans		false
`onlyClosedPlans`	optional, boolean	Limits results to closed plans		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": "PlansFilter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.plan.PlansFilter",
    "type": "object",
    "extends": {
        "javaType": "com.sos.joc.model.plan.PlansOpenCloseFilter",
        "type": "object",
        "required": [
            "controllerId"
        ],
        "properties": {
            "controllerId": {
                "type": "string",
                "pattern": "^[^/\\<>?:\"|*]*$",
                "maxLength": 100,
                "minLength": 1
            },
            "onlyOpenPlans": {
                "type": "boolean",
                "default": false
            },
            "onlyClosedPlans": {
                "type": "boolean",
                "default": false
            }
        },
        "additionalProperties": false
    },
    "required": [
        "controllerId"
    ],
    "properties": {
        "planSchemaIds": {
            "type": "array",
            "uniqueItems": true,
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255
            }
        },
        "noticeSpaceKeys": {
            "alias": "planKeys",
            "description": "Will be ignored for global schema because it has no plan keys",
            "type": "array",
            "uniqueItems": true,
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255
            }
        },
        "noticeBoardPaths": {
            "type": "array",
            "uniqueItems": true,
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255
            }
        },
        "compact": {
            "type": "boolean",
            "default": false
        },
        "limit": {
            "description": "-1=unlimited",
            "type": "integer",
            "default": 10000
        }
    },
    "additionalProperties": false
}

Responses

Code	Description	Body
200	The fields for each plan are planId closed numOfNoticeBoards	application/json model \| example { "title": "Plans", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.plan.Plans", "type": "object", "required": [ "deliveryDate" ], "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" }, "plans": { "type": "array", "items": { "javaType": "com.sos.joc.model.plan.Plan", "type": "object", "required": [ "planId", "closed" ], "properties": { "planId": { "javaType": "com.sos.joc.model.plan.PlanId", "type": "object", "required": [ "planSchemaId", "noticeSpaceKey" ], "properties": { "noticeSpaceKey": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "planSchemaId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 } }, "additionalProperties": false }, "closed": { "type": "boolean", "default": false }, "state": { "javaType": "com.sos.joc.model.plan.PlanState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.joc.model.plan.PlanStateText", "type": "string", "enum": [ "OPEN", "CLOSED", "FINISHED", "DELETED" ] }, "since": { "description": "since only for FINISHED state", "type": "string", "format": "date-time" } }, "additionalProperties": false }, "numOfNoticeBoards": { "type": "integer", "minimum": 0 }, "noticeBoards": { "type": "array", "items": { "javaType": "com.sos.controller.model.board.Board", "type": "object", "extends": { "javaType": "com.sos.inventory.model.board.Board", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject", "com.sos.joc.model.common.IDeployObject", "com.sos.inventory.model.common.IInventoryObject" ], "propertyOrder": [ "TYPE", "version", "boardType", "postOrderToNoticeId", "endOfLife", "expectOrderToNoticeId", "title", "documentationName" ], "description": "deploy object with fixed property 'TYPE':'Board'", "properties": { "TYPE": { "javaType": "com.sos.inventory.model.deploy.DeployType", "type": "string", "enum": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "javaEnumNames": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "default": "Workflow" }, "boardType": { "javaType": "com.sos.inventory.model.board.BoardType", "type": "string", "enum": [ "GLOBAL", "PLANNABLE" ], "default": "GLOBAL" }, "postOrderToNoticeId": { "description": "Expression that returns a NoticeId for the PostNotice statement.", "alias": "toNotice", "type": "string" }, "endOfLife": { "description": "Expression that returns for the PostNotice statement the time until when the note should be valid, expressed as number of milliseconds since 1970-01-01, 0 o'clock, UTC. Then JS7 will delete the note.", "type": "string" }, "expectOrderToNoticeId": { "description": "Expression that returns a NoticeId for the ExpectNotice statement.", "alias": "readingOrderToNoticeId", "type": "string" }, "version": { "description": "inventory repository version", "type": "string", "pattern": "[0-9]+\\.[0-9]+\\.[0-9]+", "default": "1.7.1", "maxLength": 10 }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false }, "properties": { "path": { "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" }, "state": { "javaType": "com.sos.controller.model.common.SyncState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.controller.model.common.SyncStateText", "description": "SUSPENDED, OUTSTANDING only for Workflows", "type": "string", "enum": [ "IN_SYNC", "NOT_IN_SYNC", "NOT_DEPLOYED", "SUSPENDED", "OUTSTANDING", "UNKNOWN" ] } } }, "numOfNotices": { "type": "integer", "minimum": 0 }, "numOfAnnouncements": { "type": "integer", "minimum": 0 }, "numOfPostedNotices": { "type": "integer", "minimum": 0 }, "numOfExpectedNotices": { "type": "integer", "minimum": 0 }, "numOfExpectingOrders": { "type": "integer", "minimum": 0 }, "notices": { "type": "array", "items": { "javaType": "com.sos.controller.model.board.Notice", "type": "object", "required": [ "id", "key" ], "properties": { "id": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "key": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "endOfLife": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "expectingOrders": { "type": "array", "items": { "javaType": "com.sos.joc.model.order.OrderV", "type": "object", "required": [ "orderId", "workflowId", "state" ], "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" }, "orderId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "arguments": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.common.Variables", "type": "object", "additionalProperties": true }, "workflowId": { "javaType": "com.sos.controller.model.workflow.WorkflowId", "type": "object", "required": [ "path" ], "properties": { "path": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "versionId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false }, "state": { "javaType": "com.sos.joc.model.order.OrderState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.joc.model.order.OrderStateText", "type": "string", "enum": [ "PLANNED", "PENDING", "SCHEDULED", "RUNNING", "INPROGRESS", "PROMPTING", "SUSPENDED", "FAILED", "WAITING", "BLOCKED", "CANCELLED", "FINISHED", "BROKEN", "UNKNOWN" ] }, "_reason": { "javaType": "com.sos.joc.model.order.OrderWaitingReason", "type": "string", "enum": [ "DELAYED_AFTER_ERROR", "FORKED", "EXPECTING_NOTICES", "WAITING_FOR_LOCK", "BETWEEN_CYCLES" ] } }, "additionalProperties": false }, "marked": { "javaType": "com.sos.joc.model.order.OrderMark", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.joc.model.order.OrderMarkText", "type": "string", "enum": [ "CANCELLING", "RESUMING", "SUSPENDING" ] } } }, "attachedState": { "javaType": "com.sos.controller.model.order.OrderAttachedState", "type": "object", "properties": { "TYPE": { "description": "Attaching, Attached, ...", "type": "string" }, "agentName": { "type": "string" } }, "additionalProperties": false }, "agentId": { "type": "string" }, "subagentId": { "type": "string" }, "cycleState": { "type": "object", "javaType": "com.sos.controller.model.order.OrderCycleState", "description": "set if state == BetweenCycles or processing inside a cycle", "properties": { "next": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "since": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "index": { "type": "integer" } }, "additionalProperties": false }, "retryState": { "type": "object", "javaType": "com.sos.controller.model.order.OrderRetryState", "description": "set if state == DelayedAfterError", "properties": { "next": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "attempt": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, "sleepState": { "type": "object", "javaType": "com.sos.controller.model.order.OrderSleepState", "description": "set if state == OrderSleeping", "properties": { "until": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" } }, "additionalProperties": false }, "expectedNotices": { "description": "if state._reason == EXPECTING_NOTICES", "type": "array", "items": { "type": "object", "javaType": "com.sos.controller.model.order.ExpectedNotice", "properties": { "boardName": { "alias": "boardPath", "type": "string" }, "noticeId": { "type": "string" } }, "additionalProperties": false } }, "label": { "description": "a label is only in the response if the request restricts the orders to one workflow", "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "tags": { "type": "array", "uniqueItems": true, "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "position": { "description": "Actually, each even item is a string, each odd item is an integer", "type": "array", "minItems": 1, "items": { "anyOf": [{ "type": "integer" }, { "type": "string" }] } }, "positionString": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "positionIsImplicitEnd": { "type": "boolean" }, "endPositions": { "type": "array", "items": { "anyOf": [{ "description": "Actually, each even item is a string, each odd item is an integer", "type": "array", "items": { "anyOf": [{ "type": "integer" }, { "type": "string" }] } }, { "type": "string" }] } }, "scheduledFor": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "scheduledNever": { "description": "deprecated -> is State.PENDING", "type": "boolean", "default": false }, "question": { "description": "only relevant for state PROMPTING", "type": "string" }, "lastOutcome": { "javaType": "com.sos.controller.model.common.Outcome", "type": "object", "required": [ "TYPE" ], "properties": { "TYPE": { "description": "Succeeded, Failed, Disrupted, Cancelled, Killed, TimedOut", "type": "string" }, "namedValues": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.common.Variables", "type": "object", "additionalProperties": true }, "outcome": { "description": "outcome-schema.json" } }, "additionalProperties": false }, "historicOutcome": { "description": "only for compact parameter is false", "type": "array", "items": { "type": "object", "javaType": "com.sos.controller.model.workflow.HistoricOutcome", "properties": { "position": { "description": "Actually, each even item is a string, each odd item is an integer", "type": "array", "items": { "anyOf": [{ "type": "integer" }, { "type": "string" }] } }, "outcome": { "javaType": "com.sos.controller.model.common.Outcome", "type": "object", "required": [ "TYPE" ], "properties": { "TYPE": { "description": "Succeeded, Failed, Disrupted, Cancelled, Killed, TimedOut", "type": "string" }, "namedValues": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.common.Variables", "type": "object", "additionalProperties": true }, "outcome": { "description": "outcome-schema.json" } }, "additionalProperties": false } }, "additionalProperties": false } }, "requirements": { "javaType": "com.sos.inventory.model.workflow.Requirements", "type": "object", "alias": "orderRequirements", "properties": { "parameters": { "javaType": "com.sos.inventory.model.workflow.Parameters", "type": "object", "additionalProperties": { "javaType": "com.sos.inventory.model.workflow.Parameter", "type": "object", "required": [ "type" ], "properties": { "type": { "javaType": "com.sos.inventory.model.workflow.ParameterType", "type": "string", "enum": [ "String", "Number", "Boolean", "List" ], "javaEnumNames": [ "String", "Number", "Boolean", "List" ] }, "default": { "description": "this value has to have the data type of the 'type' attribute", "anyOf": [{ "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array" }], "javaType": "java.lang.Object" }, "final": { "type": "string" }, "listParameters": { "javaType": "com.sos.inventory.model.workflow.ListParameters", "type": "object", "description": "parameters only for parameter type 'List'", "additionalProperties": { "javaType": "com.sos.inventory.model.workflow.ListParameter", "type": "object", "required": [ "type" ], "description": "parameter type only Number, Boolean or String", "properties": { "type": { "javaType": "com.sos.inventory.model.workflow.ListParameterType", "type": "string", "enum": [ "String", "Number", "Boolean" ], "javaEnumNames": [ "String", "Number", "Boolean" ] } }, "additionalProperties": false } }, "facet": { "description": "a regular expression to check the value of the parameter", "type": "string" }, "list": { "description": "enumeration of possible parameter values", "type": "array", "items": { "type": "string" } }, "message": { "description": "a message if the value doesn't match the facet", "type": "string" } }, "additionalProperties": false } }, "allowUndeclared": { "type": "boolean", "default": false } }, "additionalProperties": false }, "cyclicOrder": { "type": "object", "javaType": "com.sos.joc.model.dailyplan.CyclicOrderInfos", "properties": { "count": { "type": "integer", "minimum": 0 }, "firstOrderId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "lastOrderId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "firstStart": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "lastStart": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" } } }, "hasChildOrders": { "type": "boolean", "default": false }, "canLeave": { "description": "only relevant for state COMPLETED", "type": "boolean" }, "isContinuable": { "type": "boolean" }, "isResumable": { "type": "boolean" }, "isSuspendible": { "type": "boolean" } }, "additionalProperties": false } }, "expectingOrderIds": { "description": "is empty if expectingOrders is filled", "type": "array", "uniqueItems": true, "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 } }, "workflowTagsPerWorkflow": { "description": "a map of workflowName -> tags-array", "javaType": "com.sos.joc.model.common.WorkflowTags", "type": "object", "additionalProperties": { "type": "array", "uniqueItems": true, "items": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255 } } }, "state": { "javaType": "com.sos.controller.model.board.NoticeState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.controller.model.board.NoticeStateText", "type": "string", "enum": [ "POSTED", "EXPECTED", "ANNOUNCED" ] } }, "additionalProperties": false } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false }
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 'ids'	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	'ids' 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": "ids failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "ids 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 }