Automic Workload Automation

Expand all | Collapse all

Getting Started with the Rest API for Automic v12.1

  • 1.  Getting Started with the Rest API for Automic v12.1

    Posted 10-13-2017 04:20 PM
      |   view attached

    If you would like to start using the newly released Rest API for Automic v12.1 or simply test it.. here is what to do:

    0- Download Postman
        => It's a Rest API testing tool & is very simple to use
        => you can download it here: https://www.getpostman.com/
        => it is available for Windows, MacOS, Linux and also as a Google Chrome Extension

    1- Open Postman and import the 2 files contained in the Postman_Files.zip archive attached to this post
        => One file contains all the Rest call examples for the Automic v12.1 Rest API
        => The other file contains a list of Postman Environment Variables (Port number, URL, etc.)

    2- In Postman, click on the "config" wheel and click on "Manage Environments":

    eevck45ddv38.png

    3- Adapt the values to your environment (replace aetesthost with the hostname where the engine is installed, replace the client number to your own client, update the Login & Dept, the Password, etc):

    a93sbknbd67z.pnghttps://us.v-cdn.net/5019921/uploads/editor/rv/a93sbknbd67z.png" width="1079">
    4- that's it! now you can go under "_AE_Official" and into either Folders (Search or Executions) and run the actual calls. this will give you working examples to start with. (click on the "Send" button to actually submit a request and see the response from the Automic Engine):

    ahi8cn8qw5lh.pnghttps://us.v-cdn.net/5019921/uploads/editor/ss/ahi8cn8qw5lh.png" width="1417">

    5- Bonus: you can generate code snippets from any of these calls by simply clicking on the "Code" link (right above "Update Request" button). You can pick your scripting or programming language, and Postman will generate a snippet of code for the exact Rest call:

    gff5tutu0fdm.pnghttps://us.v-cdn.net/5019921/uploads/editor/5v/gff5tutu0fdm.png" width="1440">

    Attachment(s)



  • 2.  Getting Started with the Rest API for Automic v12.1

    Posted 10-16-2017 02:17 AM
    Gotta try this today evening! The advanced search feature would be a great addition to the WorkflowCommander Powershell Cmdlets.


  • 3.  Getting Started with the Rest API for Automic v12.1

    Posted 11-03-2017 04:17 AM
    Hi,

    we tried this out connecting to AWI url and getting an error 

    You have to enable javascript in your browser to use an application built with Vaadin.

    Do we need any packages to be installed or do we need to configure and thing.

    Track has been opened with automic for the same REQ00215028.




  • 4.  Getting Started with the Rest API for Automic v12.1

    Posted 11-03-2017 04:21 AM
    Our basic requirement would be to trigger a job from a  dashboard defined in a customized url. we would be using language like c sharp on this.

    Currently we are on version 12.0.2

    Advice if any solution to it.


  • 5.  Getting Started with the Rest API for Automic v12.1

    Posted 11-03-2017 08:41 AM
    HI,
    couple of things to clarify:

    - this, as the title suggests, is only available for 12.1 and up (currently only 12.1)
    - the URL to use in the Rest Calls is NOT the URL to AWI. AWI is only the front-end and not the Web Server End Point. you need to use the name of the AE Server in your URL.

    for your current need with 12.0.2: you can use:




  • 6.  Getting Started with the Rest API for Automic v12.1

    Posted 11-09-2017 01:13 PM
    Excellent work, brendan_sapience_automic. Thanks for putting this together.


  • 7.  Getting Started with the Rest API for Automic v12.1

    Posted 11-10-2017 01:58 AM

    brendan_sapience_automic works like a charm and is pretty fast - any plans/roadmap when the next services will arrive?



  • 8.  Getting Started with the Rest API for Automic v12.1

    Posted 11-13-2017 03:01 AM
    We will continuously add new services to the REST API with every new release.


  • 9.  Getting Started with the Rest API for Automic v12.1

    Posted 11-13-2017 04:52 AM
    Robert Thullner wrote:
    We will continuously add new services to the REST API with every new release.
    Will it be possible to add new APIs without requiring an update to the AE or DB?


  • 10.  Getting Started with the Rest API for Automic v12.1

    Posted 11-13-2017 06:55 AM
    There might be feature release in between major versions that only require update of the JCP. However, this is not finally decided by now.
    Major changes/enhancements will always be part of a new release and will require AE/DB updates.


  • 11.  Getting Started with the Rest API for Automic v12.1

    Posted 11-18-2017 11:25 AM
    Just added examples for the Analytics API and EDDA. 

    Also, for a getting started on EDDA (Event and Data Driven Automation), see here: 

    https://community.automic.com/discussion/11057/getting-started-with-edda-event-and-data-driven-automation




  • 12.  Getting Started with the Rest API for Automic v12.1

    Posted 04-03-2018 11:46 AM
    brendan_sapience_automic
    We have been using your MarketPlace AutomicREST api to make calls from our legacy job scheduling system and/or from external vendors during the transition to Automic. 

    Connector/Bridge jobs are defined to authenticate a user to get a token and that token is passed on to other jobs to release/execute jobs on Automic. With external vendors, we were planning to provide the token with a validity period. 

    We upgraded our non-prod to 12.1.1 and trying to understand the equivalent of the above. 

    My understanding is, with 12.1.1 there's no token, the REST call will have the credentials as part of the job. Is this correct. Token approach seems to be much more secure. Is that something still feasible with 12.1.1 or do we need to keep using the marketplace API? 

    Thanks,
    Kesavan


  • 13.  Getting Started with the Rest API for Automic v12.1

    Posted 04-04-2018 12:51 PM
    Hi KesavanElangovan,

    with 12.1.1 and the official Rest API, there is no token mechanism indeed. the credentials have to be passed as part of every call (as Auth parameters). i will bring your feedback to Product Management for future versions of the Official Rest API.


  • 14.  Re: Getting Started with the Rest API for Automic v12.1

    Posted 10-19-2018 11:33 AM

    Is there an API available in Automic Version 9.1?



  • 15.  Re: Getting Started with the Rest API for Automic v12.1

    Posted 03-28-2019 03:21 AM

    Great work, it was just what we needed.

    does anybody try or know if it possible to execute from here a JSCH, and maybe even to modify the scheduler status from the rest api ?

    we were just able to execute JOBs and scripts.