Jump to

• Request
• Response

Get all message log entries

get

https://{your_site_interface}/opa-hub/api/12.2.39/message-log-entries

This operation will get all message log entries.

Request

Query Parameters

• expand: string
  Comma separated list of named resources to expand, or "all" to expand all
• fields: string
  Comma separated list of fields to be returned
• links: string
  Comma separated list of links to be returned, or "none" to omit links
• q: string
  A JSON object for filtering matching property values within the collection

There's no request body for this operation.

Security

• Authorization: apiKey
  Type: apiKey

  Description: Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
• oauth2_opa: oauth2
  Type: oauth2

  Description: POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The request was successfully completed.

Body ()

Root Schema : messageLogEntries

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/messageLogEntry"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object messageLogEntry

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/messageLogEntry"
    }
}

Nested Schema : messageLogEntry

Type: object

Show Source

• code: string
  Read Only: true

  The code of the log entry. See product documentation for the list of message log codes.
• connection: object messageLogEntryConnection
• date: string (date-time)
  Read Only: true

  The date and time that the log entry was created.
• deployment: object messageLogEntryDeployment
• logEntryId: integer (int64)
  Read Only: true

  The unique id for the log entry.
• message: string
  Read Only: true

  The full message of the log entry.
• origin: string
  Read Only: true

  The origin application that generated the log entry.
• type: string
  Read Only: true

  The type of the log entry.

{
    "type":"object",
    "properties":{
        "logEntryId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique id for the log entry.",
            "readOnly":true
        },
        "code":{
            "type":"string",
            "description":"The code of the log entry. See product documentation for the list of message log codes.",
            "readOnly":true
        },
        "date":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time that the log entry was created.",
            "readOnly":true
        },
        "origin":{
            "type":"string",
            "description":"The origin application that generated the log entry.",
            "readOnly":true
        },
        "type":{
            "type":"string",
            "description":"The type of the log entry.",
            "readOnly":true
        },
        "message":{
            "type":"string",
            "description":"The full message of the log entry.",
            "readOnly":true
        },
        "deployment":{
            "description":"Associated deployment.",
            "nullable":true,
            "$ref":"#/components/schemas/messageLogEntryDeployment"
        },
        "connection":{
            "description":"Associated connection.",
            "nullable":true,
            "$ref":"#/components/schemas/messageLogEntryConnection"
        }
    },
    "additionalProperties":false
}

Nested Schema : messageLogEntryConnection

Type: object

Show Source

• connectionId: integer (int64)
  Read Only: true

  The connection id
• connectionName: string
  Read Only: true

  The connection name

{
    "type":"object",
    "properties":{
        "connectionId":{
            "type":"integer",
            "format":"int64",
            "description":"The connection id",
            "readOnly":true
        },
        "connectionName":{
            "type":"string",
            "description":"The connection name",
            "readOnly":true
        }
    },
    "additionalProperties":false
}

Nested Schema : messageLogEntryDeployment

Type: object

Show Source

• deploymentId: integer (int64)
  Read Only: true

  The deployment id
• deploymentName: string
  Read Only: true

  The deployment name
• deploymentVersionId: integer (int64)
  Read Only: true

  The deployment version id

{
    "type":"object",
    "properties":{
        "deploymentId":{
            "type":"integer",
            "format":"int64",
            "description":"The deployment id",
            "readOnly":true
        },
        "deploymentName":{
            "type":"string",
            "description":"The deployment name",
            "readOnly":true
        },
        "deploymentVersionId":{
            "type":"integer",
            "format":"int64",
            "description":"The deployment version id",
            "readOnly":true
        }
    },
    "additionalProperties":false
}

Back to Top