Skip to content

Latest commit

 

History

History
140 lines (84 loc) · 3.64 KB

LinksApi.md

File metadata and controls

140 lines (84 loc) · 3.64 KB

LinksApi

All URIs are relative to **

Method HTTP request Description
inventoryLinkPost POST /1.0.0/inventory/link Create Link and initial Contract
inventoryLinksByLinkidGet GET /1.0.0/inventory/links/{linkid} Get details of specified link
inventoryLinksCustomerByCustomeruuidGet GET /1.0.0/inventory/links/customer/{customeruuid} Get active Links
inventoryLinksHistoryByLinkidGet GET /1.0.0/inventory/links/history/{linkid} Get Link history

inventoryLinkPost

Create Link and initial Contract

Create Link and initial Contract

Example

TelstraTPN inventoryLinkPost

Parameters

Name Type Description Notes
body InventoryLinkRequest [optional]

Return type

InventoryLinkResponse

Authorization

auth

HTTP request headers

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

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

inventoryLinksByLinkidGet

Get details of specified link

Get details of specified link

Example

TelstraTPN inventoryLinksByLinkidGet linkid=value

Parameters

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

Return type

InventoryLinksResponse

Authorization

auth

HTTP request headers

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

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

inventoryLinksCustomerByCustomeruuidGet

Get active Links

Get active Links

Example

TelstraTPN inventoryLinksCustomerByCustomeruuidGet customeruuid=value

Parameters

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

Return type

array[Link]

Authorization

auth

HTTP request headers

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

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

inventoryLinksHistoryByLinkidGet

Get Link history

Get Link history

Example

TelstraTPN inventoryLinksHistoryByLinkidGet linkid=value

Parameters

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

Return type

InventoryLinksHistoryResponse

Authorization

auth

HTTP request headers

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

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