Server Operations Web Services - List/Download Logs

Owned by Stonebranch (Deactivated)
Jan 30, 2024

Overview

Universal Controller supports the following RESTful-based web services for the List/Download Logs Server Operations, which are listed alphabetically on this page.

Formatting specifications for each web service, including details about parameter requirements, are provided.

List Log Files

Description

URI

http://host_name/uc/resources/serveroperation/listlog

HTTP Method

 GET

Description

Retrieve the log details using a specific query parameter.

Example URI

http://localhost:8080/uc/resources/serveroperation/listlog

Authentication

HTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

See List Log Files Example Response.

List Log Files: Example Response

XML Response

JSON Response
 XML Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<serverOperationResponse>
    <operation>List Logs</operation>
    <success>true</success>
    <output></output>
    <logs>
        <log>
            <logName>uc.d20200508.t120903.log</logName>
            <logDate>2020-05-08 12:09:03 -0400</logDate>
            <logSize>102</logSize>
        </log>
        <log>
            <logName>uc.d20200508.t121013.log</logName>
            <logDate>2020-05-08 12:10:13 -0400</logDate>
            <logSize>102</logSize>
        </log>
        <log>
            <logName>uc.d20200508.t121309.log</logName>
            <logDate>2020-05-08 12:13:09 -0400</logDate>
            <logSize>102</logSize>
       </log>
   </logs>
</serverOperationResponse>
 JSON Response

{
  "operation": "List Logs",
  "success": true,
  "output": "",
  "logs": [
    {
      "logName": "uc.d20200508.t115303.log",
      "logDate": "2020-05-08 11:53:03 -0400",
      "logSize": "112"
    },
    {
      "logName": "uc.d20200508.t115847.log",
      "logDate": "2020-05-08 11:58:47 -0400",
      "logSize": "112"
    },
    {
      "logName": "uc.d20200508.t120323.log",
      "logDate": "2020-05-08 12:03:23 -0400",
      "logSize": "112"
    }
  ]
}



Download Log Files

Description

URI

http://host_name/uc/resources/serveroperation/downloadlog

HTTP Method

GET

Description

Retrieve the log details using a specific query parameter.

Example URI

Authentication

HTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

application/octet-stream

Request Parameter

See Download Log Files: Request Parameter.


Download Log Files: Request Parameter

The following request parameter will be needed for download a log file. This is a List type request parameter; you can request multiple files using the same parameter name.

Property

UI Field Name

Description

Specifications

 Required

logName

n/a

Request parameter to add the files for download.

String value of the log file name.

 Y