Create a Journal Entry
post
/api/event/EventJournals
Creates a new journal entry for a specified event.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
EventID: integer
The ID of the event the new journal entry will be attached to.
-
Events: array
Events
A comma-separated list of EventIDs. The API action should apply to all Events, if it is passed in.
-
JournalEntry: string
The text of the journal entry.
Nested Schema : Events
Type:
array
A comma-separated list of EventIDs. The API action should apply to all Events, if it is passed in.
Show Source
Nested Schema : items
Type:
object
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Added record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The properties of the new journal entry.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : eventEventJournalsRead
Type:
Show Source
object
-
JournalEntry: string
The text of the journal entry.Example:
Event Acknowledged
-
JournalID: integer
Journal IDExample:
251
-
JournalTimeStamp: string
Timestamp when the journal entry was created.Example:
2022-11-06T11:17:48.000Z
-
JournalUsername: string
Name of the user that created the journal entry.Example:
admin
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object