Maintenance outage for upgrade on Sunday, September 22

This site, docs.bmc.com, will be inaccessible for two hours starting at 8 AM CDT, Sunday, September 22, for a platform upgrade.

 
 

Important

   

Starting from version 8.9.03, BMC Network Automation is renamed to TrueSight Network Automation. This space contains information about TrueSight Network Automation 8.9.03 and the later service packs for 8.9. For earlier releases, see BMC Network Automation 8.9.

TrueSight Network Automation 8.9 ... Developing Using the REST API Endpoints in the REST API v3.0

External Event Filters API

TrueSight Network Automation REST API – Version 3.0 -- External Event Filters
The base URL for the API is:

https://serverName:portNumber/bca-networks/api

Note

The create, retrieve, update, and delete operations are supported on the external event filters only if the event source is Syslog.

GET /v3.0/external_event_filters
 Retrieves external event filters, matching any filter criteria
Parameters

Name

Located in

Description

Default

Schema

orderBy

query

Sort by the specified attribute (name, enabledFlag, eventTypeName, or a listable external event filter dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending)

"+name"

string
Enum: [
  "+name",
  "-name",
  "+enabledFlag",
  "-enabledFlag",
  "+eventTypeName",
  "-eventTypeName"
]

offset

query

Return the specified page number

1

integer

limit

query

Define the number of rows in a page or the maximum number of external event filters to return

25

integer

Authorization

header

Authorization token formatted as 'Bearer [token]'

String *

Responses

Code

Description

Schema

200

Successful operation

[
   #ExternalEventFilterDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access external event filters

500

Internal server error: Unexpected exception occurred

POST /v3.0/external_event_filters
 Adds a new external event filter
Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new external event filter

#ExternalEventFilterDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'

String *

Responses

Code

Description

Schema

201

Created: New external event filter successfully added

400

Bad request: Input external event filter DTO is missing or new external event filter is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to add a new external event filter

500

Internal server error: Unexpected exception occurred

GET /v3.0/external_event_filters/{nameOrKey}
 Retrieves one external event filter either by name or by database key
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the external event filter of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'

String *

Responses

Code

Description

Schema

200

successful operation

#ExternalEventFilterDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access external event filters

404

Not found: No single matching external event filter found

500

Internal server error: Unexpected exception occurred

PUT /v3.0/external_event_filters/{nameOrKey}
 Modifies all attributes of an existing external event filter
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the external event filter to be modified

string *

body

body

Complete new attribute values for the external event filter; anything left out will be considered to be null and will be nulled out in the external event filter

#ExternalEventFilterDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'

String *

Responses

Code

Description

Schema

200

successful operation

#ExternalEventFilterDTO

400

Bad request: Input external event filter DTO is missing or modified external event filter is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to modify the external event filter

404

Not found: No single matching external event filter found

500

Internal server error: Unexpected exception occurred

DELETE /v3.0/external_event_filters/{nameOrKey}
 Deletes an external event filter
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the external event filter to be deleted

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'

String *

Responses

Code

Description

Schema

200

Successful operation

string

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to delete the external event filter

404

Not found: No single matching external event filter found

500

Internal server error: Unexpected exception occurred

PATCH /v3.0/external_event_filters/{nameOrKey}
 Modifies only the specified attributes of an existing external event filter, where the changes are specified in JSON Patch format (per RFC 6902)
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the external event filter to be modified

string *

body

body

New attribute values for the external event filter, in JSON Patch format

#JsonPatch

Authorization

header

Authorization token formatted as 'Bearer [token]'

String *

Responses

Code

Description

Schema

200

Successful operation

#ExternalEventFilterDTO

400

Bad request: Input JSON patch information is missing or modified external event filter is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to modify the external event filter

404

Not found: No single matching external event filter found

500

Internal server error: Unexpected exception occurred

Object Definitions

Object

Schema

DynamicFieldValueDTO

 A dynamic field value

{
     id: string
     The database key of the dynamic field whose value this is (read-only)
 
     name: string
     The name of the dynamic field (read-only)
 
     values: [
       The value(s) for the dynamic field; for a single-value field, only the first entry is relevant; read-only for Auto Derived and Configuration Profiled types
 
       string
     ]
 
     dynamicFieldDetailsLink: string
     Link to get more detailed information about the dynamic field (read-only)
}

ExternalEventFilterDTO

 Information about an external event filter that matches received syslog messages

{
     id: string
     The external event filter's unique database key (read-only)
 
     name: string *
     The external event filter's unique display name
 
     enabledFlag: boolean
     Whether or not the filter is enabled; when false, the filter is ignored; when true, the filter is matched against all received syslog messages
 
     eventTypeId: integer *
     The event that is logged when an incoming syslog message matches this filter; must be an event in the External category
 
     eventTypeName: string
     The meaning of the numeric eventTypeId
 
     filters: [
       Regular expressions to match against the text of received syslog messages; when a match is made, the specified event is logged; if the syslog message contains a username, enclose that part of the regular expression in parentheses, to track external changes back to the originating user; ordered such that more specific regular expressions match before less specific ones, so that a username can be parsed out of similarly formatted messages; when no regular expressions are specified, then all syslog messages will match
 
       string
     ]
 
     incomingSyslogSeverityIds: [
       One or more severities to match against the severity of received syslog messages
 
       integer
     ] *
 
     dynamicFields: [
       The dynamic fields
 
       #DynamicFieldValueDTO
     ]
}

JsonPatch

 A list of JSON Patch operations

[
     A list of JSON Patch operations
 
     #JsonPatch.OneOperation
   ]

JsonPatch.OneOperation

JsonPatch.Pointer

 Pointer or path to an element or property

string
   Pointer or path to an element or property

JsonPatch.Add

 Add a value to an object or inserts it into an array. In the case of an array, the value is inserted before the given index. The - character can be used instead of an index to insert at the end of an array. The value can be any JSON value.

{
     op: string *
    Enum: [
      "add"
    ]
     value: any *
     path: #JsonPatch.Pointer *
}

JsonPatch.Remove

 Remove a value from an object or array.

{
     op: string *
    Enum: [
      "remove"
    ]
     path: #JsonPatch.Pointer *
}

JsonPatch.Replace

 Replace an existing value. The value can be any JSON value.

{
     op: string *
    Enum: [
      "replace"
    ]
     value: any *
     path: #JsonPatch.Pointer *
}

JsonPatch.Move

 Move a value from one location to the other. "path" is the destination.

{
     op: string *
    Enum: [
      "move"
    ]
     path: #JsonPatch.Pointer *
     from: #JsonPatch.Pointer *
}

JsonPatch.Copy

 Copy a value from one location to another. "path" is the destination.

{
     op: string *
    Enum: [
      "copy"
    ]
     path: #JsonPatch.Pointer *
     from: #JsonPatch.Pointer *
}

JsonPatch.Test

 Test that the specified value is set in the document at the specified path. If the test fails, then the patch as a whole is not applied. The Value can be any JSON value.

{
     op: string *
    Enum: [
      "test"
    ]
     value: any *
     path: #JsonPatch.Pointer *
}

Was this page helpful? Yes No Submitting... Thank you
Last modified by Sulekha Gulati on Oct 09, 2018

Comments

Event Receivers API
External Links API
© Copyright 2013 - 2019 BMC Software, Inc.
Legal notices

Powered by Atlassian Confluence and Scroll Viewport

© Copyright 2005-2019 BMC Software, Inc.