v4.0 Rule Export Tasks API
TrueSight Network Automation REST API – RuleExportTaskService
The base URL for the API is:
rule_export_tasks
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/rule_export_tasks
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
orderBy | query | Sort by the specified attribute (name, executionStatus, enabled, lastExecutedTimestamp, recurring, or schedule) 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 rule export tasks 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 rule export tasks | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Green" title="POST"/}}
/v4.0/rule_export_tasks
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
body | body | Complete attributes of the new rule export task | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
---|---|---|
201 | Created: New rule export task successfully added | |
400 | Bad request: Input rule export task DTO is missing or new rule export task 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 rule export task | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/rule_export_tasks/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the rule export task 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 rule export tasks | |
404 | Not found: No single matching accessible rule export task found | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Yellow" title="PUT"/}}
/v4.0/rule_export_tasks/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the rule export task to be modified | string * | |
body | body | Complete new attribute values for the rule export task; anything left out will be considered to be null and will be nulled out in the rule export task | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
400 | Bad request: Input rule export task DTO is missing or modified rule export task 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 rule export task | |
404 | Not found: No single matching accessible rule export task found | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Red" title="DELETE"/}}
/v4.0/rule_export_tasks/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the rule export task 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 accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to delete the rule export task | |
404 | Not found: No single matching accessible rule export task found | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/rule_export_tasks/{nameOrKey}/exported_rules
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the rule export task of interest | string * | |
Authorization | header | Authorization token formatted as 'Bearer [token]' | String * |
Responses
Code | Description | Schema |
---|---|---|
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 rule export tasks | |
404 | Not found: No single matching accessible rule export task found, or no execution results are currently present in the task | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/rule_export_tasks/{nameOrKey}/results
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the rule export task of interest | string * | |
filter.status | query | Filter for individual results with this execution status | integer | |
orderBy | query | Sort by the specified attribute (name, message, or status) in the specified order (prefix with a '+' for ascending or a '-' for descending) | "+status" | 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 individual rule export results 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 rule export tasks | |
404 | Not found: No single matching accessible rule export task found, or no execution results are currently present in the task | |
500 | Internal server error: Unexpected exception occurred |
Object Definitions
Object | Schema |
---|---|
ComponentId | Click here to expand...{ |
ImportExportTaskResultsDTO | Click here to expand...{ |
ImportExportTaskScheduleDTO | Click here to expand...{ |
IndividualImportExportResultDTO | Click here to expand...{ |
RuleExportTaskDTO | Click here to expand...{ |