Bots From Extension: cisco-bpa
Cisco BPA
This extension provides 2 bots.
Bot @cisco-bpa:query-api
Bot Position In Pipeline: Source
Get data from specified Cisco BPA API
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| path* | Text | Specify the BPA API path. ex: service-catalog/service-orders/historical-orders. | |
| api_version | Text | Specify BPA API version. (If we provide api_version param, API version input given in credential will get ignored) |
|
| pagination | Text | no | Enable pagination. Possible values are 'yes' or 'no' |
| max_result | Text | 1000 | Specify the max results that needs to be return in result of API. |
| timestamp | DateTime | Collects the data for a specified time period, supports CFXQL format. | |
| continue_on_failure | Text | no | Continue on API failure. |
| retry_count | Text | 0 | Number of times to retry on failure. |
| retry_interval | Text | 10 | Seconds to wait before retrying on failure. |
This bot also accepts wildcard parameters. Any additional name = 'value' parameters are passed to the bot.
Bot @cisco-bpa:service-orders
Bot Position In Pipeline: Source
Get or Post data using Cisco BPA service order API
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| method | Text | get | HTTP method to use. Example: GET, POST |
| payload | Text | Payload to send along with POST. Must be a JSON formatted string. | |
| orderId | Text | orderId of the service order | |
| timestamp | DateTime | Collects the data for a specified time period, supports CFXQL format. | |
| path | Text | Specify the BPA service order API path. ex: historical-orders. | |
| api_version | Text | Specify BPA API version. (If we provide api_version param, API version input given in credential will get ignored) |
|
| pagination | Text | no | Enable pagination. Possible values are 'yes' or 'no' |
| max_result | Text | 1000 | Specify the max results that needs to be return in result of API. |
| continue_on_failure | Text | no | Continue on API failure. |
| retry_count | Text | 0 | Number of times to retry on failure. |
| retry_interval | Text | 10 | Seconds to wait before retrying on failure. |
| custom_flattening | Text | no | Enable custom flattening to process configuredDevices data by mapping only devices and sites from the Result List, ignoring all other attributes. Possible values: 'yes' or 'no'. |
This bot also accepts wildcard parameters. Any additional name = 'value' parameters are passed to the bot.