Skip to content

Integrations

ucmdb_rest.integration.Integrations(server)

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

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

clear_cache(job_details)

This function clears the integration cache for a specific job (or jobs) inside a specific integration point

Parameters:

Name Type Description Default
job_details dict

This is a dictionary which contains the integration point and which jobs are to be cleared. Use the getIntegrationDetails to retrieve the Integration Name and the Job names. For example: {"IntegrationName":["JobName1","JobName2"]}

 required

Returns:

Type Description
response

A Requests response containing the return status code of the clear or some text with an error message
Source code in ucmdb_rest\integration.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def clear_cache(self, job_details):
    """
    This function clears the integration cache for a specific job (or jobs)
    inside a specific integration point

    Parameters
    ----------
    job_details : dict
        This is a dictionary which contains the integration point and which 
        jobs are to be cleared.  Use the getIntegrationDetails to retrieve
        the Integration Name and the Job names.  For example:
        {"IntegrationName":["JobName1","JobName2"]}

    Returns
    -------
    Request.response
        A Requests response containing the return status code of the clear
        or some text with an error message
    """
    url = '/integration/jobs'
    params = {'operation':'clearcache'}
    return self.server._request("PATCH", url, params=params, json=job_details)

getIntegrationDetails(integrationpoint, detail=False)

Retrieves information about a specific integration point.

This function makes a GET request to the UCMDB server to retrieve information about a specific integration point.

Parameters:

Name Type Description Default
integrationpoint str

An integration point name to get the details from.

 required
detail bool

This returns either verbose or non-verbose information. Must be set to True or False.

 False

Returns:

Type Description
Response

A dictionary object containing the details of a specific integration point. Example (with true details): { "adapterCategory": "", "allProperties": {}, "federationConfig": { "supportedCITs": [], "supportedAttributesForClasses": {}, "selectedCITs": {}, "selectedAttributesForClasses": {} }, "populationConfig": { "supportedQueries": [], "supportedQueriesTree": { "name": "Root", "path": null, "children": [], "query": false, "folder": true }, "jobs": [], "populationUsesQueries": true, "hasToHaveJob": false, "allowJob": false }, "dataPushConfig": { "supportedQueries": [], "jobs": [] }, "supportChanges": false, "federationSupported": false, "populationSupported": false, "dataPushSupported": false, "remoteDeploySupported": false, "createMapforceFilesSupported": false, "resourcesLocator": false, "populationResourcesLocator": false, "pushResourcesLocator": false, "supportRepopulate": false, "selectedCIId": null, "dataStoreAdapterWrapper": { "adapterName": "ApiAdapter", "displayName": "UCMDB API Population", "description": "Allows defining Reconciliation Priority for API Data In flows", "category": "", "docName": "", "protocols": [], "supportChanges": false, "federationSupported": false, "populationSupported": false, "dataPushSupported": false, "remoteDeploySupported": false, "createMapforceFilesSupported": false, "resourcesLocator": false, "populationResourcesLocator": false, "pushResourcesLocator": false, "supportRepopulate": false, "isBaseOnTriggerCI": false, "allAdaptersProperties": {}, "tqlNodeNames": null, "tql": null, "baseOnTriggerCI": false }, "federationSelectedCIT": null, "name": "UCMDBDiscovery", "adapterName": "ApiAdapter", "description": null, "enabled": true }

