Jump to

• Request
• Response
• Examples

Set Antivirus

put

/essbase/rest/v1/filescanner

Sets the antivirus details for scanning files. Virus scanning is available to ensure that files loaded into Essbase are virus-free. Antivirus software should have ICAP support.

Request

Supported Media Types

• application/json
• application/xml

Body ()

Antivirus details.

Root Schema : AVClientInfo

Type: object

Show Source

• enabled(optional): boolean

  true if the virus scanner is enabled; false otherwise.

• host(optional): string

  Host for the virus scanner ICAP server.

• port(optional): integer(int32)

  Port for the virus scanner ICAP server.

{
    "type":"object",
    "properties":{
        "enabled":{
            "type":"boolean",
            "description":"<p><b>true</b> if the virus scanner is enabled; <b>false</b> otherwise.</p>"
        },
        "host":{
            "type":"string",
            "description":"<p>Host for the virus scanner ICAP server.</p>"
        },
        "port":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Port for the virus scanner ICAP server.</p>"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

The operation completed successfully.

Body ()

Root Schema : AVClientInfo

Type: object

Show Source

• enabled(optional): boolean

  true if the virus scanner is enabled; false otherwise.

• host(optional): string

  Host for the virus scanner ICAP server.

• port(optional): integer(int32)

  Port for the virus scanner ICAP server.

{
    "type":"object",
    "properties":{
        "enabled":{
            "type":"boolean",
            "description":"<p><b>true</b> if the virus scanner is enabled; <b>false</b> otherwise.</p>"
        },
        "host":{
            "type":"string",
            "description":"<p>Host for the virus scanner ICAP server.</p>"
        },
        "port":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Port for the virus scanner ICAP server.</p>"
        }
    }
}

400 Response

Bad Request

Failed to set the antivirus details.

Back to Top

Examples

The following example shows how to configure the antivirus scanner for Essbase.

This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.

Script with cURL Command

call properties.bat
curl -X PUT "https://myserver.example.com:9001/essbase/rest/v1/filescanner" -H Accept:application/json -H Content-Type:application/json -d '{"enabled": true, "host": "https://myserver.example.com", "port": 1344}' -u %User%:%Password%

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "enabled" : true,
  "host" : "https://myserver.example.com",
  "port" : 1344
}

Back to Top