Platform

Platform

A place for Apptio product users to learn, connect, share and grow together.

 View Only

How to use the DataLink interactive API documentation to modify an existing connector 

Tue March 27, 2018 08:08 PM

DataLink provides API help documentation and API helper built in with some useful capabilities that can help making edits to connectors programmatically.

 

To access Datalink API Documentation, log into datalink manager, click the gear button and select "API Documentation". 

 

To access Datalink interactive API documentation, log into your datalink manager. Once on the page listing agents edit url to to include /api at the end.

 

Here is an example of using API to make a change to SOAP connector. 

  1. Open the manager, click on an agent and then an existing DataLink connector.
    Make note of  the URL. It contains:
    • Agent ID (first set of numbers in the URL)
    • Connector ID (second set of numbers in the URL)
  2. In new browser tab, access the API Helper by adding "/api" at the end of URL. 
  3. Get the connector's details. 
    • Click "agent{id}connector" then "/resource/agent/{id}/connector/{connectorId}".
    • Enter agent id and connector id from step 1 and click "Try it out!".
    • Copy the contents of Response Body and save with .json extension.
      These are all the settings for your connector.
  4. To edit same connector, find "PUT /resource/agent/{id}/connector/{connectorId}"
  5. Enter agent and connector IDs.
  6. Paste the contents of .json file or output from retrieve connector details step.
  7. Modify the values.
    NOTE Some SOAP endpoint APIs require a parameter to be set but value to be null. To set a value to null, replace current value with quotes like "#" to null without quotes.  
  8. This is how to set nothing or null for a parameter:
  9. Click the Try it out! button and the specified connector will be updated.
  10. Fee free to verify by repeating step #3 

 

 

This article is open for your feedback. At the bottom of this screen click Add a comment.








#Datalink

Statistics
0 Favorited
0 Views
0 Files
0 Shares
0 Downloads