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.

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


 Retrieves external links, matching any filter criteria
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

[
   #ExternalLinkDTO
]

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

 Adds a new external link
Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new external link

#ExternalLinkDTO

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

GET /v3.0/external_links/{nameOrKey}
 Retrieves one external link either by name or by database key
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

#ExternalLinkDTO

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

PUT /v3.0/external_links/{nameOrKey}
 Modifies all attributes of an existing external link
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

#ExternalLinkDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'

string*

Responses

Code

Description

Schema

200

successful operation

#ExternalLinkDTO

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

DELETE /v3.0/external_links/{nameOrKey}
 Deletes an external link
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

PATCH /v3.0/external_links/{nameOrKey}
 Modifies only the specified attributes of an existing external link, 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 external link to be modified

string*

body

body

New attribute values for the external link, in JSON Patch format

#JsonPatch

Authorization

header

Authorization token formatted as 'Bearer [token]'

string*

Responses

Code

Description

Schema

200

successful operation

#ExternalLinkDTO

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

 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)
}

ExternalLinkDTO

 Information about an external link

{
    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

 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