Skip to end of metadata
Go to start of metadata

View My buddy settings

Available in 14 starting with 14.10

Resource URI: /imbot/settings

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description





Specific Response Codes: N/A

HTTP Method: GET

Retrieves a list with all the My buddy settings in the system.

Example: XML format

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>

<Settings>

<Setting>

<path>imbot/log.level</path>

<type>enum</type>

<options>

<entry>

<key>NOTICE</key>

</entry>

<entry>

<key>CRIT</key>

</entry>

<entry>

<key>EMERG</key>

</entry>

<entry>

<key>WARNING</key>

</entry>

<entry>

<key>ERR</key>

</entry>

<entry>

<key>INFO</key>

</entry>

<entry>

<key>ALERT</key>

</entry>

<entry>

<key>DEBUG</key>

</entry>

</options>

<value>NOTICE</value>

<defaultValue>NOTICE</defaultValue>

<label>Logging Level</label>

</Setting>

<Setting>

<path>imbot/_imbot.paUserName</path>

<type>string</type>

<value>mybuddy</value>

<defaultValue>mybuddy</defaultValue>

<label>IM ID</label>

<description>The ID under which ImBot feature is visible in the contact list.</description>

</Setting>

<Setting>

<path>imbot/imbot.paPassword</path>

<type>string</type>

<label>IM password</label>

<description>If IM server is configured to use LDAP you need to assign a dedicated account to play MyBuddy role. Set MyBuddy's password accordingly with LDAP account password. Leave the default password if IM server is not configured to use LDAP.</description>

</Setting>

</Settings>

JSON format

{

settings: [3]

0: {

path: "imbot/log.level"

type: "enum"

options: {

NOTICE: null

CRIT: null

EMERG: null

WARNING: null

ERR: null

INFO: null

ALERT: null

DEBUG: null

}-

value: "NOTICE"

defaultValue: "NOTICE"

label: "Logging Level"

description: null

}-

1: {

path: "imbot/_imbot.paUserName"

type: "string"

options: null

value: "mybuddy"

defaultValue: "mybuddy"

label: "IM ID"

description: "The ID under which ImBot feature is visible in the contact list."

}-

2: {

path: "imbot/imbot.paPassword"

type: "string"

options: null

value: null

defaultValue: null

label: "IM password"

description: "If IM server is configured to use LDAP you need to assign a dedicated account to play MyBuddy role. Set MyBuddy's password accordingly with LDAP account password. Leave the default password if IM server is not configured to use LDAP."

}-

-

}

Unsupported HTTP Method: PUT, POST, DELETE

View or modify My buddy settings

Available in 14 starting with 14.10

Resource URI: /imbot/settings/{settingPath}

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description





Specific Response Codes: N/A

HTTP Method: GET

Retrieves My buddy options for the setting from the specified path.

Example: XML format

<Setting>

<path>imbot/_imbot.paUserName</path>

<type>string</type>

<value>mybuddy</value>

<defaultValue>mybuddy</defaultValue>

<label>IM ID</label>

<description>The ID under which ImBot feature is visible in the contact list.</description>

</Setting>

JSON format

{

path: "imbot/_imbot.paUserName"

type: "string"

options: null

value: "mybuddy"

defaultValue: "mybuddy"

label: "IM ID"

description: "The ID under which ImBot feature is visible in the contact list."

}

HTTP Method: PUT

Modifies My buddy options for the setting from the specified path.

HTTP Method: DELETE

Deletes My buddy options for the setting from the specified path.

Unsupported HTTP Method: POST

  • No labels