4.9.1.2. Using the Linkware Integration Service web server for dealing with operational issues
This topic gives information that can be used by administrative users for controlling, debugging and analyzing the Linkware Integration Service. This is achieved by sending HTTP requests to several endpoints available on the Linkware Integration Services webserver. This enables admins to retrieve different statistics and data, such as the current webserver status, as well as to deal with operational issues, for example, put certain services to sleep and/or restart them.
Note that the LIS webserver is only for debugging and support purposes and is not required for normal Linkware Live integration operations. If the integration is working, there is no need to do any webserver operations.
If you cannot access the LIS webserver, it's most likely either because:
the webserver is down or in a bad state
the webserver's port is not open for you
If either of those things happen, please contact Planet Associates for assistance.
The URL syntax to be used for HTTP calls:
http://machinename:8085/endpoint(refer to following table for valid enpont values)
Additional notes:
machinename is, i.e. demo.planetassociates.net
"status" - example endpoint, others will be listed below
POST calls may or may not include a body, as designated in the details below
GET calls never include a body
Endpoint and commands are listed as follows:
Command /Endpoint
HTTP Method
Description
Body
list
GET
get the list of all commands
sleep
POST
sleep the syncing and signalR. Once this command is executed, only webserver remains running
restart
POST
restart the syncing and signalR
show-irm-objects
GET
show all IRM Proxies and Proxy Sources
status
GET
give the current status of the webserver
sync-proxies
POST
force a Linkware => IRM Sync
test-login
POST
test login credentials and URL to the API
{
proxySource:{
baseURL:‘externalapiurl.com'
},
login:{username:'',password:''},
apiLogin:{username:'',password:''}
}
uptime
GET
the amount of time the webserver has been running
version.txt
GET
the version of the web server
generate-certification-report
POST
LW certification report and post to Project Proxy
logging
GET
regular log setting
logging/:setting
POST
sets logging verbosity setting to one of the following: "Lowest", "Low", "Med", "High", "Highest"
“Highest” means it posts every log message (verbose logging).
There is no body included.
set-timers
POST
sets the default timer period in minutes.
Different timers used for syncing and tasks:
reportTimer - used for checking unfinished report requests.
syncTimer - used for active Library syncing to the Product Catalog.
taskTimer - used for checking on open Task Requests in need of processing
cableTestTimer - used for checking syncing on existing CI Proxies Between External & IRM
