v4.0 Keywords API
TrueSight Network Automation REST API – KeywordService
The base URL for the API is:
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 |
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" { |
DiscrepancyKeywordDTO | Click here to expand...Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.KeywordService$DiscrepancyKeywordDTO" { |
DynamicFieldValueDTO | Click here to expand...{ |
EventKeywordDTO | Click here to expand...Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.KeywordService$EventKeywordDTO" { |
KeywordDTO | Click here to expand...Subclasses: { |