Method: connectorEvents.getFormatted

Full name: projects.locations.instances.cases.caseAlerts.connectorEvents.getFormatted

Get a formatted ConnectorEvents for a given case/alert.

HTTP request


Path parameters

Parameters
parent

string

Required. Format: projects/{project}/locations/{location}/instances/{instance}/cases/{case}/caseAlerts/{caseAlert}/connectorEvents:formatted

Request body

The request body must be empty.

Response body

Response message for GetFormattedEvent.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "payload": [
    {
      object (FormattedAlertEvent)
    }
  ]
}
Fields
payload[]

object (FormattedAlertEvent)

Output only. The formatted event.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

FormattedAlertEvent

Represents a formatted alert event.

JSON representation 
{
  "fields": [
    {
      object (FieldGroupData)
    }
  ],
  "identifier": string,
  "caseId": string,
  "alertIdentifier": string,
  "name": string,
  "product": string,
  "port": string,
  "sourceSystemName": string,
  "outcome": string,
  "time": string,
  "type": string,
  "artifactEntities": [
    string
  ]
}
Fields
fields[]

object (FieldGroupData)

Output only. The fields of the event.
identifier

string

Output only. The identifier of the event.
caseId

string (int64 format)

Output only. The case id of the event.
alertIdentifier

string

Output only. The alert identifier of the event.
name

string

Output only. The name of the event.
product

string

Output only. The product of the event.
port

string

Output only. The port of the event.
sourceSystemName

string

Output only. The source system name of the event.
outcome

string

Output only. The outcome of the event.
time

string (int64 format)

Output only. The time of the event.
type

string

Output only. The type of the event.
artifactEntities[]

string

Output only. The artifact entities of the event.

FieldGroupData

Group of fields.

JSON representation 
{
  "groupName": string,
  "items": [
    {
      object (FieldData)
    }
  ],
  "order": integer,
  "isIntegration": boolean,
  "isHighlight": boolean
}
Fields
groupName

string

Output only. The name of the group.
items[]

object (FieldData)

Output only. The items in the group.
order

integer

Output only. The order of the group.
isIntegration

boolean

Output only. Indicates if the group is an integration.
isHighlight

boolean

Output only. Indicates if the group is a highlight.

FieldData

From Siemplify.DataModel.Cases.FieldData

JSON representation 
{
  "originalName": string,
  "name": string,
  "value": string
}
Fields
originalName

string

Output only. The original name of the property.
name

string

Output only. The name of the property.
value

string

Output only. Value of the property.