dict A dictionary object containing the details of a specific integration point. Example (with false details): { "status": null, "successPopulationJob": -1, "errorPopulationJob": -1, "warningPopulationJob": -1, "totalPopulationJob": -1, "successPushJob": -1, "errorPushJob": -1, "warningPushJob": -1, "totalPushJob": -1, "allFederationSelectedCITs": 0, "federationSelectedCIT": "", "dataPopulationJobs": [], "dataPushJobs": [], "operationPushBlackItem": false, "serverSide": false, "basedOnTriggerCI": false, "name": "UCMDBDiscovery", "adapterName": "ApiAdapter", "description": null, "enabled": true }
Source code in ucmdb_rest\integration.py 
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 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
106
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
def getIntegrationDetails(self, integrationpoint, detail=False):
    """
    Retrieves information about a specific integration point.

    This function makes a GET request to the UCMDB server to 
    retrieve information about a specific integration point.

    Parameters
    ----------
    integrationpoint : str
        An integration point name to get the details from.
    detail : bool
        This returns either verbose or non-verbose information. Must
        be set to True or False.

    Returns
    -------
    requests.Response
        A dictionary object containing the details of a specific 
        integration point. Example (with true details):
        {
          "adapterCategory": "",
          "allProperties": {},
          "federationConfig": {
            "supportedCITs": [],
            "supportedAttributesForClasses": {},
            "selectedCITs": {},
            "selectedAttributesForClasses": {}
          },
          "populationConfig": {
            "supportedQueries": [],
            "supportedQueriesTree": {
              "name": "Root",
              "path": null,
              "children": [],
              "query": false,
              "folder": true
            },
            "jobs": [],
            "populationUsesQueries": true,
            "hasToHaveJob": false,
            "allowJob": false
          },
          "dataPushConfig": {
            "supportedQueries": [],
            "jobs": []
          },
          "supportChanges": false,
          "federationSupported": false,
          "populationSupported": false,
          "dataPushSupported": false,
          "remoteDeploySupported": false,
          "createMapforceFilesSupported": false,
          "resourcesLocator": false,
          "populationResourcesLocator": false,
          "pushResourcesLocator": false,
          "supportRepopulate": false,
          "selectedCIId": null,
          "dataStoreAdapterWrapper": {
            "adapterName": "ApiAdapter",
            "displayName": "UCMDB API Population",
            "description": "Allows defining Reconciliation Priority for API Data In flows",
            "category": "",
            "docName": "",
            "protocols": [],
            "supportChanges": false,
            "federationSupported": false,
            "populationSupported": false,
            "dataPushSupported": false,
            "remoteDeploySupported": false,
            "createMapforceFilesSupported": false,
            "resourcesLocator": false,
            "populationResourcesLocator": false,
            "pushResourcesLocator": false,
            "supportRepopulate": false,
            "isBaseOnTriggerCI": false,
            "allAdaptersProperties": {},
            "tqlNodeNames": null,
            "tql": null,
            "baseOnTriggerCI": false
          },
          "federationSelectedCIT": null,
          "name": "UCMDBDiscovery",
          "adapterName": "ApiAdapter",
          "description": null,
          "enabled": true
        }

        dict
            A dictionary object containing the details of a specific 
            integration point. Example (with false details):
            {
              "status": null,
              "successPopulationJob": -1,
              "errorPopulationJob": -1,
              "warningPopulationJob": -1,
              "totalPopulationJob": -1,
              "successPushJob": -1,
              "errorPushJob": -1,
              "warningPushJob": -1,
              "totalPushJob": -1,
              "allFederationSelectedCITs": 0,
              "federationSelectedCIT": "",
              "dataPopulationJobs": [],
              "dataPushJobs": [],
              "operationPushBlackItem": false,
              "serverSide": false,
              "basedOnTriggerCI": false,
              "name": "UCMDBDiscovery",
              "adapterName": "ApiAdapter",
              "description": null,
              "enabled": true
            }
    """
    safe_ip_name = quote(integrationpoint)
    detail_str = str(detail).lower()
    url = f'/integration/integrationpoints/{safe_ip_name}?detail={detail_str}'
    return self.server._request("GET",url)

getIntegrationInfo()

Retrieves information about integration points.

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

Returns:

Type Description
Response

A dictionary object containing the details of all integration points. Example: { "HistoryDataSource": { "status": "SUCESSFULL", "successPopulationJob": 0, "errorPopulationJob": 0, "warningPopulationJob": 0, "totalPopulationJob": 0, "successPushJob": 0, "errorPushJob": 0, "warningPushJob": 0, "totalPushJob": 0, "allFederationSelectedCITs": 4, "federationSelectedCIT": null, "dataPopulationJobs": [], "dataPushJobs": [], "operationPushBlackItem": false, "serverSide": true, "basedOnTriggerCI": false, "name": "HistoryDataSource", "adapterName": "CmdbHistoryAdapter", "description": "", "enabled": true }, "UCMDBDiscovery": { "status": "SUCESSFULL", "successPopulationJob": 0, "errorPopulationJob": 0, "warningPopulationJob": 0, "totalPopulationJob": 0, "successPushJob": 0, "errorPushJob": 0, "warningPushJob": 0, "totalPushJob": 0, "allFederationSelectedCITs": 0, "federationSelectedCIT": null, "dataPopulationJobs": [], "dataPushJobs": [], "operationPushBlackItem": false, "serverSide": true, "basedOnTriggerCI": false, "name": "UCMDBDiscovery", "adapterName": "ApiAdapter", "description": "", "enabled": true } }
Source code in ucmdb_rest\integration.py 
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
192
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
def getIntegrationInfo(self):
    """
    Retrieves information about integration points.

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

    Returns
    -------
    requests.Response
        A dictionary object containing the details of all 
        integration points. Example:
        {
          "HistoryDataSource": {
            "status": "SUCESSFULL",
            "successPopulationJob": 0,
            "errorPopulationJob": 0,
            "warningPopulationJob": 0,
            "totalPopulationJob": 0,
            "successPushJob": 0,
            "errorPushJob": 0,
            "warningPushJob": 0,
            "totalPushJob": 0,
            "allFederationSelectedCITs": 4,
            "federationSelectedCIT": null,
            "dataPopulationJobs": [],
            "dataPushJobs": [],
            "operationPushBlackItem": false,
            "serverSide": true,
            "basedOnTriggerCI": false,
            "name": "HistoryDataSource",
            "adapterName": "CmdbHistoryAdapter",
            "description": "",
            "enabled": true
          },
          "UCMDBDiscovery": {
            "status": "SUCESSFULL",
            "successPopulationJob": 0,
            "errorPopulationJob": 0,
            "warningPopulationJob": 0,
            "totalPopulationJob": 0,
            "successPushJob": 0,
            "errorPushJob": 0,
            "warningPushJob": 0,
            "totalPushJob": 0,
            "allFederationSelectedCITs": 0,
            "federationSelectedCIT": null,
            "dataPopulationJobs": [],
            "dataPushJobs": [],
            "operationPushBlackItem": false,
            "serverSide": true,
            "basedOnTriggerCI": false,
            "name": "UCMDBDiscovery",
            "adapterName": "ApiAdapter",
            "description": "",
            "enabled": true
          }
        }
    """
    url = '/integration/integrationpoints'
    return self.server._request("GET",url)

