ctrlX PLC Engineering 2.4: Login and Download through REST API

[therusch]

EDIT by @CodeShepherd: Moved to own topic from "plc engineering: login and download through rest api".

Hello, 

are these functions now implemented in the API of release 2.4? 
I can only find a build job for libraries.  

Best regards

[CodeShepherd · Accepted solution]

Feel free to check the API description deployed with the installation of the ctrlX PLC Engineering:

ctrlXPLC Engineering - Swagger UI - Jobs

Available jobs in ctrlX PLC Engineering 2.4 are:

• addLibCatFromDescFileJob
• addLibCatFromOtherLibJob
• applicationLoginJob --> Login
• applicationLogoutJob --> Logout
• applicationStartJob --> Start
• applicationStopJob --> Stop
• buildJobGenerateRuntimeSystemFiles
• communicationSettingsJob  --> set IP address
• declarationsJobAddAllinstancePaths
• deviceRepositoryJobSaveDevice
• deviceUserLoginJob --> set username and password
• deviceUserLogoutJob
• exportJob
• exportPIcOpenXmIJob
• exportUsersAndGroupsJob
• findElementsJob
• importFieldbusConfigJob
• importJob
• importOfflineFieldbusConfigJob
• importPIcOpenXmiJob
• importUsersAndGroupsJob
• moveElementsJob
• newProjectJob
• preCompileJobDisable
• preCompileJobEnable
• projectJobClose
• projectJobOpen
• projectJobSave
• projectJobSaveAndinstallintoLibraryRepository
• projectJobSaveAs
• projectJobSaveAsCompiledLibrary
• publishMarkedMethodsJob
• pubSubJobSetAsPublisher
• pubSubJobSetAsSubscriber
• removeLibraryCategoriesJob
• resetColdJob
• resetOriginJob
• resetWarmJob
• serManagementLogInJob
• userManagementLogOutJob

[CopyPaste]

Build job is available only for libraries. You can use 
CommunicatioSettingsJob -> to set IP address
DeviceUserLoginJob -> to set username and password
ApplicationLoginJob
ApplicationJob ->Start & Stop
ApplicationJob ->Logout

[therusch]

Hello,

thank you for the quick answer. 
So, I understand, there is no possibility to check for compilation errors in non library projects via the API. 
With the ApplicationLogin Job and the Aplication Job Start,Stop and Logout the execution of a Codesys Test Project should be possible.  

To Login, the code needs to be generated. I assume this will happen in the background. Do we get the results from that? 

Best regards

[CopyPaste · Accepted solution]

Yes, after a Job is executed, in the result you get job id. With this id you can check if the job is sucessful or failed and also the reason for failure. see screenshots below:

 

 

[therusch]

Thank you. This will surely help.