v4.0 System Parameters API

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

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

system_parameters

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

 /v4.0/system_parameters
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 accessToken cookie, or the specified user is not logged in


403

Forbidden: Not allowed to access system parameters


500

Internal server error: Unexpected exception occurred


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

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


Parameters

Name

Located in

Description

Default

Schema

body

body

New values for the specified system parameters; only the input parameters are updated and only when the new value is different from the current value; other parameters are left unchanged, and paraameters are never deleted


Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

400

Bad request: Input system parameters DTO is missing or modified system parameters are 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 system parameters


500

Internal server error: Unexpected exception occurred


Object Definitions

Object

Schema

SystemParameterDTO


Click here to expand...


{
    containsSensitiveDataFlag: boolean
    Whether or not the parameter's value is a password or other type of secret; the value is in cleartext (read-only)
 
    defaultValues: [
      The system parameter's default value(s); null when there is no default (read-only)
 
      string
    ]
 
    displayLabel: string
    The system parameter's displayable label, which is more descriptive than the internal name (read-only)
 
    multiValuedParameterFlag: boolean
    Whether or not this is the sort of parameter that has a single value (false) or multiple values (true) (read-only)
 
    name: string*
    The system parameter's unique internal name
 
    readOnlyFlag: boolean
    Whether or not this parameter's value can be changed; some parameters are managed by the system and cannot be changed (read-only)
 
    values: [
      The system parameter's value(s)
 
      string
    ]*
}

SystemParametersDTO


Click here to expand...


{
    parameters: [
      A collection of system parameters
 
       SystemParameterDTO
   ]*
}

 

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