setEnabledState(integration_id, enabled=True)

This method will either enable or disable a given integration point.

Parameters:

Name Type Description Default
integration_id str

An integration point name.

 required
enabled bool

This is to enable (True) or Disable (False) the integration point.

 True

Returns:

Type Description
Response

A dictionary object containing the details of a specific integration point. for Example: { "errorCode": 200, "errorSource": null, "message": { "code": 2200, "parameter": null, "description": null, "errorParametersValues": [ "Test_Excel_import" ], "errorMap": null, "parametrizedError": true }, "details": null, "recommendedActions": null, "nestedErrors": null, "data": null }
Source code in ucmdb_rest\integration.py 
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
def setEnabledState(self, integration_id, enabled=True):
    """
    This method will either enable or disable a given integration point.

    Parameters
    ----------
    integration_id : str
        An integration point name.
    enabled : bool
        This is to enable (True) or Disable (False) the integration point.

    Returns
    -------
    requests.Response
        A dictionary object containing the details of a specific 
        integration point.
        for Example:
          {
            "errorCode": 200,
            "errorSource": null,
            "message": {
              "code": 2200,
              "parameter": null,
              "description": null,
              "errorParametersValues": [
                "Test_Excel_import"
              ],
              "errorMap": null,
              "parametrizedError": true
            },
            "details": null,
            "recommendedActions": null,
            "nestedErrors": null,
            "data": null
          }
    """
    url = f'/integration/integrationpoints/{integration_id}'
    params = {'enabled':enabled}
    return self.server._request("PATCH", url, params=params)

syncIntegrationPointJob(integration_id, job_id, operationtype='population_full')

This function will run a synchronization of a current job under an integration point. It can run population_full, population_delta, push_full or push_delta

Parameters:

Name Type Description Default
integration_id str

An integration point name.

 required
job_id str

The name of the job to run the action on

 required
operationtype str

The operations, restricted to this list: population_full, population_delta, push_full or push_delta

 'population_full'

Returns:

Type Description
Response

A dictionary object containing the results of the operation on the job inside the integration point. For Example: { "errorCode": 200, "errorSource": null, "message": { "code": 13200, "parameter": null, "description": null, "errorParametersValues": [ "POPULATION_DELTA" ], "errorMap": null, "parametrizedError": true }, "details": null, "recommendedActions": null, "nestedErrors": null, "data": null }
Source code in ucmdb_rest\integration.py 
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
def syncIntegrationPointJob(self, integration_id, job_id, operationtype="population_full"):
    """
    This function will run a synchronization of a current job under an integration 
    point.  It can run population_full, population_delta, push_full or push_delta

    Parameters
    ----------
    integration_id : str
        An integration point name.
    job_id : str
        The name of the job to run the action on
    operationtype : str
        The operations, restricted to this list: population_full, population_delta, push_full
        or push_delta

    Returns
    -------
    requests.Response
        A dictionary object containing the results of the operation on the job inside the
        integration point.
        For Example:
        {
          "errorCode": 200,
          "errorSource": null,
          "message": {
            "code": 13200,
            "parameter": null,
            "description": null,
            "errorParametersValues": [
              "POPULATION_DELTA"
            ],
            "errorMap": null,
            "parametrizedError": true
          },
          "details": null,
          "recommendedActions": null,
          "nestedErrors": null,
          "data": null
        }
    """
    params = {'operationtype':operationtype}
    job_id = quote(job_id)
    url = f'/integration/integrationpoints/{integration_id}/jobs/{job_id}'
    return self.server._request("PATCH",url, params=params)