cancel
Showing results for 
Search instead for 
Did you mean: 
SOLVED

ctrlX PLC Engineering 2.4: Login and Download through REST API

ctrlX PLC Engineering 2.4: Login and Download through REST API

therusch
Established Member

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

5 REPLIES 5

CodeShepherd
Community Moderator
Community Moderator

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

ctrlXPLC Engineering - Swagger UI - JobsctrlXPLC 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
Established Member

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
Established Member

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
Established Member

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:

2024-03-20_12h53_30.png

2024-03-20_12h54_00.png

therusch
Established Member

Thank you. This will surely help. 

Icon--AD-black-48x48Icon--address-consumer-data-black-48x48Icon--appointment-black-48x48Icon--back-left-black-48x48Icon--calendar-black-48x48Icon--center-alignedIcon--Checkbox-checkIcon--clock-black-48x48Icon--close-black-48x48Icon--compare-black-48x48Icon--confirmation-black-48x48Icon--dealer-details-black-48x48Icon--delete-black-48x48Icon--delivery-black-48x48Icon--down-black-48x48Icon--download-black-48x48Ic-OverlayAlertIcon--externallink-black-48x48Icon-Filledforward-right_adjustedIcon--grid-view-black-48x48IC_gd_Check-Circle170821_Icons_Community170823_Bosch_Icons170823_Bosch_Icons170821_Icons_CommunityIC-logout170821_Icons_Community170825_Bosch_Icons170821_Icons_CommunityIC-shopping-cart2170821_Icons_CommunityIC-upIC_UserIcon--imageIcon--info-i-black-48x48Icon--left-alignedIcon--Less-minimize-black-48x48Icon-FilledIcon--List-Check-grennIcon--List-Check-blackIcon--List-Cross-blackIcon--list-view-mobile-black-48x48Icon--list-view-black-48x48Icon--More-Maximize-black-48x48Icon--my-product-black-48x48Icon--newsletter-black-48x48Icon--payment-black-48x48Icon--print-black-48x48Icon--promotion-black-48x48Icon--registration-black-48x48Icon--Reset-black-48x48Icon--right-alignedshare-circle1Icon--share-black-48x48Icon--shopping-bag-black-48x48Icon-shopping-cartIcon--start-play-black-48x48Icon--store-locator-black-48x48Ic-OverlayAlertIcon--summary-black-48x48tumblrIcon-FilledvineIc-OverlayAlertwhishlist