Automic Workload Automation

 View Only
  • 1.  Import AE REST API descriptions directly into Postman

    Posted Sep 12, 2019 04:47 AM
    Edited by Michael A. Lowry Sep 13, 2019 04:23 AM
    I discovered this morning that one can import a complete set of descriptions of the AE 12.3 REST APIs into Postman directly from docs.automic.com. The descriptions are available in both JSON and YAML formats. The API descriptions show up as a new collection called AE REST API documentation.

    This saved me a lot of time. I hope others benefit from this information.

    @Elina McCafferty: Perhaps you could update the AE REST API documentation page to include direct links to the JSON & YAML files.


  • 2.  RE: Import AE REST API descriptions directly into Postman

    Posted Sep 13, 2019 03:41 AM
    Great, thanks for sharing.


  • 3.  RE: Import AE REST API descriptions directly into Postman

    Posted Sep 13, 2019 10:07 AM
    Hey Michael,

    Good stuff.  How did you go about getting a JSON/yaml output from the website?

    --

    Scott Hughes

    IT Network Services

    O 949 286 7668
    M 505 373 7872
    7000 Central Blvd SW
    Albuqurque
    Albuqurque, New Mexico 87121






  • 4.  RE: Import AE REST API descriptions directly into Postman
    Best Answer

    Posted Sep 13, 2019 10:56 AM
    Edited by Michael A. Lowry Sep 02, 2021 04:06 AM

    @Scott Hughes: The REST API documentation page is dynamically generated by Swagger UI. This web app interprets a JSON or YAML file, so you just have to guess the path. The text box at the top contains the JSON file name.



  • 5.  RE: Import AE REST API descriptions directly into Postman

    Broadcom Employee
    Posted Oct 07, 2019 10:50 AM
    Hi Michael,
    The tech writer for this section is going to add some tips based on your post. 
    Thank you for your input!
    Best regards,
    Elina


  • 6.  RE: Import AE REST API descriptions directly into Postman

    Posted Jan 04, 2021 08:35 AM
    Any progress on this, @Elina McCafferty? ​


  • 7.  RE: Import AE REST API descriptions directly into Postman

    Posted Sep 02, 2021 04:09 AM
    The documentation page REST API Reference now includes rudimentary instructions for importing the API descriptions into Postman.


  • 8.  RE: Import AE REST API descriptions directly into Postman

    Broadcom Partner
    Posted Jan 06, 2021 12:15 PM
    Hi  Michael,

    This is great but could you tell me more where I can download AE REST API documentation and put it on my postman ?

    Thanks
    I would like to test on my LAB to see what I can do with this tool.

    Best regards,
    Thierry


  • 9.  RE: Import AE REST API descriptions directly into Postman

    Posted Jan 06, 2021 12:18 PM
    Links to the JSON and YAML files are in the original post.