Skip to content

Settings

ucmdb_rest.settings.Settings(server)

Initialize the service with a reference to the main level UCMDB server

Source code in ucmdb_rest\settings.py 
17
18
19
20
21
def __init__(self, server):
    """
    Initialize the service with a reference to the main level UCMDB server
    """
    self.server = server

addRecipients(recipient_dict)

Updates a recipient with a display label and email address(es). Uses a POST call to the UCMDB REST API.

Parameters:

Name Type Description Default
recipient_dict dict

A dictionary containing recipient details. For example: { "id": "", "name": "Keith", "addresses": [ "kpaschal@mycompany.com" ] }

 required

Returns:

Type Description
Response

A list of dictionaries containing the user/email address(es). For example: [ { "name": "Keith", "addresses": [ "kpaschal@mycompany.com" ], "id": "23005b6794db6c48eb18288ef0879194" } ]
Source code in ucmdb_rest\settings.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
def addRecipients(self, recipient_dict):
    """
    Updates a recipient with a display label and email address(es). Uses
    a POST call to the UCMDB REST API.

    Parameters
    ----------
    recipient_dict : dict
        A dictionary containing recipient details. For example:
            {
                "id": "",
                "name": "Keith",
                "addresses": [
                    "kpaschal@mycompany.com"
                ]
            }

    Returns
    -------
    requests.Response
        A list of dictionaries containing the user/email address(es).
        For example:
            [
                {
                    "name": "Keith",
                    "addresses": [
                        "kpaschal@mycompany.com"
                    ],
                    "id": "23005b6794db6c48eb18288ef0879194"
                }
            ]
    """
    url = '/administration/recipients'
    return self.server._request("POST",url,json=recipient_dict)

deleteRecipients(id_to_delete)

This method deletes a user from the recipients manager via a DELETE call to the REST API in UCMDB.

Parameters:

Name Type Description Default
id_to_delete str

ID, which can be retrieved from a 'getRecipients' call.

 required

Returns:

Type Description
Response

Exits with a 204 HTTP code... So nothing should be returned.
Source code in ucmdb_rest\settings.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
def deleteRecipients(self, id_to_delete):
    """
    This method deletes a user from the recipients manager via a
    DELETE call to the REST API in UCMDB.

    Parameters
    ----------
    id_to_delete : str
        ID, which can be retrieved from a 'getRecipients' call.

    Returns
    -------
    requests.Response
        Exits with a 204 HTTP code... So nothing should be
        returned.

    """
    url = f'/administration/recipients?ids={id_to_delete}'
    return self.server._request("DELETE",url)

getRecipients()

Gets a list of recipients from UCMDB via a REST API GET call.

Returns:

Type Description
Response

A list of dictionaries with recipient details. For example: [ { "name": "Joe", "addresses": [ "joe@mycompany.com" ], "id": "dc1942e4a816a0f5fe663d8gcg9222fd" }, { "name": "Keith", "addresses": [ "keithpaschal@mycompany.com", "kpaschal@mycompany.com" ], "id": "f72f7d7b61af053d0fa984360419e79e" } ]
Source code in ucmdb_rest\settings.py 
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
def getRecipients(self):
    """
    Gets a list of recipients from UCMDB via a REST API GET call.

    Returns
    -------
    requests.Response
        A list of dictionaries with recipient details. For example:
            [
                {
                    "name": "Joe",
                    "addresses": [
                        "joe@mycompany.com"
                    ],
                    "id": "dc1942e4a816a0f5fe663d8gcg9222fd"
                },
                {
                    "name": "Keith",
                    "addresses": [
                        "keithpaschal@mycompany.com",
                        "kpaschal@mycompany.com"
                    ],
                    "id": "f72f7d7b61af053d0fa984360419e79e"
                }
            ]
    """
    url = '/administration/recipients'
    return self.server._request("GET",url)

getSetting(setting, locale='en')

Retrieves a setting from UCMDB.

This function makes a GET request to the UCMDB server to retrieve the information.

Parameters:

Name Type Description Default
setting str

Setting to retrieve in the format shown in the UCMDB CMS UI. For example: multi.tenancy.global.default.tenant_id

 required
locale str

Language to use. Supported locales are: da, de, el, en, es, fr, is, it, ja, ko, nb, nl, pl, pt_BR, pt_PT, ru, sv, tr, zh_CN. Default is 'en'.

 'en'

Returns:

Type Description
Response

A dictionary object containing the details of the setting. Example: { "name": "multi.tenancy.global.default.tenant_id", "value": "System Default Tenant", "valueType": "STRING", "defaultValue": "System Default Tenant", "factoryValue": "System Default Tenant", "displayName": "Global MSPTenant", "description": "Global MSP Tenant id, this tenant will be created at start up if multitenancy enabled", "refreshRate": "Reboot", "displayInUI": false, "sectionName": "section.general", "sectionDisplayName": "General Settings", "scope": "GLOBAL", "editable": true, "displayType": "string" }
Source code in ucmdb_rest\settings.py 
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
def getSetting(self, setting, locale='en'):
    """
    Retrieves a setting from UCMDB.

    This function makes a GET request to the UCMDB server to 
    retrieve the information.

    Parameters
    ----------
    setting : str
        Setting to retrieve in the format shown in the UCMDB CMS UI.
        For example: multi.tenancy.global.default.tenant_id
    locale : str, optional
        Language to use. Supported locales are: da, de, el, en, es, fr,
        is, it, ja, ko, nb, nl, pl, pt_BR, pt_PT, ru, sv, tr, zh_CN.
        Default is 'en'.

    Returns
    -------
    requests.Response
        A dictionary object containing the details of the setting.
        Example:
        {
        "name": "multi.tenancy.global.default.tenant_id",
        "value": "System Default Tenant",
        "valueType": "STRING",
        "defaultValue": "System Default Tenant",
        "factoryValue": "System Default Tenant",
        "displayName": "Global MSPTenant",
        "description": "Global MSP Tenant id, this tenant will be 
                        created at start up if multitenancy enabled",
        "refreshRate": "Reboot",
        "displayInUI": false,
        "sectionName": "section.general",
        "sectionDisplayName": "General Settings",
        "scope": "GLOBAL",
        "editable": true,
        "displayType": "string"
        }
    """
    url = f'/settings/{setting}?locale={locale}'
    return self.server._request("GET",url)

