Skip to content

Files

Latest commit

 

History

History
280 lines (201 loc) · 9.22 KB

EndpointsApi.md

File metadata and controls

280 lines (201 loc) · 9.22 KB

EndpointsApi

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

Method HTTP request Description
eis100EndpointsAssignTopologyTagByEndpointuuidPost POST /eis/1.0.0/endpoints/{endpointuuid}/assign_topology_tag Assign a Topology Tag to an Endpoint
inventoryEndpointByEndpointuuidGet GET /1.0.0/inventory/endpoint/{endpointuuid} Get information about the specified endpoint
inventoryEndpointsCustomeruuidByCustomeruuidGet GET /1.0.0/inventory/endpoints/customeruuid/{customeruuid} Get list of endpoints for a customer
inventoryRegularendpointPost POST /1.0.0/inventory/regularendpoint Create Physical (Port) Endpoint
inventoryVnfendpointPost POST /1.0.0/inventory/vnfendpoint Create VNF Endpoint

eis100EndpointsAssignTopologyTagByEndpointuuidPost

List<SuccessFragment> eis100EndpointsAssignTopologyTagByEndpointuuidPost(endpointuuid, body)

Assign a Topology Tag to an Endpoint

Assign a Topology Tag to an Endpoint

Example

// Import classes:
//import invalidPackageName.ApiClient;
//import invalidPackageName.ApiException;
//import invalidPackageName.Configuration;
//import invalidPackageName.auth.*;
//import TelstraTPN.EndpointsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: auth
OAuth auth = (OAuth) defaultClient.getAuthentication("auth");
auth.setAccessToken("YOUR ACCESS TOKEN");

EndpointsApi apiInstance = new EndpointsApi();
String endpointuuid = "endpointuuid_example"; // String | Unique identifier representing a specific endpoint
Eis100EndpointsAssignTopologyTagRequest body = new Eis100EndpointsAssignTopologyTagRequest(); // Eis100EndpointsAssignTopologyTagRequest | 
try {
    List<SuccessFragment> result = apiInstance.eis100EndpointsAssignTopologyTagByEndpointuuidPost(endpointuuid, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EndpointsApi#eis100EndpointsAssignTopologyTagByEndpointuuidPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
endpointuuid String Unique identifier representing a specific endpoint
body Eis100EndpointsAssignTopologyTagRequest [optional]

Return type

List<SuccessFragment>

Authorization

auth

HTTP request headers

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

inventoryEndpointByEndpointuuidGet

InventoryEndpointResponse inventoryEndpointByEndpointuuidGet(endpointuuid)

Get information about the specified endpoint

Get information about the specified endpoint

Example

// Import classes:
//import invalidPackageName.ApiClient;
//import invalidPackageName.ApiException;
//import invalidPackageName.Configuration;
//import invalidPackageName.auth.*;
//import TelstraTPN.EndpointsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: auth
OAuth auth = (OAuth) defaultClient.getAuthentication("auth");
auth.setAccessToken("YOUR ACCESS TOKEN");

EndpointsApi apiInstance = new EndpointsApi();
String endpointuuid = "endpointuuid_example"; // String | Unique identifier representing a specific endpoint
try {
    InventoryEndpointResponse result = apiInstance.inventoryEndpointByEndpointuuidGet(endpointuuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EndpointsApi#inventoryEndpointByEndpointuuidGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
endpointuuid String Unique identifier representing a specific endpoint

Return type

InventoryEndpointResponse

Authorization

auth

HTTP request headers

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

inventoryEndpointsCustomeruuidByCustomeruuidGet

InventoryEndpointsCustomeruuidResponse inventoryEndpointsCustomeruuidByCustomeruuidGet(customeruuid)

Get list of endpoints for a customer

Get list of endpoints for a customer

Example

// Import classes:
//import invalidPackageName.ApiClient;
//import invalidPackageName.ApiException;
//import invalidPackageName.Configuration;
//import invalidPackageName.auth.*;
//import TelstraTPN.EndpointsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: auth
OAuth auth = (OAuth) defaultClient.getAuthentication("auth");
auth.setAccessToken("YOUR ACCESS TOKEN");

EndpointsApi apiInstance = new EndpointsApi();
String customeruuid = "customeruuid_example"; // String | Unique identifier representing a specific customer
try {
    InventoryEndpointsCustomeruuidResponse result = apiInstance.inventoryEndpointsCustomeruuidByCustomeruuidGet(customeruuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EndpointsApi#inventoryEndpointsCustomeruuidByCustomeruuidGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
customeruuid String Unique identifier representing a specific customer

Return type

InventoryEndpointsCustomeruuidResponse

Authorization

auth

HTTP request headers

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

inventoryRegularendpointPost

List<InventoryRegularendpointResponse> inventoryRegularendpointPost(body)

Create Physical (Port) Endpoint

Create Physical (Port) Endpoint

Example

// Import classes:
//import invalidPackageName.ApiClient;
//import invalidPackageName.ApiException;
//import invalidPackageName.Configuration;
//import invalidPackageName.auth.*;
//import TelstraTPN.EndpointsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: auth
OAuth auth = (OAuth) defaultClient.getAuthentication("auth");
auth.setAccessToken("YOUR ACCESS TOKEN");

EndpointsApi apiInstance = new EndpointsApi();
InventoryRegularendpointRequest body = new InventoryRegularendpointRequest(); // InventoryRegularendpointRequest | 
try {
    List<InventoryRegularendpointResponse> result = apiInstance.inventoryRegularendpointPost(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EndpointsApi#inventoryRegularendpointPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body InventoryRegularendpointRequest [optional]

Return type

List<InventoryRegularendpointResponse>

Authorization

auth

HTTP request headers

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

inventoryVnfendpointPost

List<InventoryVnfendpointResponse> inventoryVnfendpointPost(body)

Create VNF Endpoint

Create VNF Endpoint

Example

// Import classes:
//import invalidPackageName.ApiClient;
//import invalidPackageName.ApiException;
//import invalidPackageName.Configuration;
//import invalidPackageName.auth.*;
//import TelstraTPN.EndpointsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: auth
OAuth auth = (OAuth) defaultClient.getAuthentication("auth");
auth.setAccessToken("YOUR ACCESS TOKEN");

EndpointsApi apiInstance = new EndpointsApi();
InventoryVnfendpointRequest body = new InventoryVnfendpointRequest(); // InventoryVnfendpointRequest | 
try {
    List<InventoryVnfendpointResponse> result = apiInstance.inventoryVnfendpointPost(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EndpointsApi#inventoryVnfendpointPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body InventoryVnfendpointRequest [optional]

Return type

List<InventoryVnfendpointResponse>

Authorization

auth

HTTP request headers

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