Space banner This version of the product is in limited support. However, the documentation is available for your convenience. You will not be able to leave comments.

v4.0 Keywords API


TrueSight Network Automation REST API – KeywordService
The base URL for the API is:

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

keywords

{{status subtle="false" colour="Blue" title="GET"/}}

 /v4.0/keywords
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

orderBy

query

Sort by the specified attribute (name, type, or a listable keyword dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending)

"+name"

string 
Enum: [
 "+name",
 "-name",
 "+type",
 "-type"
]

offset

query

Return the specified page number

1

integer

limit

query

Define the number of rows in a page or the maximum number of keywords to return

25

integer

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

401

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


403

Forbidden: Not allowed to access keywords


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Green" title="POST"/}}

 /v4.0/keywords
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new keyword


Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

201

Created: New keyword successfully added


400

Bad request: Input keyword DTO is missing or new keyword is invalid


401

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


403

Forbidden: Not allowed to add a new keyword


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Blue" title="GET"/}}

 /v4.0/keywords/{nameOrKey
}
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the keyword of interest


string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

401

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


403

Forbidden: Not allowed to access keywords


404

Not found: No single matching keyword found


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Yellow" title="PUT"/}}

 /v4.0/keywords/{nameOrKey
}
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the keyword to be modified


string *

body

body

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


Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

400

Bad request: Input keyword DTO is missing or modified keyword is invalid


401

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


403

Forbidden: Not allowed to modify the keyword


404

Not found: No single matching keyword found


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Red" title="DELETE"/}}

 /v4.0/keywords/{nameOrKey
}
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the keyword to be deleted


string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

string

400

Bad Request: Keyword is currently in use by a condition


401

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


403

Forbidden: Not allowed to delete the keyword


404

Not found: No single matching keyword found


500

Internal server error: Unexpected exception occurred



Object Definitions

Object

Schema

ChangeKeywordDTO


Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.KeywordService$ChangeKeywordDTO"

{ 
    id: string 
    The keyword's unique database key (read-only) 

     name: string * 
    The keyword's unique display name 

     type: string 
    The displayable type of this keyword (read-only) 

     dynamicFields: [ 
      The dynamic fields 

       DynamicFieldValueDTO
    ] 

     osImageFlag: boolean 
    Whether or not any change to the OS image of a device is a match 

     searchStrings: [ 
      Strings to search for in the configuration change that has occurred 

       string 
    ] * 

     trailIds: [ 
      In which configurations to look for changes, by the trail GUID 

       string 
    ] * 
}

DiscrepancyKeywordDTO


Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.KeywordService$DiscrepancyKeywordDTO"

{ 
    id: string 
    The keyword's unique database key (read-only) 

     name: string * 
    The keyword's unique display name 

     type: string 
    The displayable type of this keyword (read-only) 

     dynamicFields: [ 
      The dynamic fields 

       DynamicFieldValueDTO
    ] 

     osImageFlag: boolean 
    Whether or not a match is made when a discrepancy occurs between the current running OS image and the trusted running OS image 

     runningVsStartupFlag: boolean 
    Whether or not a match is made when a discrepancy occurs between the current running configuration and the current startup configuration 

     runningVsTrustedRunningFlag: boolean 
    Whether or not a match is made when a discrepancy occurs between the current running configuration and the trusted running configuration 

     searchStrings: [ 
      Strings to search for in the differences between the configurations 

       string 
    ] * 

     startupVsTrustedStartupFlag: boolean 
    Whether or not a match is made when a discrepancy occurs between the current startup configuration and the trusted startup configuration 
}

DynamicFieldValueDTO

Click here to expand...


{ 
    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) 
}

EventKeywordDTO

Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.KeywordService$EventKeywordDTO"

{ 
    id: string 
    The keyword's unique database key (read-only) 

     name: string * 
    The keyword's unique display name 

     type: string 
    The displayable type of this keyword (read-only) 

     dynamicFields: [ 
      The dynamic fields 

       DynamicFieldValueDTO
    ] 

     categoryId: integer * 
    The category of the events of interest 

     categoryName: string 
    The meaning of the numeric categoryId (read-only) 

     eventId: integer 
    The ID of the single type of event of interest; when a specific event is selected here, then the severityIds are null 

     eventName: string 
    The meaning of the numeric eventId (read-only) 

     searchStrings: [ 
      Strings to search for in the event's source, target, and description 

       string 
    ] 

     severityIds: [ 
      The severity of the events of interest 

       integer 
    ] 
}

KeywordDTO

Click here to expand...

Subclasses:
DiscrepancyKeywordDTO
EventKeywordDTO
ChangeKeywordDTO

{ 
    id: string 
    The keyword's unique database key (read-only) 

     name: string * 
    The keyword's unique display name 

     type: string 
    The displayable type of this keyword (read-only) 

     dynamicFields: [ 
      The dynamic fields 
 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*