Jump to

• Request
• Response

Create a Journal Entry

post

/api/event/EventJournals

Creates a new journal entry for a specified event.
The minimum required properties in the request body are:

• EventID
• JournalEntry
• JournalActor (defaults to the current user if not specified)
• JournalAction (defaults to "Manual journal entry by user" if not specified)
• ShardID (defaults to 1 if not specified, but specify it if you are using database shards)

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• EventID: integer
  The ID of the event the new journal entry will be attached to.
• Events: array Events
  A comma-separated list of event IDs. Any API action included applies to all events.
• JournalAction: string
  The action value to be used when the tool is run. It will default to the name of the tool if it is left blank.

  Example: Acknowledge
• JournalActor: string
  The actor value to be used when the tool is run. It will default to the UserID of the user running the tool if it is left blank.

  Example: John Doe
• JournalEntry: string
  The text of the journal entry.

{
    "type":"object",
    "properties":{
        "EventID":{
            "description":"The ID of the event the new journal entry will be attached to.",
            "type":"integer"
        },
        "Events":{
            "description":"A comma-separated list of event IDs. Any API action included applies to all events.",
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "JournalEntry":{
            "description":"The text of the journal entry.",
            "type":"string"
        },
        "JournalActor":{
            "description":"The actor value to be used when the tool is run. It will default to the UserID of the user running the tool if it is left blank.",
            "type":"string",
            "example":"John Doe"
        },
        "JournalAction":{
            "description":"The action value to be used when the tool is run. It will default to the name of the tool if it is left blank.",
            "type":"string",
            "example":"Acknowledge"
        }
    }
}

Nested Schema : Events

Type: array

A comma-separated list of event IDs. Any API action included applies to all events.

Show Source

• Array of: object items

{
    "description":"A comma-separated list of event IDs. Any API action included applies to all events.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
  The response body for a successful add operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The properties of the new journal entry.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/eventEventJournalsRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

Show Source

• message: string
  The response message.

  Example: Added record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful add operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The properties of the new journal entry.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the new journal entry.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/eventEventJournalsRead"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

The properties of the new journal entry.

Show Source

• Array of: object eventEventJournalsRead

{
    "description":"The properties of the new journal entry.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/eventEventJournalsRead"
    }
}

Nested Schema : eventEventJournalsRead

Type: object

Show Source

• JournalAction: string
  The action value to be used when the tool is run. It will default to the name of the tool if it is left blank.

  Example: Acknowledge
• JournalActor: string
  The actor value to be used when the tool is run. It will default to the UserID of the user running the tool if it is left blank.

  Example: John Doe
• JournalEntry: string
  The text of the journal entry.

  Example: Event Acknowledged
• JournalID: integer
  Journal ID

  Example: 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

{
    "type":"object",
    "properties":{
        "JournalID":{
            "description":"Journal ID",
            "type":"integer",
            "example":251
        },
        "JournalUsername":{
            "description":"Name of the user that created the journal entry.",
            "type":"string",
            "example":"admin"
        },
        "JournalTimeStamp":{
            "description":"Timestamp when the journal entry was created.",
            "type":"string",
            "example":"2022-11-06T11:17:48.000Z"
        },
        "JournalEntry":{
            "description":"The text of the journal entry.",
            "type":"string",
            "example":"Event Acknowledged"
        },
        "JournalActor":{
            "description":"The actor value to be used when the tool is run. It will default to the UserID of the user running the tool if it is left blank.",
            "type":"string",
            "example":"John Doe"
        },
        "JournalAction":{
            "description":"The action value to be used when the tool is run. It will default to the name of the tool if it is left blank.",
            "type":"string",
            "example":"Acknowledge"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top