Interact with SystemLink data services through the HTTP APIs of SystemLink Server and SystemLink Enterprise. You can access the API documentation in an OpenAPI document format.

SystemLink Server

You can access the HTTP API documentation for SystemLink Server in one of the following ways.
  • Append /niapis to the address of your SystemLink server in your browser. For example, http://localhost/niapis.
  • Append one of the following paths to the address of your SystemLink server to open SystemLink TDM documents:
    API Documentation URL to Append to Server URL Example
    • Upload Analysis Automation Procedures
    • Create Manual Task
    /systemlink-tdm-offline-doc/AnalysisServer/UploadAnalysisProcedureCreateManualTask.html http://localhost/systemlink-tdm-offline-doc/AnalysisServer/UploadAnalysisProcedureCreateManualTask.html
    • Run Manual Task
    • Inspect Task Execution
    /systemlink-tdm-offline-doc/AnalysisServer/RunAndInspectManualTask.html http://localhost/systemlink-tdm-offline-doc/AnalysisServer/RunAndInspectManualTask.html
    Data Navigation Data Service HTTP API /systemlink-tdm-offline-doc/DataNavigatorDataService/DataNavigatorDataService.html http://localhost/systemlink-tdm-offline-doc/DataNavigatorDataService/DataNavigatorDataService.html

SystemLink Enterprise

You can access the HTTP API documentation for SystemLink Enterprise in one of the following ways.
  • Navigate to the Home page, and click the API documentation link.
  • Access the Online API Documentation.