JOC API

/note/post/add

POST

Adds a post to a note and returns the updated note

Parameters in the POST body schema

Name	Type	Description	Example	Default
`name`	required, string	Object name of the configuration item
`objectType`	required, string	Object type of the configuration item. Possible value are "WORKFLOW" "JOBRESOURCE" "LOCK" "NOTICEBOARD" "FILEORDERSOURCE" "WORKINGDAYSCALENDAR" "NONWORKINGDAYSCALENDAR" "SCHEDULE" "JOBTEMPLATE" "INCLUDESCRIPT" "REPORT"
`content`	required, string	Content of a post in markdown format
`severity`	optional, string	Severity of a post. Possible value are INFO LOW NORMAL HIGH CRITICAL		NORMAL
`auditLog`	optional, object	Object that contains `comment`, `timeSpent` and `ticketLink`.	{ "comment": "Operational requirement!", "timeSpent": 2 }
`comment`	optional, string	Field in `auditLog` to comment this action, e.g. the reason.
`timeSpent`	optional, integer	Field in `auditLog` to enter the time spent in minutes.
`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

Body

application/json

model | example

{
    "title": "add post",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.note.AddPost",
    "type": "object",
    "extends": {
        "javaType": "com.sos.joc.model.note.common.ModifyRequest",
        "type": "object",
        "extends": {
            "javaType": "com.sos.joc.model.note.common.NoteIdentifier",
            "type": "object",
            "required": [
                "name",
                "objectType"
            ],
            "properties": {
                "name": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255,
                    "minLength": 1
                },
                "objectType": {
                    "javaType": "com.sos.joc.model.inventory.common.ConfigurationType",
                    "type": "string",
                    "enum": [
                        "WORKFLOW",
                        "JOBCLASS",
                        "JOBRESOURCE",
                        "LOCK",
                        "NOTICEBOARD",
                        "FILEORDERSOURCE",
                        "WORKINGDAYSCALENDAR",
                        "NONWORKINGDAYSCALENDAR",
                        "SCHEDULE",
                        "INCLUDESCRIPT",
                        "JOBTEMPLATE",
                        "REPORT"
                    ]
                }
            },
            "additionalProperties": false
        },
        "required": [
            "name",
            "objectType"
        ],
        "properties": {
            "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
                    }
                }
            }
        },
        "additionalProperties": false
    },
    "required": [
        "name",
        "objectType",
        "content"
    ],
    "properties": {
        "content": {
            "type": "string",
            "pattern": "^(?s)((?!<script( |>)|<svg/on).)*$",
            "minLength": 1
        },
        "severity": {
            "javaType": "com.sos.joc.model.note.common.Severity",
            "type": "string",
            "enum": [
                "CRITICAL",
                "HIGH",
                "NORMAL",
                "LOW",
                "INFO"
            ],
            "default": "NORMAL"
        }
    },
    "additionalProperties": false
}

{ "name": "myWorkflow", "objectType": "WORKFLOW", "content": "Hello user1!" }

{
    "name": "myWorkflow",
    "objectType": "WORKFLOW",
    "content": "Hello user1!"
}

Responses

Code	Description	Body
200	name objectType metadata created createdBy modified modifiedBy postCount participantCount severity posts (for each post) postId content severity author userName posted participants (for each participant) postCount modified userName	application/json model \| example { "title": "read note", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.note.NoteResponse", "type": "object", "extends": { "javaType": "com.sos.joc.model.note.common.Note", "type": "object", "extends": { "javaType": "com.sos.joc.model.note.common.NoteIdentifier", "type": "object", "required": [ "name", "objectType" ], "properties": { "name": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "objectType": { "javaType": "com.sos.joc.model.inventory.common.ConfigurationType", "type": "string", "enum": [ "WORKFLOW", "JOBCLASS", "JOBRESOURCE", "LOCK", "NOTICEBOARD", "FILEORDERSOURCE", "WORKINGDAYSCALENDAR", "NONWORKINGDAYSCALENDAR", "SCHEDULE", "INCLUDESCRIPT", "JOBTEMPLATE", "REPORT" ] } }, "additionalProperties": false }, "properties": { "metadata": { "javaType": "com.sos.joc.model.note.common.Metadata", "type": "object", "properties": { "created": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "createdBy": { "javaType": "com.sos.joc.model.note.common.Author", "type": "object", "properties": { "userName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 } }, "additionalProperties": false }, "modified": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "modifiedBy": { "javaType": "com.sos.joc.model.note.common.Author", "type": "object", "properties": { "userName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 } }, "additionalProperties": false }, "postCount": { "type": "integer", "minimum": 0 }, "participantCount": { "type": "integer", "minimum": 0 }, "severity": { "javaType": "com.sos.joc.model.note.common.Severity", "type": "string", "enum": [ "CRITICAL", "HIGH", "NORMAL", "LOW", "INFO" ], "default": "NORMAL" }, "displayPreferences": { "javaType": "com.sos.joc.model.note.common.DisplayPreferences", "type": "object", "properties": { "width": { "type": "integer", "minimum": 0 }, "height": { "type": "integer", "minimum": 0 } }, "additionalProperties": false } }, "additionalProperties": false }, "posts": { "type": "array", "items": { "javaType": "com.sos.joc.model.note.common.Post", "type": "object", "properties": { "postId": { "type": "integer", "minimum": 0 }, "content": { "type": "string", "pattern": "^(?s)((?!<script( \|>)\|<svg/on).)$" }, "severity": { "javaType": "com.sos.joc.model.note.common.Severity", "type": "string", "enum": [ "CRITICAL", "HIGH", "NORMAL", "LOW", "INFO" ], "default": "NORMAL" }, "author": { "javaType": "com.sos.joc.model.note.common.Author", "type": "object", "properties": { "userName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 } }, "additionalProperties": false }, "posted": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "participants": { "type": "array", "items": { "javaType": "com.sos.joc.model.note.common.Participant", "type": "object", "extends": { "javaType": "com.sos.joc.model.note.common.Author", "type": "object", "properties": { "userName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 } }, "additionalProperties": false }, "properties": { "postCount": { "type": "integer", "minimum": 0 }, "modified": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" } }, "additionalProperties": false } } }, "additionalProperties": false }, "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" } }, "additionalProperties": false } { "deliveryDate": "2025-11-13T11:30:46.964+00:00", "name": "myWorkflow", "objectType": "WORKFLOW", "metadata": { "created": "2025-11-12T11:29:06.275+00:00", "createdBy": { "userName": "user1" }, "modified": "2025-11-13T11:30:46.964+00:00", "modifiedBy": { "userName": "user2" }, "postCount": 2, "participantCount": 2, "severity": "NORMAL" }, "posts": [{ "postId": 1, "content": "Hello everyone!", "severity": "NORMAL", "author": { "userName": "user1" }, "posted": "2025-11-12T11:29:06.275+00:00" }, { "postId": 2, "content": "Hello user1!", "severity": "NORMAL", "author": { "userName": "user2" }, "posted": "2025-11-13T11:30:46.964+00:00" }], "participants": [{ "postCount": 1, "modified": "2025-11-12T11:29:06.275+00:00", "userName": "user1" }, { "postCount": 1, "modified": "2025-11-13T11:30:46.964+00:00", "userName": "user2" }] } { "deliveryDate": "2025-11-13T11:30:46.964+00:00", "name": "myWorkflow", "objectType": "WORKFLOW", "metadata": { "created": "2025-11-12T11:29:06.275+00:00", "createdBy": { "userName": "user1" }, "modified": "2025-11-13T11:30:46.964+00:00", "modifiedBy": { "userName": "user2" }, "postCount": 2, "participantCount": 2, "severity": "NORMAL" }, "posts": [{ "postId": 1, "content": "Hello everyone!", "severity": "NORMAL", "author": { "userName": "user1" }, "posted": "2025-11-12T11:29:06.275+00:00" }, { "postId": 2, "content": "Hello user1!", "severity": "NORMAL", "author": { "userName": "user2" }, "posted": "2025-11-13T11:30:46.964+00:00" }], "participants": [{ "postCount": 1, "modified": "2025-11-12T11:29:06.275+00:00", "userName": "user1" }, { "postCount": 1, "modified": "2025-11-13T11:30:46.964+00:00", "userName": "user2" }] }
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 'add'	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	'add' 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": "add failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "add failed!" } }
433	4-eyes principle: Forbidden! The user needs approval process for 'add'	application/json model \| example { "title": "FourEyesResponse", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.security.foureyes.FourEyesResponse", "type": "object", "extends": { "javaType": "com.sos.joc.model.security.foureyes.ApprovalBase", "type": "object", "properties": { "requestor": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "requestUrl": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "requestBody": { "type": "object", "javaType": "com.sos.joc.model.security.foureyes.RequestBody", "additionalProperties": true }, "category": { "javaType": "com.sos.joc.model.audit.CategoryType", "type": "string", "enum": [ "INVENTORY", "CONTROLLER", "DAILYPLAN", "OTHERS", "DEPLOYMENT", "DOCUMENTATIONS", "CERTIFICATES", "IDENTITY", "SETTINGS", "MONITORING", "UNKNOWN" ] } }, "additionalProperties": false }, "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "message": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "approvers": { "type": "array", "items": { "javaType": "com.sos.joc.model.security.foureyes.Approver", "type": "object", "required": [ "accountName", "firstName", "lastName" ], "properties": { "accountName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "firstName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 30, "minLength": 1 }, "lastName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 30, "minLength": 1 }, "email": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255 } }, "additionalProperties": false } } }, "additionalProperties": false } { "deliveryDate": "2025-05-12T21:13:35Z", "accountName": "user1", "request": "./orders/add", "requestBody": { "controllerId": "standalone", "orders": [{ "workflowPath": "myWorkflow", "scheduledFor": "now" }] }, "category": "CONTROLLER", "objectType": "WORKFLOW" "objectName": "myWorkflow", "numOfObjects": 1, "action": "add orders" } { "deliveryDate": "2025-05-12T21:13:35Z", "accountName": "user1", "request": "./orders/add", "requestBody": { "controllerId": "standalone", "orders": [{ "workflowPath": "myWorkflow", "scheduledFor": "now" }] }, "category": "CONTROLLER", "objectType": "WORKFLOW" "objectName": "myWorkflow", "numOfObjects": 1, "action": "add orders" }
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 }