JobMon API Message

A message in JobMon represents a log message created during an instance of a job.

Message Schema

• _id: The unique identifier for the document. Set by MongoDB.
• instance: Reference to the instance this is a message for. OBJECTID, REQUIRED, REF=INSTANCE
• job: Reference to the job that this is a message for. OBJECTID, REQUIRED, REF=JOB
• created: The time the message was created. Set by JobMon. DATE, REQUIRED, DEFAULT=NOW
• logLevel: The level of the message. ENUM [Trace, Debug, Info, Warn, Error, Fatal], REQUIRED
• message: The error message. STRING, REQUIRED
• details: An optional detailed description of the error. As an example, for .Net this might include the type of exception, exception message, and stack trace. STRING
• source: An optional value that can be used to help identify the source of an error. Consider using a unique value for each log message to make it easier to identify and filter. STRING

GET /api/messages

This will return a list of messages. Can be used with query parameters.

Possible Errors (status 400):

• QueryError: Error returned by MongoDB due to a problem with the query.

NOTE: Use POST /api/instances/{instance._id}/logs to log messages.