Skip to content

Latest commit

 

History

History
281 lines (194 loc) · 7.96 KB

TopologiesApi.md

File metadata and controls

281 lines (194 loc) · 7.96 KB

TopologiesApi

All URIs are relative to https://penapi.pacnetconnect.com

Method HTTP request Description
ttms100TopologyTagByTopotaguuidDelete DELETE /ttms/1.0.0/topology_tag/{topotaguuid}/ Delete a topology tag
ttms100TopologyTagByTopotaguuidGet GET /ttms/1.0.0/topology_tag/{topotaguuid}/ Get information about the specified topology tag
ttms100TopologyTagByTopotaguuidPut PUT /ttms/1.0.0/topology_tag/{topotaguuid}/ Update a topology tag's name and/or description
ttms100TopologyTagGet GET /ttms/1.0.0/topology_tag List all topology tags
ttms100TopologyTagObjectsByTopotaguuidGet GET /ttms/1.0.0/topology_tag/{topotaguuid}/objects/ List objects for Topology
ttms100TopologyTagPost POST /ttms/1.0.0/topology_tag Create a named topology tag

ttms100TopologyTagByTopotaguuidDelete

ttms100TopologyTagByTopotaguuidDelete(topotaguuid)

Delete a topology tag

Delete a topology tag

Example

// Import classes:
//import invalidPackageName.ApiException;
//import TelstraTPN.TopologiesApi;


TopologiesApi apiInstance = new TopologiesApi();
String topotaguuid = "topotaguuid_example"; // String | Unique identifier representing a specific topology tag
try {
    apiInstance.ttms100TopologyTagByTopotaguuidDelete(topotaguuid);
} catch (ApiException e) {
    System.err.println("Exception when calling TopologiesApi#ttms100TopologyTagByTopotaguuidDelete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
topotaguuid String Unique identifier representing a specific topology tag

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

ttms100TopologyTagByTopotaguuidGet

Topology ttms100TopologyTagByTopotaguuidGet(topotaguuid)

Get information about the specified topology tag

Get information about the specified topology tag

Example

// Import classes:
//import invalidPackageName.ApiException;
//import TelstraTPN.TopologiesApi;


TopologiesApi apiInstance = new TopologiesApi();
String topotaguuid = "topotaguuid_example"; // String | Unique identifier representing a specific topology tag
try {
    Topology result = apiInstance.ttms100TopologyTagByTopotaguuidGet(topotaguuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TopologiesApi#ttms100TopologyTagByTopotaguuidGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
topotaguuid String Unique identifier representing a specific topology tag

Return type

Topology

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

ttms100TopologyTagByTopotaguuidPut

Topology ttms100TopologyTagByTopotaguuidPut(topotaguuid, body)

Update a topology tag's name and/or description

Update a topology tag's name and/or description

Example

// Import classes:
//import invalidPackageName.ApiException;
//import TelstraTPN.TopologiesApi;


TopologiesApi apiInstance = new TopologiesApi();
String topotaguuid = "topotaguuid_example"; // String | Unique identifier representing a specific topology tag
Ttms100TopologyTagRequest body = new Ttms100TopologyTagRequest(); // Ttms100TopologyTagRequest | 
try {
    Topology result = apiInstance.ttms100TopologyTagByTopotaguuidPut(topotaguuid, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TopologiesApi#ttms100TopologyTagByTopotaguuidPut");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
topotaguuid String Unique identifier representing a specific topology tag
body Ttms100TopologyTagRequest [optional]

Return type

Topology

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

ttms100TopologyTagGet

List<Topology> ttms100TopologyTagGet()

List all topology tags

List all topology tags

Example

// Import classes:
//import invalidPackageName.ApiException;
//import TelstraTPN.TopologiesApi;


TopologiesApi apiInstance = new TopologiesApi();
try {
    List<Topology> result = apiInstance.ttms100TopologyTagGet();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TopologiesApi#ttms100TopologyTagGet");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

List<Topology>

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

ttms100TopologyTagObjectsByTopotaguuidGet

Ttms100TopologyTagObjectsResponse ttms100TopologyTagObjectsByTopotaguuidGet(topotaguuid)

List objects for Topology

List all objects (Endpoints, Links, VPorts, etc.) associated with the topology tag.

Example

// Import classes:
//import invalidPackageName.ApiException;
//import TelstraTPN.TopologiesApi;


TopologiesApi apiInstance = new TopologiesApi();
String topotaguuid = "topotaguuid_example"; // String | Unique identifier representing a specific topology tag
try {
    Ttms100TopologyTagObjectsResponse result = apiInstance.ttms100TopologyTagObjectsByTopotaguuidGet(topotaguuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TopologiesApi#ttms100TopologyTagObjectsByTopotaguuidGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
topotaguuid String Unique identifier representing a specific topology tag

Return type

Ttms100TopologyTagObjectsResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

ttms100TopologyTagPost

Topology ttms100TopologyTagPost(body)

Create a named topology tag

Create a named topology tag

Example

// Import classes:
//import invalidPackageName.ApiException;
//import TelstraTPN.TopologiesApi;


TopologiesApi apiInstance = new TopologiesApi();
Ttms100TopologyTagRequest body = new Ttms100TopologyTagRequest(); // Ttms100TopologyTagRequest | 
try {
    Topology result = apiInstance.ttms100TopologyTagPost(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TopologiesApi#ttms100TopologyTagPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body Ttms100TopologyTagRequest [optional]

Return type

Topology

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json