setSetting(setting, body, locale='en')

Sets a setting in UCMDB.

Parameters:

Name Type Description Default
setting str

Setting to retrieve in the format shown in the UCMDB CMS UI. For example: multi.tenancy.global.default.tenant_id.

 required
body dict

Contains the value to be set. For example: { "value": "myuser@opentext.com" }

 required
locale str

Language to use. Supported locales are: da, de, el, en, es, fr, is, it, ja, ko, nb, nl, pl, pt_BR, pt_PT, ru, sv, tr, zh_CN. Default is 'en'.

 'en'

Returns:

Type Description
Response

JSON values after the set is complete. For example: { "name": "email.send.from", "value": "myuser@opentext.com", "valueType": "STRING", "defaultValue": "admin@opentext.com", "factoryValue": "admin@ucmdb.com", "displayName": "settings.email.send.from.name.name", "description": "settings.email.send.from.name.desc", "refreshRate": "Login", "displayInUI": true, "sectionName": "section.mail", "sectionDisplayName": "section.mail", "scope": "CUSTOMER", "editable": true, "displayType": "email" }
Source code in ucmdb_rest\settings.py 
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
def setSetting(self, setting, body, locale='en'):
    """
    Sets a setting in UCMDB.

    Parameters
    ----------
    setting : str
        Setting to retrieve in the format shown in the UCMDB CMS UI.
        For example: multi.tenancy.global.default.tenant_id.
    body : dict
        Contains the value to be set. For example:
            {
                "value": "myuser@opentext.com"
            }
    locale : str, optional
        Language to use. Supported locales are: da, de, el, en, es, fr,
        is, it, ja, ko, nb, nl, pl, pt_BR, pt_PT, ru, sv, tr, zh_CN.
        Default is 'en'.

    Returns
    -------
    requests.Response
        JSON values after the set is complete. For example:
            {
                "name": "email.send.from",
                "value": "myuser@opentext.com",
                "valueType": "STRING",
                "defaultValue": "admin@opentext.com",
                "factoryValue": "admin@ucmdb.com",
                "displayName": "settings.email.send.from.name.name",
                "description": "settings.email.send.from.name.desc",
                "refreshRate": "Login",
                "displayInUI": true,
                "sectionName": "section.mail",
                "sectionDisplayName": "section.mail",
                "scope": "CUSTOMER",
                "editable": true,
                "displayType": "email"
            }
    """
    url = f'/settings/{setting}?locale={locale}'
    return self.server._request("PUT",url,json=body)

updateRecipients(id_to_update, dict_to_update)

This method updates a user from the recipients manager via a PUT call to the REST API in UCMDB.

Parameters:

Name Type Description Default
id_to_update str

ID, which can be retrieved from a 'getRecipients' call.

 required
dict_to_update dict

Dictionary containing the modification to be made, for example::

{
    "name": "Keith",
    "addresses": [
        "keithp@mycompany.com",
        "kp@mycompany.com",
        "kp@mycompany.org",
        "kpaschal@mycompany.com"
    ],
    "id": "231f6bfe675f41225bc7dd87622ce82d"
}
required

Returns:

Type Description
Response

Dictionary with the result of the update. For example::

{
    "name": "Keith",
    "addresses": [
        "keithp@mycompany.com",
        "kp@mycompany.com",
        "kp@mycompany.org",
        "kpaschal@mycompany.com"
    ],
    "id": "231f6bfe675f41225bc7dd87622ce82d"
}
Source code in ucmdb_rest\settings.py 
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
def updateRecipients(self, id_to_update, dict_to_update):
    """
    This method updates a user from the recipients manager via a
    PUT call to the REST API in UCMDB.

    Parameters
    ----------
    id_to_update : str
        ID, which can be retrieved from a 'getRecipients' call.
    dict_to_update : dict
        Dictionary containing the modification to be made, for
        example::

            {
                "name": "Keith",
                "addresses": [
                    "keithp@mycompany.com",
                    "kp@mycompany.com",
                    "kp@mycompany.org",
                    "kpaschal@mycompany.com"
                ],
                "id": "231f6bfe675f41225bc7dd87622ce82d"
            }

    Returns
    -------
    requests.Response
        Dictionary with the result of the update. For example::

            {
                "name": "Keith",
                "addresses": [
                    "keithp@mycompany.com",
                    "kp@mycompany.com",
                    "kp@mycompany.org",
                    "kpaschal@mycompany.com"
                ],
                "id": "231f6bfe675f41225bc7dd87622ce82d"
            }

    """
    url = f'/administration/recipients/{id_to_update}'
    return self.server._request("PUT", url, json=dict_to_update)