External Links API

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

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


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

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

Name

Located in

Description

Default

Schema

filter.enabled

query

Filter for enabled or disabled external links; when true, returns only enabled external links; when false, returns only disabled external links; when this filter is absent, no filtering is done

 

boolean

orderBy

query

Sort by the specified attribute (name, enabled, url, or a listable external link dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending)

"+name"

string
Enum: [
  "+name",
  "-name",
  "+enabledFlag",
  "-enabledFlag",
  "+url",
  "-url"
]

offset

query

Return the specified page number

1

integer

limit

query

Define the number of rows in a page or the maximum number of external links 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 external links

 

500

Internal server error: Unexpected exception occurred

 

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

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

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new external link

 

Authorization

header

Authorization token formatted as 'Bearer [token]'

 

string*

Responses

Code

Description

Schema

201

Created: New external link successfully added

 

400

Bad request: Input external link DTO is missing or new external link 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 external link

 

500

Internal server error: Unexpected exception occurred

 

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

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

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the external link 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 external links

 

404

Not found: No single matching external link found

 

500

Internal server error: Unexpected exception occurred

 

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

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

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the external link to be modified

 

string*

body

body

Complete new attribute values for the external link; anything left out will be considered to be null and will be nulled out in the external link

 

Authorization

header

Authorization token formatted as 'Bearer [token]'

 

string*

Responses

Code

Description

Schema

200

successful operation

400

Bad request: Input external link DTO is missing or modified external link 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 external link

 

404

Not found: No single matching external link found

 

500

Internal server error: Unexpected exception occurred

 

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

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

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the external link 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 external link

 

404

Not found: No single matching external link found

 

500

Internal server error: Unexpected exception occurred

 

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

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

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the external link to be modified

 

string*

body

body

New attribute values for the external link, 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 external link 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 external link

 

404

Not found: No single matching external link 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)
}

ExternalLinkDTO

Click here to expand...

{
    id: string
    The external link's unique database key (read-only)
 
    name: string*
    The external link's unique display name
 
    enabledFlag: boolean
    Whether or not the external link is enabled; when true, the URL appears as a clickable link when you display the device info popup; when false, no such link is displayed
 
    substitutionParameterCheckFlag: boolean
    Whether or not the url field is validated for proper substitution parameter syntax; when true, the URL is checked for correct usage of device, agent, and global substitution parameters; when false, the URL is not checked for substitution parameter syntax
 
    url: string*
    The URL of the external application being linked to
 
    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*