get?:
  headers:
    X-Access-Token:
      description: Request requires authentication!
      type: string
      required: true
      example: 550e8400-e29b-11d4-a716-446655440000
  responses:
    401:
      description: |
        **Unauthorized!**
      body:
        application/json:
          schema: security
          example: |
            {
              "user": "root",
              "message": "Oops!",
              "isAuthenticated": false,
              "isPermitted": false
            }
    403:
      description: |
        **Forbidden!**<br/>
        The user doesn't have sufficient permissions for '<<resourcePathName>>'
      body:
        application/json:
          schema: security
          example: |
            {
              "user": "root",
              "message": "You don't have sufficient permissions for ...",
              "role": "all",
              "isAuthenticated": true,
              "isPermitted": false
            }
    420:
      description: |
        **<span style="text-transform: capitalize;"><<resourcePathName>></span> failed!**
      body:
        application/json:
          example: |
            {
              "deliveryDate": "2016-05-05T21:13:35Z",
              "surveyDate": "2016-05-05T21:13:33Z",
              "error": {
                "code": "JOC-420",
                "message": "<<resourcePathName>> failed!"
              }
            }
          schema: error420
    440:
      description: |
        **Login Timeout!**<br/>
        The client's session has expired and must log in again.
      body:
        application/json:
          example: |
            {
              "deliveryDate": "2016-05-05T21:13:35Z",
              "error": {
                "code": "AUTH-440",
                "message": "Session has expired! Please log in again."
              }
            }
          schema: error420
post?:
  headers:
    X-Access-Token:
      description: Request requires authentication!
      type: string
      required: true
      example: 550e8400-e29b-11d4-a716-446655440000
  responses:
    401:
      description: |
        **Unauthorized!**
      body:
        application/json:
          schema: security
          example: |
            {
              "account": "root",
              "callerHostName": "127.0.0.1",
              "callerIpAddress": "127.0.0.1",
              "enableTouch": true,
              "forcePasswordChange": false,
              "hasRole": false,
              "isApprovalRequestor": false,
              "isApprover": false,
              "isAuthenticated": false,
              "isPermitted": false,
              "message": "Access denied"
            }
    403:
      description: |
        **Forbidden!**<br/>
        The user doesn't have sufficient permissions for '<<resourcePathName>>'
      body:
        application/json:
          schema: security
          example: |
            {
              "accessToken": "550e8400-e29b-11d4-a716-446655440000",
              "account": "root",
              "apiCall": "./lock",
              "enableTouch": true,
              "forcePasswordChange": false,
              "hasRole": true,
              "isApprovalRequestor": false,
              "isApprover": false,
              "isAuthenticated": true,
              "isPermitted": false,
              "message": "Access denied",
              "role": "no_lock"
            }
    419?:
      description: It returns an array of _error_ items for each failed command at bulk operations.
      body:
        application/json:
          schema: errors
    420:
      description: |
        **'<span style="text-transform: capitalize;"><<resourcePathName>></span>' failed!**
      body:
        application/json:
          example: |
            {
              "deliveryDate": "2016-05-05T21:13:35Z",
              "surveyDate": "2016-05-05T21:13:33Z",
              "error": {
                "code": "JOC-420",
                "message": "<<resourcePathName>>  failed!"
              }
            }
          schema: error420
    440:
      description: |
        **Login Timeout!**<br/>
        The client's session has expired and must log in again.
      body:
        application/json:
          schema: security
          example: |
            {
              "enableTouch": true,
              "forcePasswordChange": false,
              "hasRole": false,
              "isApprovalRequestor": false,
              "isApprover": false,
              "isAuthenticated": false,
              "isPermitted": false,
              "message": "SessionNotExistException: Session is broken and no longer valid. New login is neccessary"
            }
    433:
      description: |
        **4-eyes principle: Forbidden!**<br/>
        The user needs approval process for '<<resourcePathName>>'
      body:
        application/json:
          schema: fourEyes
          example: |
            {
              "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"
            }
    434?:
      description: |
        **'<span style="text-transform: capitalize;"><<resourcePathName>></span>' failed!**
        <h3 style="color:red;">JOC GUI doesn't alert this exception</h3>
      body:
        application/json:
          example: |
            {
              "deliveryDate": "2016-05-05T21:13:35Z",
              "surveyDate": "2016-05-05T21:13:33Z",
              "error": {
                "code": "JOC-420",
                "message": "<<resourcePathName>>  failed!"
              }
            }
          schema: error420