Jump to

• Request
• Response
• Examples

Request Logging v2

post

/jderest/v2/log

Request to add an entry for the passed message to the AIS Server log.

Request

Supported Media Types

• application/json

Header Parameters

• jde-AIS-Auth(optional): string
  Token
• jde-AIS-Auth-Device(optional): string
  Device Name
• jde-AIS-MonitorOnStart(optional): boolean
  Monitor on Start
• jde-AIS-MonitorRequest(optional): string
  Monitor Request

  Allowed Values: [ "monitorRequest", "monitorRequestIO" ]

Body ()

The input to the logging service.

Root Schema : LogRequest

Type: object

The input to the logging service.

Show Source

• application(optional): string
  The application requesting the log entry. The application name will be written to the log entry.
• applicationVersion(optional): string
• deviceName(optional): string
  The device name to write in the log entry.
• level(optional): integer(int32)
  Allowed Values: [ 1, 2, 3, 4 ]

  The logging level for the log entry: Severe(1), Warn(2), App(3), Debug(4). The default is Debug (4).
• message(optional): string
  The message to write in the log entry.
• stringException(optional): string
• token(optional): string
  The AIS token.
• user(optional): string
  The user to write in the log entry.

{
    "type":"object",
    "properties":{
        "application":{
            "type":"string",
            "description":"The application requesting the log entry. The application name will be written to the log entry."
        },
        "user":{
            "type":"string",
            "description":"The user to write in the log entry."
        },
        "deviceName":{
            "type":"string",
            "description":"The device name to write in the log entry."
        },
        "token":{
            "type":"string",
            "description":"The AIS token."
        },
        "message":{
            "type":"string",
            "description":"The message to write in the log entry."
        },
        "level":{
            "type":"integer",
            "format":"int32",
            "description":"The logging level for the log entry: Severe(1), Warn(2), App(3), Debug(4). The default is Debug (4).",
            "enum":[
                1,
                2,
                3,
                4
            ]
        },
        "stringException":{
            "type":"string"
        },
        "applicationVersion":{
            "type":"string"
        }
    },
    "description":"The input to the logging service."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful Execution

400 Response

Bad Request - Invalid JSON Input

403 Response

Authorization Failure

415 Response

Invalid Content-Type Header - Must use application/json

444 Response

Invalid Token

Body ()

Root Schema : ServiceErrorResponse

Type: object

Error Response

Show Source

• errorText(optional): string
• exception(optional): string
  The class of the exception if an exception was thrown.
• exceptionId(optional): string
  ExceptionId, only if an exception record was written to the F980060
• message(optional): string
  Details about the error.
• status(optional): string
  Allowed Values: [ "ERROR", "WARNING" ]

  Status determined by exception handling
• timeStamp(optional): string
  The timestamp indicating the time the error message was returned.
• type(optional): string
  Optional type of error
• userDefinedErrorText(optional): string
  Optional error text added to an orchestration step.

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "description":"Details about the error."
        },
        "exception":{
            "type":"string",
            "description":"The class of the exception if an exception was thrown."
        },
        "timeStamp":{
            "type":"string",
            "description":"The timestamp indicating the time the error message was returned."
        },
        "userDefinedErrorText":{
            "type":"string",
            "description":"Optional error text added to an orchestration step."
        },
        "type":{
            "type":"string",
            "description":"Optional type of error"
        },
        "errorText":{
            "type":"string"
        },
        "exceptionId":{
            "type":"string",
            "description":"ExceptionId, only if an exception record was written to the F980060"
        },
        "status":{
            "type":"string",
            "description":"Status determined by exception handling",
            "enum":[
                "ERROR",
                "WARNING"
            ]
        }
    },
    "description":"Error Response"
}

500 Response

Server Failed to Process Request

Body ()

Root Schema : ServiceErrorResponse

Type: object

Error Response

Show Source

• errorText(optional): string
• exception(optional): string
  The class of the exception if an exception was thrown.
• exceptionId(optional): string
  ExceptionId, only if an exception record was written to the F980060
• message(optional): string
  Details about the error.
• status(optional): string
  Allowed Values: [ "ERROR", "WARNING" ]

  Status determined by exception handling
• timeStamp(optional): string
  The timestamp indicating the time the error message was returned.
• type(optional): string
  Optional type of error
• userDefinedErrorText(optional): string
  Optional error text added to an orchestration step.

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "description":"Details about the error."
        },
        "exception":{
            "type":"string",
            "description":"The class of the exception if an exception was thrown."
        },
        "timeStamp":{
            "type":"string",
            "description":"The timestamp indicating the time the error message was returned."
        },
        "userDefinedErrorText":{
            "type":"string",
            "description":"Optional error text added to an orchestration step."
        },
        "type":{
            "type":"string",
            "description":"Optional type of error"
        },
        "errorText":{
            "type":"string"
        },
        "exceptionId":{
            "type":"string",
            "description":"ExceptionId, only if an exception record was written to the F980060"
        },
        "status":{
            "type":"string",
            "description":"Status determined by exception handling",
            "enum":[
                "ERROR",
                "WARNING"
            ]
        }
    },
    "description":"Error Response"
}

Back to Top

Examples

Example Requests

Use the logging service to request to add entries to the AIS Server log. The token value is from a prior call to the token request service to establish a session.

curl -i -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/log -d
{
    "token": "044Suh8WJ2JDrtzGqb+Nkjcy6FkDuCOj3RFo+eX9ghoCxI=MDE5MDA4NTQxMDIzMzg2MjUxMDkzOTk0Mk15RGV2aWNlMTQ3ODY0MjkzODExMg==",
    "deviceName":"MyDevice",
    "application":"My Application",
    "applicationVersion":"My Application Version",
    "message": "Log My Message from Curl",
    "level": 2
}

Example Response

The log service response does not contain any body. It is always empty.

Example Entry in the AIS Server Log

The preceding request will add the following log entry to the AIS Server log.

[WARN][JDE][AIS]AIS LOG REQUEST: --Level WARN --Application: My Application--Application Version: My Application Version --User: JDE --Device Name: MyDevice --Log Message: Log My Message from Curl 

Back to Top