Using the Web API

This is key to our automating the asset registration process. By sending the asset profile to the API the asset gets created in AIMS and the UAID gets returned to the caller for further processing.

Using the Web API in AIMS

  1. Step 1
    • Locate the burger bar at the top right of the page next to your name. Click it and hover over Deferred access rights... to reveal a list of deferred rights to choose from. Select 'Web services client - send'.
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13. Step 2
    • Locate the new menu item on the header bar called Web services test client
  14.  
  15.  
  16.  
  17. Step 3
    • Locate the plus button and populate the parameters as shown in the image making sure you replace the personal authentication key with the one you were provided with
  18.  

Using the Web API with postman

  1. Step 1
    • Launch postman and add the authKey value that you were personally provided.
  2.  
  3.  
  4.  
  5. Step 2
    • In the body tab ensure the raw option button is selected and the body type is set to text (even though we will be sending XML). Then paste the XML of the new asset in the body text ensuring you've captured all the mandatory data
  6.  
  7.  
  8.  

Other features in the series

Want to skip a stage? Just use the links below to navigate to the section you need to gem up on.

Stage overview