The API comes with a sample program that shows the several aspects below of working with the AIMMS PRO api. You can find it in the Examples folder.
The AIMMS PRO API allows you to connect to the PRO server and lists its jobs. The information retrieved is however a snapshot of the state at which the server was when requesting the job list. You can either invoke the refresh member method of a Job for an individual refresh or refresh the entire list by fetching it again from the server.
Besides listing the jobs, you can also create new ones by scheduling them at the server. Under the hood the PRO framework communicates by sending asynchronous messages back and forth. In the AIMMS PRO API this is reflected by the JobInteractor object, which takes care of subscribing for messages related to the associated job at the PRO server.
It is important to note that a job can finish successfully, while the actual procedure call failed. In order to be noticed of the failure of the procedure call you need to have an attached JobInteractor, which you can query for events (including errors) that happened on the job.
The JobInteractor also allows you to handle AIMMS remote session initiated DelegateToClient calls. Similarly you can use the JobInteractor to inject a procedure call into the remote running job. This is executed in the remote job as if in the current running procedure another procedure is called just prior to executing the next statement. When this newly injected procedure is finished execution will continue normally at that next statement.