Important

   

Starting from version 8.9.03, BMC Network Automation is renamed to TrueSight Network Automation. This space contains information about TrueSight Network Automation 8.9.03 and the later service packs for 8.9. For earlier releases, see BMC Network Automation 8.9.

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


GET /v3.0/global_substitution_parameters
 Retrieves global substitution parameters, matching any filter criteria
Parameters

Name

Located in

Description

Default

Schema

filter.name

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

[
   #GlobalSubstitutionParameterDTO
]

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


POST /v3.0/global_substitution_parameters
 Adds a new global substitution parameter
Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new global substitution parameter


#GlobalSubstitutionParameterDTO

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


GET /v3.0/global_substitution_parameters/{nameOrKey}
 Retrieves one global substitution parameter either by name or by database key
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

#GlobalSubstitutionParameterDTO

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


PUT /v3.0/global_substitution_parameters/{nameOrKey}
 Modifies all attributes of an existing global substitution parameter
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


#GlobalSubstitutionParameterDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


String*

Responses

Code

Description

Schema

200

successful operation

#GlobalSubstitutionParameterDTO

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


DELETE /v3.0/global_substitution_parameters/{nameOrKey}
 Deletes a global substitution parameter
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


PATCH /v3.0/global_substitution_parameters/{nameOrKey}
 Modifies only the specified attributes of an existing global substitution parameter, where the changes are specified in JSON Patch format (per RFC 6902)
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


#JsonPatch

Authorization

header

Authorization token formatted as 'Bearer [token]'


String*

Responses

Code

Description

Schema

200

successful operation

#GlobalSubstitutionParameterDTO

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

 A dynamic field value

{
    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

 Information about a global substitution parameter

{
    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

 A list of JSON Patch operations

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

JsonPatch.OneOperation

JsonPatch.Pointer

 Pointer or path to an element or property

string
  Pointer or path to an element or property

JsonPatch.Add

 Add a value to an object or inserts it into an array. In the case of an array, the value is inserted before the given index. The - character can be used instead of an index to insert at the end of an array. The value can be any JSON value.

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

JsonPatch.Remove

 Remove a value from an object or array.

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

JsonPatch.Replace

 Replace an existing value. THe value can be any JSON value.

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

JsonPatch.Move

 Move a value from one location to the other. "path" is the destination.

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

JsonPatch.Copy

 Copy a value from one location to another. "path" is the destination.

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

JsonPatch.Test

 Test that the specified value is set in the document at the specified path. If the test fails, then the patch as a whole is not applied. The Value can be any JSON value.

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

Was this page helpful? Yes No Submitting... Thank you

Comments