Skip to content

Latest commit

 

History

History
269 lines (189 loc) · 8.17 KB

LinksApi.md

File metadata and controls

269 lines (189 loc) · 8.17 KB

TelstraTPN.LinksApi

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

Method HTTP request Description
inventory_link POST /1.0.0/inventory/link Create Link and initial Contract
inventory_links GET /1.0.0/inventory/links/{linkid} Get details of specified link
inventory_links_customer GET /1.0.0/inventory/links/customer/{customeruuid} Get active Links
inventory_links_history GET /1.0.0/inventory/links/history/{linkid} Get Link history
inventory_links_stats_flow GET /1.0.0/inventory/links-stats/flow/{linkid}/{startdate}/{enddate} Get statistics for flow

inventory_link

SuccessFragment inventory_link(createlinkrequest=createlinkrequest)

Create Link and initial Contract

Example

from __future__ import print_function
import time
import TelstraTPN
from TelstraTPN.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oAuth2
configuration = TelstraTPN.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = TelstraTPN.LinksApi(TelstraTPN.ApiClient(configuration))
createlinkrequest = TelstraTPN.Createlinkrequest() # Createlinkrequest |  (optional)

try:
    # Create Link and initial Contract
    api_response = api_instance.inventory_link(createlinkrequest=createlinkrequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LinksApi->inventory_link: %s\n" % e)

Parameters

Name Type Description Notes
createlinkrequest Createlinkrequest [optional]

Return type

SuccessFragment

Authorization

oAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

inventory_links

InlineResponse2007 inventory_links(linkid)

Get details of specified link

Example

from __future__ import print_function
import time
import TelstraTPN
from TelstraTPN.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oAuth2
configuration = TelstraTPN.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = TelstraTPN.LinksApi(TelstraTPN.ApiClient(configuration))
linkid = 'linkid_example' # str | Unique identifier representing a specific link

try:
    # Get details of specified link
    api_response = api_instance.inventory_links(linkid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LinksApi->inventory_links: %s\n" % e)

Parameters

Name Type Description Notes
linkid str Unique identifier representing a specific link

Return type

InlineResponse2007

Authorization

oAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

inventory_links_customer

list[Link] inventory_links_customer(customeruuid)

Get active Links

Example

from __future__ import print_function
import time
import TelstraTPN
from TelstraTPN.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oAuth2
configuration = TelstraTPN.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = TelstraTPN.LinksApi(TelstraTPN.ApiClient(configuration))
customeruuid = 'customeruuid_example' # str | Unique identifier representing a specific customer

try:
    # Get active Links
    api_response = api_instance.inventory_links_customer(customeruuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LinksApi->inventory_links_customer: %s\n" % e)

Parameters

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

Return type

list[Link]

Authorization

oAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

inventory_links_history

InlineResponse2005 inventory_links_history(linkid)

Get Link history

Example

from __future__ import print_function
import time
import TelstraTPN
from TelstraTPN.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oAuth2
configuration = TelstraTPN.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = TelstraTPN.LinksApi(TelstraTPN.ApiClient(configuration))
linkid = 'linkid_example' # str | Unique identifier representing a specific link

try:
    # Get Link history
    api_response = api_instance.inventory_links_history(linkid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LinksApi->inventory_links_history: %s\n" % e)

Parameters

Name Type Description Notes
linkid str Unique identifier representing a specific link

Return type

InlineResponse2005

Authorization

oAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

inventory_links_stats_flow

list[InlineResponse20019] inventory_links_stats_flow(linkid, startdate, enddate)

Get statistics for flow

Get statistics related to the specified flow

Example

from __future__ import print_function
import time
import TelstraTPN
from TelstraTPN.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oAuth2
configuration = TelstraTPN.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = TelstraTPN.LinksApi(TelstraTPN.ApiClient(configuration))
linkid = 'linkid_example' # str | Unique identifier representing a specific link
startdate = 'startdate_example' # str | Start date for statistics query
enddate = 'enddate_example' # str | End date for statistics query

try:
    # Get statistics for flow
    api_response = api_instance.inventory_links_stats_flow(linkid, startdate, enddate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LinksApi->inventory_links_stats_flow: %s\n" % e)

Parameters

Name Type Description Notes
linkid str Unique identifier representing a specific link
startdate str Start date for statistics query
enddate str End date for statistics query

Return type

list[InlineResponse20019]

Authorization

oAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]