AutoSys Web Services (API)#

During fall 2023, the JST team is in the process of setting up AutoSys Web Services which is Broadcom's implementation of a rest API. This service offering is in a development stage so the following information may change.

Service Policies#

Individual users will have access to the API using their UMN credentials through basic authentication. Individual users will have the same access to jobs, calendars, etc. via the API as they do via the AutoSys Web GUI. See this article for requesting AutoSys user access.
Any advanced access to the API (i.e. starting jobs in PRD) will be given via a UMN functional/department account and subject to departmental and JST approval. A functional/departmental account should also be set up if the API is being accessed by a machine or service and not an individual.
JST maintains a maintenance window between 6am - 12pm on Sundays. The AutoSys API may be unavailable during these times. If you are utilizing the API, please make sure you are in the filetransferandbatch@umn.edu Google Group to be notified of outages.

Environment Base URL's#

DEV: https://autosys-api-dev.oit.umn.edu/AEWS/
TST: https://autosys-api-tst.oit.umn.edu/AEWS/
PRD: https://autosys-api.oit.umn.edu/AEWS (SSL certificate pending early October planned change)

Endpoints#

Here are a few sample endpoints. Refer to the Vendor Documentation section of this article for more endpoints.

Note

All endpoints may not be available to your user. Refer to Service Policies for more information.

GET Requests#

Get Job Details#

Endpoint: https://autosys-api-tst.oit.umn.edu/AEWS/job/
Example (specific job): https://autosys-api-tst.oit.umn.edu/AEWS/job/SCHDD.Test.BX
Response: JSON

Get Calendars#

Endpoint: https://autosys-api-tst.oit.umn.edu/AEWS/calendar/standard
Example (specific calendar): https://autosys-api-tst.oit.umn.edu/AEWS/calendar/standard?name=HRMSD.Travis_Test_Autocal.SC
Response: Text

POST Request#

Force Start Job#

Endpoint: https://autosys-api-dev.oit.umn.edu/AEWS/event/force-start-job/
Example JSON Body:

JSON

{"jobName":"SCHDD.Test.BX","comment":"test"}

Response: 201 Created

Vendor Documentation#

See reference pages under this page