Global Substitution Parameters API

TrueSight Network Automation REST API – Version 3.0 – GlobalSubstitutionParameterServices
The base URL for the API is:

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


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

 /v3.0/global_substitution_parameters
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

query

Filter for global substitution parameters matching this name, asterisk wildcards allowed


string

orderBy

query

Sort by the specified attribute (name, value, or a listable global substitution parameter dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending)

"+name"

string
Enum: [
  "+name",
  "-name",
  "+value",
  "-value"
]

offset

query

Return the specified page number

1

integer

limit

query

Define the number of rows in a page or the maximum number of global substitution parameters 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 the specified user is not logged in


403

Forbidden: Not allowed to access global substitution parameters


500

Internal server error: Unexpected exception occurred


{{status colour="Green" title="POST"/}}

 /v3.0/global_substitution_parameters
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new global substitution parameter


Authorization

header

Authorization token formatted as 'Bearer [token]'


String*

Responses

Code

Description

Schema

201

Created: New global substitution parameter successfully added


400

Bad request: Input global substitution parameter DTO is missing or new global substitution parameter is invalid


401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in


403

Forbidden: Not allowed to add a new global substitution parameter


500

Internal server error: Unexpected exception occurred


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

 /v3.0/global_substitution_parameters/{nameOrKey}
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the global substitution parameter 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 the specified user is not logged in


403

Forbidden: Not allowed to access global substitution parameters


404

Not found: No single matching global substitution parameter found


500

Internal server error: Unexpected exception occurred


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

 /v3.0/global_substitution_parameters/{nameOrKey}
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the global substitution parameter to be modified


string*

body

body

Complete new attribute values for the global substitution parameter; anything left out will be considered to be null and will be nulled out in the global substitution parameter


Authorization

header

Authorization token formatted as 'Bearer [token]'


String*

Responses

Code

Description

Schema

200

successful operation

400

Bad request: Input global substitution parameter DTO is missing or modified global substitution parameter is invalid


401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in


403

Forbidden: Not allowed to modify the global substitution parameter


404

Not found: No single matching global substitution parameter found


500

Internal server error: Unexpected exception occurred


{{status colour="Red" title="DELETE"/}}

 /v3.0/global_substitution_parameters/{nameOrKey}
Click here to expand...
Description

If global substitution parameter is currently referenced in a template,then the template may produce an "unresolved parameter" error during a deploy to active or deploy to stored operation. If this parameter is currently referenced in a rule, then the rule may produce an "unresolved parameter" error during a snapshot or a refresh device status operation, or when displayingthe compliance summary report

Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the global substitution parameter 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 the specified user is not logged in


403

Forbidden: Not allowed to delete the global substitution parameter


404

Not found: No single matching global substitution parameter found


500

Internal server error: Unexpected exception occurred


{{status colour="Yellow" title="PATCH"/}}

 /v3.0/global_substitution_parameters/{nameOrKey}
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the global substitution parameter to be modified


string*

body

body

New attribute values for the global substitution parameter, in JSON Patch format


Authorization

header

Authorization token formatted as 'Bearer [token]'


String*

Responses

Code

Description

Schema

200

successful operation

400

Bad request: Input JSON patch information is missing or modified global substitution parameter is invalid


401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in


403

Forbidden: Not allowed to modify the global substitution parameter


404

Not found: No single matching global substitution parameter found


500

Internal server error: Unexpected exception occurred


Object Definitions

Object

Schema

DynamicFieldValueDTO

Click here to expand...

{
    id: string
    The database key of the dynamic field whose value this is (read-only)
 
    name: string
    The name of the dynamic field (read-only)
 
    values: [
      The value(s) for the dynamic field; for a single-value field, only the first entry is relevant; read-only for Auto Derived and Configuration Profiled types
 
      string
    ]
 
    dynamicFieldDetailsLink: string
    Link to get more detailed information about the dynamic field (read-only)
}

GlobalSubstitutionParameterDTO

Click here to expand...

{
    id: string
    The global substitution parameter's unique database key (read-only)
 
    name: string*
    The global substitution parameter's unique display name
 
    value: string*
    The global substitution parameter's value
 
    hideValueFlag: boolean
    Whether or not the value should be hidden or masked whenever it is displayed in the user interface
 
    dynamicFields: [
      The dynamic fields
 
       #DynamicFieldValueDTO
    ]
}

JsonPatch

Click here to expand...

[
    A list of JSON Patch operations
 
     #JsonPatch.OneOperation
  ]

JsonPatch.OneOperation

JsonPatch.Pointer

Click here to expand...

string
  Pointer or path to an element or property

JsonPatch.Add

Click here to expand...

{
    op: string*
    Enum: [
      "add"
    ]
    value: any*
    path: #JsonPatch.Pointer *
}

JsonPatch.Remove

Click here to expand...

{
    op: string*
    Enum: [
      "remove"
    ]
    path: #JsonPatch.Pointer *
}

JsonPatch.Replace

Click here to expand...

{
    op: string*
    Enum: [
      "replace"
    ]
    value: any*
    path: #JsonPatch.Pointer *
}

JsonPatch.Move

Click here to expand...

{
    op: string*
    Enum: [
      "move"
    ]
    path: #JsonPatch.Pointer *
    from: #JsonPatch.Pointer *
}

JsonPatch.Copy

Click here to expand...

{
    op: string*
    Enum: [
      "copy"
    ]
    path: #JsonPatch.Pointer *
    from: #JsonPatch.Pointer *
}

JsonPatch.Test

Click here to expand...

{
    op: string*
    Enum: [
      "test"
    ]
    value: any*
    path: #JsonPatch.Pointer *
}

 

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