Value Mappings API

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

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

GET

/v3.0/action_delete_current_image_options =====

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/action_image_sources

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/action_reboot_types

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/action_script_types

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/action_smart_merge_modes

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/action_statuses

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/boolean_expression_operators

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/canned_actions

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/device_access_modes

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/device_adapter_states

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/device_adapter_types

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/device_categories

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/device_inventory_report_attributes

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/device_security_context_types

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/device_transfer_modes

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/dynamic_field_components

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/emailed_report_formats

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/event_categories

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/event_severities

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/event_types

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
categoryFilter	query	Retrieve only event types in this category (debug, device, external, job, system, or user); a null means to retrieve all event types		string Enum: [ "debug", "device", "external", "job", "system", "user" ]
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/incoming_syslog_message_severities

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/integer_operators

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/job_approval_modes

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/job_approval_type_methods

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/job_originator_types

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/job_reconciliation_statuses

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/job_states

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/job_summary_link_report_by_types

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/network_rights

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/quarantine_isolation_levels

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/rule_severities

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/snmp_trap_types

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/snmp_v3_authentication_algorithms

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/snmp_v3_privileged_algorithms

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/snmp_versions

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

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

/v3.0/system_rights

Click here to expand...

Parameters

Name	Located in	Description	Default	Schema
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 the specified user is not logged in
500	Internal server error: Unexpected exception occurred

Value Mappings API

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/action_image_sources

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/action_reboot_types

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/action_script_types

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/action_smart_merge_modes

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/action_statuses

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/boolean_expression_operators

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/canned_actions

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/device_access_modes

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/device_adapter_states

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/device_adapter_types

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/device_categories

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/device_inventory_report_attributes

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/device_security_context_types

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/device_transfer_modes

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/dynamic_field_components

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/emailed_report_formats

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/event_categories

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/event_severities

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/event_types

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/incoming_syslog_message_severities

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/integer_operators

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/job_approval_modes

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/job_approval_type_methods

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/job_originator_types

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/job_reconciliation_statuses

Parameters

Responses

{{status colour="Blue" title="GET"/}} /v3.0/job_states

Parameters

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

/v3.0/action_image_sources

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

/v3.0/action_reboot_types

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

/v3.0/action_script_types

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

/v3.0/action_smart_merge_modes

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

/v3.0/action_statuses

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

/v3.0/boolean_expression_operators

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

/v3.0/canned_actions

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

/v3.0/device_access_modes

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

/v3.0/device_adapter_states

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

/v3.0/device_adapter_types

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

/v3.0/device_categories

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

/v3.0/device_inventory_report_attributes

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

/v3.0/device_security_context_types

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

/v3.0/device_transfer_modes

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

/v3.0/dynamic_field_components

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

/v3.0/emailed_report_formats

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

/v3.0/event_categories

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

/v3.0/event_severities

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

/v3.0/event_types

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

/v3.0/incoming_syslog_message_severities

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

/v3.0/integer_operators

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

/v3.0/job_approval_modes

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

/v3.0/job_approval_type_methods

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

/v3.0/job_originator_types

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

/v3.0/job_reconciliation_statuses

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

/v3.0/job_states

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

/v3.0/job_summary_link_report_by_types

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

/v3.0/network_rights

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

/v3.0/quarantine_isolation_levels

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

/v3.0/rule_severities

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

/v3.0/snmp_trap_types

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

/v3.0/snmp_v3_authentication_algorithms

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

/v3.0/snmp_v3_privileged_algorithms

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

/v3.0/snmp_versions

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

/v3.0/system_rights