0

External Workspace Management - Open LDE Flow

  • updated 3 yrs ago

Start LDE URL

You can start the LDE using a browser and the following URL:

https://<hostname>/<company>/logicnets.lns?verb=start&code=DesignerStarter&external_id=<DMS-session-id>&hostname=<DMS-hostname>&port=<DMS-port>

Property Description Example
hostname The hostname or IP address of the server where the LogicNets Design Environment is installed. www.logicnets.com
company The name of the company installation examplecompany
DMS-session-id ID generated by the DMS which is used by the LDE to load and save projects 12345
DMS-hostname The hostname or IP address of the DMS REST service dms.company.com
DMS-port The port-number of the DMS REST service 8080

LDE Configuration

The DMS may require HTTPS and certificates to allow access to the REST service. These settings can be made through the LogicNets configuration. This is explained in IIS Configuration for Client Certificate Mapping

DMS GetProject Web Method

The purpose of this web method is to return the main LogicNet project and all dependent LogicNet projects to the LDE based on the DMS session ID.

Request

The relative base URL of the web method is /LogicNetsProject/Get?sessionid=<DMS-session-id>

Method: GET

Property Description Example
DMS-session-id ID passed in the Start LDE URL 12345

Response

Successful response is a JSON object structured as below.

Property Type Description Example
mainProject Project JSON object Main LogicNets project See below
dependencyProjects Array of Project JSON objects Dependent Projects See below


Project JSON Object

Property Type Description Example
id string DMS assigned ID for the project  
dataZip Base64-encoded binary zip (optional) Byte stream of the zip file or null.

Zip file includes the project files for one LogicNets project.

Null for new projects.
 
isReadOnly Boolean (optional) True indicates that project should be opened in read-only mode.

False indicates that project should be opened in edit mode.

Default value is false.
 
metaXml String (optional) Meta-XML of project  

Examples 

Example Response JSON Object for Existing Project 

{
"mainProject":{
"id":"9DE5110D289F1B7629DEDF3D88638B70",
"dataZip":"….",
"isReadOnly": false,
"metaXml" : “….”
},
"dependencyProjects":[
{
"id":"EED8B10951AA637C26B97BD783AF89D6",
"dataZip":"….",
"isReadOnly": true
}
]
}

 

Example Response JSON Object for Project 

{
"mainProject":{
"id":"9DE5110D289F1B7629DEDF3D88638B70",
"dataZip":[],
"isReadOnly": false,
"metaXml" : []
},
"dependencyProjects":[
{
"id":"EED8B10951AA637C26B97BD783AF89D6",
"dataZip":[],
"isReadOnly": true,
"metaXml" : []
}
]
}

 

HTTP Status Codes

Status Code Status Text Description
200 Success Request is successful and data is returned.
403 Forbidden Authentication failed.
500 Internal Server Error Unexpected server errors

DMS SaveProject Web Method 

The purpose of this web method is to save the main LogicNets project into the DMS. 

Request 

The relative base URL of the web method is /LogicNetsProject/Save?sessionid=<DMS-session-id>

Method: POST 

Property Description
DMS-session-id ID passed in the Start LDE URL
Body JSON object with project that needs to be saved

 

Body 

Property Type Description
dataZip Base64-encoded binary zip Byte stream of the zip file

Zip file includes the project files for one LogicNets project.
sessionId String DMS Session ID passed in the Start LDE URL
metaXml String Meta-XML of project

 

Response

The DMS must respond on the request with an HTTP status code.

Status Code Status Text Description
200 Success Request is successful and data is saved
403 Forbidden Authentication failed.
500 Internal Server Error Unexpected server errors
Reply Oldest first
  • Oldest first
  • Newest first
  • Active threads
  • Popular
Like Follow
  • 3 yrs agoLast active
  • 10Views
  • 2 Following

Home