Skip to content

Powertrain Organization API Client

Bases: BasePowertrainAPIClient

Powertrain Organization API Client.

Swagger Documentation

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
 40
 41
 42
 43
 44
 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
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
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
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
264
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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
class PowertrainOrganizationAPIClient(BasePowertrainAPIClient):
    """
    Powertrain Organization API Client.

    [Swagger Documentation](https://motion-pt-dev-we-organization-api.azurewebsites.net/swagger/index.html)
    """

    _status_prefix = "/organization"

    def checks_if_the_user_has_access_to_the_specified_assets(
        self, data_in: CheckAccessToAssetsQuery
    ) -> ListOfIntegersResponse:
        """Checks if the user has access to the specified assets.

        If user has access to asset, then it returns
            list of assets with access status.

        Args:
            data_in: CheckAccessToAssetsQuery
        Returns:
            ListOfIntegersResponse
        """

        endpoint = "/organization/Assets/Access"
        data = data_in.model_dump(by_alias=True)
        response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
        response_model = self._decode_response_to_model(response, ListOfIntegersResponse)
        return response_model

    def checks_if_the_user_has_access_to_the_specified_asset(self, asset_id: int) -> bool:
        """Checks if the user has access to the specified asset.

        Args:
           asset_id:int
        Returns:
            bool
        """

        endpoint = f"organization/Assets/Access/{asset_id}"
        response = self._make_request(method="GET", endpoint=endpoint)
        decoded_response: bool = self._decode_response(response=response, default=False)
        return decoded_response

    def get_all_assets_of_the_sites_or_asset_groups(self, data_in: GetAssetsQuery) -> AssetsSearchPostResponse:
        """Get all assets of the sites and/or asset groups.

        Args:
            data_in: GetAssetsQuery
        Returns:
            AssetsSearchPostResponse
        """

        endpoint = "/organization/Assets/Search"
        data = data_in.model_dump(by_alias=True)
        response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
        response_model = self._decode_response_to_model(response, AssetsSearchPostResponse)
        return response_model

    def get_all_assets_of_the_organizations(
        self, data_in: GetAssetsByOrganizationIdsQuery
    ) -> AssetsSearchPostResponse:
        """Get all assets of the organizations.

        Args:
            data_in: GetAssetsByOrganizationIdsQuery
        Returns:
            AssetsSearchPostResponse
        """

        endpoint = "/organization/Assets/SearchByOrganizationIds"
        data = data_in.model_dump(by_alias=True)
        response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
        response_model = self._decode_response_to_model(response, AssetsSearchPostResponse)
        return response_model

    def get_asset_by_id(self, asset_id: int) -> Asset:
        """Get asset by id.

        Args:
           asset_id:int
        Returns:
            Asset
        """

        endpoint = f"/organization/Assets/{asset_id}"
        response = self._make_request(method="GET", endpoint=endpoint)
        response_model = self._decode_response_to_model(response, Asset)
        return response_model

    def get_list_of_tags_for_a_specific_asset(self, asset_id: int) -> AssetsIdTagsResponse:
        """Returns the list of tags for a specific asset.

        Args:
           asset_id:int
        Returns:
            AssetsIdTagsResponse
        """

        endpoint = f"/organization/Assets/{asset_id}/Tags"
        response = self._make_request(method="GET", endpoint=endpoint)
        response_model = self._decode_response_to_model(response, AssetsIdTagsResponse)
        return response_model

    def get_full_asset_structure(self, data_in: GetAssetStructureByIdsQuery) -> AssetsGetAssetStructurePostResponse:
        """Return full asset structure.

        Args:
            data_in: GetAssetStructureByIdsQuery
        Returns:
            AssetsGetAssetStructurePostResponse
        """

        endpoint = "/organization/Assets/GetAssetStructure"
        data = data_in.model_dump(by_alias=True)
        response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
        response_model = self._decode_response_to_model(response, AssetsGetAssetStructurePostResponse)
        return response_model

    def search_for_organization_by_the_specified_filter(
        self, data_in: GetOrganizationInfoQuery
    ) -> OrganizationSearchPostResponse:
        """Search for organization by the specified filter.

        Args:
            data_in: GetOrganizationInfoQuery
        Returns:
            OrganizationSearchPostResponse
        """

        endpoint = "/api/organization/Search"
        data = data_in.model_dump(by_alias=True)
        response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
        response_model = self._decode_response_to_model(response, OrganizationSearchPostResponse)
        return response_model

    def search_for_organizations_structures_by_the_specified_filter(
        self, data_in: GetOrganizationStructureQuery
    ) -> OrganizationStructurePostResponse:
        """Search for organizations structures by the specified filter.

        Args:
            data_in: GetOrganizationStructureQuery
        Returns:
            OrganizationStructurePostResponse
        """

        endpoint = "/api/organization/Structure"
        data = data_in.model_dump(by_alias=True)
        response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
        response_model = self._decode_response_to_model(response, OrganizationStructurePostResponse)
        return response_model

    def get_the_unique_asset_tag_values_for_a_specific_organization(
        self, organization_id: int
    ) -> ListOfTagsInfoResponse:
        """Returns all the unique asset tag values for a specific organization.

        Args:
           organization_id:int
        Returns:
            ListOfTagsInfoResponse
        """

        endpoint = f"/api/organization/{organization_id}/Tags"
        response = self._make_request(method="GET", endpoint=endpoint)
        response_model = self._decode_response_to_model(response, ListOfTagsInfoResponse)
        return response_model

    def search_for_powertrains_by_the_specified_filter(
        self, data_in: GetPowertrainInfoQuery
    ) -> PowertrainSearchPostResponse:
        """Search for powertrains by the specified filter.

        Args:
            data_in: GetPowertrainInfoQuery
        Returns:
            PowertrainSearchPostResponse
        """

        endpoint = "/api/organization/Powertrain/Search"
        data = data_in.model_dump(by_alias=True)
        response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
        response_model = self._decode_response_to_model(response, PowertrainSearchPostResponse)
        return response_model

    def get_all_powertrains_of_the_sites(self, data_in: GetPowertrainsQuery) -> PowertrainsSearchPostResponse:
        """Get all powertrains of the sites.

        Args:
            data_in: GetPowertrainsQuery
        Returns:
            PowertrainsSearchPostResponse
        """

        endpoint = "/organization/Powertrains/Search"
        data = data_in.model_dump(by_alias=True)
        response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
        response_model = self._decode_response_to_model(response, PowertrainsSearchPostResponse)
        return response_model

    def get_powertrain_by_id(self, powertrain_id: int) -> Powertrain:
        """Get powertrain by id.

        Args:
           powertrain_id:int
        Returns:
            Powertrain
        """

        endpoint = f"/organization/Powertrains/{powertrain_id}"
        response = self._make_request(method="GET", endpoint=endpoint)
        response_model = self._decode_response_to_model(response, Powertrain)
        return response_model

    def checks_if_the_user_has_access_to_the_specified_sites(
        self, data_in: CheckAccessToSitesQuery
    ) -> ListOfIntegersResponse:
        """Checks if the user has access to the specified sites.

        Args:
            data_in: CheckAccessToSitesQuery
        Returns:
            ListOfIntegersResponse
        """

        endpoint = "/organization/Sites/Access"
        data = data_in.model_dump(by_alias=True)
        response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
        response_model = self._decode_response_to_model(response, ListOfIntegersResponse)
        return response_model

    def checks_if_the_user_has_access_to_the_specified_site(self, site_id: int) -> bool:
        """Checks if the user has access to the specified site.

        Args:
           site_id:int
        Returns:
            bool
        """

        endpoint = f"/organization/Sites/Access/{site_id}"
        response = self._make_request(method="GET", endpoint=endpoint)
        decoded_response: bool = self._decode_response(response=response, default=False)
        return decoded_response

    def get_all_sites_for_the_specified_organizations(self, data_in: GetSitesQuery) -> SitesSearchPostResponse:
        """Get all sites for the specified organizations.

        Args:
            data_in: GetSitesQuery
        Returns:
            SitesSearchPostResponse
        """

        endpoint = "/organization/Sites/Search"
        data = data_in.model_dump(by_alias=True)
        response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
        response_model = self._decode_response_to_model(response, SitesSearchPostResponse)
        return response_model

    def get_site_by_id(self, site_id: int) -> Site:
        """Get site by id.

        Args:
           site_id:int
        Returns:
            Site
        """

        endpoint = f"/organization/Sites/{site_id}"
        response = self._make_request(method="GET", endpoint=endpoint)
        response_model = self._decode_response_to_model(response, Site)
        return response_model

    def get_all_organizations_matching_the_specified_filter(
        self, data_in: OrganizationSearchQuery
    ) -> OrganizationsSearchPostResponse:
        """Get all organizations matching the specified filter.

        Args:
            data_in: OrganizationSearchQuery
        Returns:
            OrganizationsSearchPostResponse
        """

        endpoint = "/organization/Organizations/Search"
        data = data_in.model_dump(by_alias=True)
        response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
        response_model = self._decode_response_to_model(response, OrganizationsSearchPostResponse)
        return response_model

    def get_an_organization_by_legacy_asset_identifier(self, identifier: str) -> Optional[Organization]:
        """Get an organization based on a corresponding asset's SmSeId/serialNumber.

        Args:
           identifier: Legacy identifier, like SmartSensor ID or asset's serial number
        Returns:
            Organization object if found, None otherwise.
        """

        endpoint = f"/organization/Organizations/SearchByAsset/{identifier}"
        response = self._make_request(method="GET", endpoint=endpoint)
        # If the response is 200 and the body is "null", it means that the organization was not found.
        if response and response.status_code == 200 and response.text == "null":
            return None
        response_model = self._decode_response_to_model(response, Organization)
        return response_model

    def get_unique_asset_tag_values_for_a_specific_organization(self, organization_id: int) -> ListOfStringsResponse:
        """Returns all the unique asset tag values for a specific organization.

        Args:
           organization_id:int
        Returns:
            ListOfStringsResponse
        """

        endpoint = f"/organization/Organizations/{organization_id}/Tags"
        response = self._make_request(method="GET", endpoint=endpoint)
        response_model = self._decode_response_to_model(response, ListOfStringsResponse)
        return response_model

    def get_asset_tags(self, asset_id: int) -> ListOfTagsInfoResponse:
        """Get asset tags.

        Args:
           asset_id:int
        Returns:
            ListOfTagsInfoResponse
        """

        endpoint = f"/api/organization/Asset/{asset_id}/Tags"
        response = self._make_request(method="GET", endpoint=endpoint)
        response_model = self._decode_response_to_model(response, ListOfTagsInfoResponse)
        return response_model

    def get_asset_structure_search(self, data_in: AssetStructureSearchQuery) -> AssetStructureSearchPostResponse:
        """Returns full asset structure.

        Args:
            data_in: AssetStructureSearchQuery
        Returns:
            AssetStructureSearchPostResponse
        """

        endpoint = "/api/organization/Asset/Structure/Search"
        data = data_in.model_dump(by_alias=True)
        response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
        response_model = self._decode_response_to_model(response, AssetStructureSearchPostResponse)
        return response_model

    def get_filtered_list_of_assets(self, data_in: AssetSearchQuery) -> AssetSearchPostResponse:
        """Returns filtered list of assets

        Args:
            data_in: AssetSearchQuery
        Returns:
            AssetSearchPostResponse
        """

        endpoint = "/api/organization/Asset/Search"
        data = data_in.model_dump(by_alias=True)
        response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
        response_model = self._decode_response_to_model(response, AssetSearchPostResponse)
        return response_model

checks_if_the_user_has_access_to_the_specified_asset(asset_id)

Checks if the user has access to the specified asset.

Parameters:

Name Type Description Default
asset_id int

int

 required

Returns: bool

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
def checks_if_the_user_has_access_to_the_specified_asset(self, asset_id: int) -> bool:
    """Checks if the user has access to the specified asset.

    Args:
       asset_id:int
    Returns:
        bool
    """

    endpoint = f"organization/Assets/Access/{asset_id}"
    response = self._make_request(method="GET", endpoint=endpoint)
    decoded_response: bool = self._decode_response(response=response, default=False)
    return decoded_response

checks_if_the_user_has_access_to_the_specified_assets(data_in)

Checks if the user has access to the specified assets.

If user has access to asset, then it returns list of assets with access status.

Parameters:

Name Type Description Default
data_in CheckAccessToAssetsQuery

CheckAccessToAssetsQuery

 required

Returns: ListOfIntegersResponse

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
def checks_if_the_user_has_access_to_the_specified_assets(
    self, data_in: CheckAccessToAssetsQuery
) -> ListOfIntegersResponse:
    """Checks if the user has access to the specified assets.

    If user has access to asset, then it returns
        list of assets with access status.

    Args:
        data_in: CheckAccessToAssetsQuery
    Returns:
        ListOfIntegersResponse
    """

    endpoint = "/organization/Assets/Access"
    data = data_in.model_dump(by_alias=True)
    response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
    response_model = self._decode_response_to_model(response, ListOfIntegersResponse)
    return response_model

checks_if_the_user_has_access_to_the_specified_site(site_id)

Checks if the user has access to the specified site.

Parameters:

Name Type Description Default
site_id int

int

 required

Returns: bool

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
271
272
273
274
275
276
277
278
279
280
281
282
283
def checks_if_the_user_has_access_to_the_specified_site(self, site_id: int) -> bool:
    """Checks if the user has access to the specified site.

    Args:
       site_id:int
    Returns:
        bool
    """

    endpoint = f"/organization/Sites/Access/{site_id}"
    response = self._make_request(method="GET", endpoint=endpoint)
    decoded_response: bool = self._decode_response(response=response, default=False)
    return decoded_response

checks_if_the_user_has_access_to_the_specified_sites(data_in)

Checks if the user has access to the specified sites.

Parameters:

Name Type Description Default
data_in CheckAccessToSitesQuery

CheckAccessToSitesQuery

 required

Returns: ListOfIntegersResponse

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
def checks_if_the_user_has_access_to_the_specified_sites(
    self, data_in: CheckAccessToSitesQuery
) -> ListOfIntegersResponse:
    """Checks if the user has access to the specified sites.

    Args:
        data_in: CheckAccessToSitesQuery
    Returns:
        ListOfIntegersResponse
    """

    endpoint = "/organization/Sites/Access"
    data = data_in.model_dump(by_alias=True)
    response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
    response_model = self._decode_response_to_model(response, ListOfIntegersResponse)
    return response_model

get_all_assets_of_the_organizations(data_in)

Get all assets of the organizations.

Parameters:

Name Type Description Default
data_in GetAssetsByOrganizationIdsQuery

GetAssetsByOrganizationIdsQuery

 required

Returns: AssetsSearchPostResponse

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
def get_all_assets_of_the_organizations(
    self, data_in: GetAssetsByOrganizationIdsQuery
) -> AssetsSearchPostResponse:
    """Get all assets of the organizations.

    Args:
        data_in: GetAssetsByOrganizationIdsQuery
    Returns:
        AssetsSearchPostResponse
    """

    endpoint = "/organization/Assets/SearchByOrganizationIds"
    data = data_in.model_dump(by_alias=True)
    response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
    response_model = self._decode_response_to_model(response, AssetsSearchPostResponse)
    return response_model

get_all_assets_of_the_sites_or_asset_groups(data_in)

Get all assets of the sites and/or asset groups.

Parameters:

Name Type Description Default
data_in GetAssetsQuery

GetAssetsQuery

 required

Returns: AssetsSearchPostResponse

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
83
84
85
86
87
88
89
90
91
92
93
94
95
96
def get_all_assets_of_the_sites_or_asset_groups(self, data_in: GetAssetsQuery) -> AssetsSearchPostResponse:
    """Get all assets of the sites and/or asset groups.

    Args:
        data_in: GetAssetsQuery
    Returns:
        AssetsSearchPostResponse
    """

    endpoint = "/organization/Assets/Search"
    data = data_in.model_dump(by_alias=True)
    response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
    response_model = self._decode_response_to_model(response, AssetsSearchPostResponse)
    return response_model

get_all_organizations_matching_the_specified_filter(data_in)

Get all organizations matching the specified filter.

Parameters:

Name Type Description Default
data_in OrganizationSearchQuery

OrganizationSearchQuery

 required

Returns: OrganizationsSearchPostResponse

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
def get_all_organizations_matching_the_specified_filter(
    self, data_in: OrganizationSearchQuery
) -> OrganizationsSearchPostResponse:
    """Get all organizations matching the specified filter.

    Args:
        data_in: OrganizationSearchQuery
    Returns:
        OrganizationsSearchPostResponse
    """

    endpoint = "/organization/Organizations/Search"
    data = data_in.model_dump(by_alias=True)
    response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
    response_model = self._decode_response_to_model(response, OrganizationsSearchPostResponse)
    return response_model

get_all_powertrains_of_the_sites(data_in)

Get all powertrains of the sites.

Parameters:

Name Type Description Default
data_in GetPowertrainsQuery

GetPowertrainsQuery

 required

Returns: PowertrainsSearchPostResponse

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
225
226
227
228
229
230
231
232
233
234
235
236
237
238
def get_all_powertrains_of_the_sites(self, data_in: GetPowertrainsQuery) -> PowertrainsSearchPostResponse:
    """Get all powertrains of the sites.

    Args:
        data_in: GetPowertrainsQuery
    Returns:
        PowertrainsSearchPostResponse
    """

    endpoint = "/organization/Powertrains/Search"
    data = data_in.model_dump(by_alias=True)
    response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
    response_model = self._decode_response_to_model(response, PowertrainsSearchPostResponse)
    return response_model

get_all_sites_for_the_specified_organizations(data_in)

Get all sites for the specified organizations.

Parameters:

Name Type Description Default
data_in GetSitesQuery

GetSitesQuery

 required

Returns: SitesSearchPostResponse

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
285
286
287
288
289
290
291
292
293
294
295
296
297
298
def get_all_sites_for_the_specified_organizations(self, data_in: GetSitesQuery) -> SitesSearchPostResponse:
    """Get all sites for the specified organizations.

    Args:
        data_in: GetSitesQuery
    Returns:
        SitesSearchPostResponse
    """

    endpoint = "/organization/Sites/Search"
    data = data_in.model_dump(by_alias=True)
    response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
    response_model = self._decode_response_to_model(response, SitesSearchPostResponse)
    return response_model

get_an_organization_by_legacy_asset_identifier(identifier)

Get an organization based on a corresponding asset's SmSeId/serialNumber.

Parameters:

Name Type Description Default
identifier str

Legacy identifier, like SmartSensor ID or asset's serial number

 required

Returns: Organization object if found, None otherwise.

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
def get_an_organization_by_legacy_asset_identifier(self, identifier: str) -> Optional[Organization]:
    """Get an organization based on a corresponding asset's SmSeId/serialNumber.

    Args:
       identifier: Legacy identifier, like SmartSensor ID or asset's serial number
    Returns:
        Organization object if found, None otherwise.
    """

    endpoint = f"/organization/Organizations/SearchByAsset/{identifier}"
    response = self._make_request(method="GET", endpoint=endpoint)
    # If the response is 200 and the body is "null", it means that the organization was not found.
    if response and response.status_code == 200 and response.text == "null":
        return None
    response_model = self._decode_response_to_model(response, Organization)
    return response_model

get_asset_by_id(asset_id)

Get asset by id.

Parameters:

Name Type Description Default
asset_id int

int

 required

Returns: Asset

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
115
116
117
118
119
120
121
122
123
124
125
126
127
def get_asset_by_id(self, asset_id: int) -> Asset:
    """Get asset by id.

    Args:
       asset_id:int
    Returns:
        Asset
    """

    endpoint = f"/organization/Assets/{asset_id}"
    response = self._make_request(method="GET", endpoint=endpoint)
    response_model = self._decode_response_to_model(response, Asset)
    return response_model

Returns full asset structure.

Parameters:

Name Type Description Default
data_in AssetStructureSearchQuery

AssetStructureSearchQuery

 required

Returns: AssetStructureSearchPostResponse

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
376
377
378
379
380
381
382
383
384
385
386
387
388
389
def get_asset_structure_search(self, data_in: AssetStructureSearchQuery) -> AssetStructureSearchPostResponse:
    """Returns full asset structure.

    Args:
        data_in: AssetStructureSearchQuery
    Returns:
        AssetStructureSearchPostResponse
    """

    endpoint = "/api/organization/Asset/Structure/Search"
    data = data_in.model_dump(by_alias=True)
    response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
    response_model = self._decode_response_to_model(response, AssetStructureSearchPostResponse)
    return response_model

get_asset_tags(asset_id)

Get asset tags.

Parameters:

Name Type Description Default
asset_id int

int

 required

Returns: ListOfTagsInfoResponse

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
362
363
364
365
366
367
368
369
370
371
372
373
374
def get_asset_tags(self, asset_id: int) -> ListOfTagsInfoResponse:
    """Get asset tags.

    Args:
       asset_id:int
    Returns:
        ListOfTagsInfoResponse
    """

    endpoint = f"/api/organization/Asset/{asset_id}/Tags"
    response = self._make_request(method="GET", endpoint=endpoint)
    response_model = self._decode_response_to_model(response, ListOfTagsInfoResponse)
    return response_model

get_filtered_list_of_assets(data_in)

Returns filtered list of assets

Parameters:

Name Type Description Default
data_in AssetSearchQuery

AssetSearchQuery

 required

Returns: AssetSearchPostResponse

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
391
392
393
394
395
396
397
398
399
400
401
402
403
404
def get_filtered_list_of_assets(self, data_in: AssetSearchQuery) -> AssetSearchPostResponse:
    """Returns filtered list of assets

    Args:
        data_in: AssetSearchQuery
    Returns:
        AssetSearchPostResponse
    """

    endpoint = "/api/organization/Asset/Search"
    data = data_in.model_dump(by_alias=True)
    response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
    response_model = self._decode_response_to_model(response, AssetSearchPostResponse)
    return response_model

get_full_asset_structure(data_in)

Return full asset structure.

Parameters:

Name Type Description Default
data_in GetAssetStructureByIdsQuery

GetAssetStructureByIdsQuery

 required

Returns: AssetsGetAssetStructurePostResponse

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
143
144
145
146
147
148
149
150
151
152
153
154
155
156
def get_full_asset_structure(self, data_in: GetAssetStructureByIdsQuery) -> AssetsGetAssetStructurePostResponse:
    """Return full asset structure.

    Args:
        data_in: GetAssetStructureByIdsQuery
    Returns:
        AssetsGetAssetStructurePostResponse
    """

    endpoint = "/organization/Assets/GetAssetStructure"
    data = data_in.model_dump(by_alias=True)
    response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
    response_model = self._decode_response_to_model(response, AssetsGetAssetStructurePostResponse)
    return response_model

get_list_of_tags_for_a_specific_asset(asset_id)

Returns the list of tags for a specific asset.

Parameters:

Name Type Description Default
asset_id int

int

 required

Returns: AssetsIdTagsResponse

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
129
130
131
132
133
134
135
136
137
138
139
140
141
def get_list_of_tags_for_a_specific_asset(self, asset_id: int) -> AssetsIdTagsResponse:
    """Returns the list of tags for a specific asset.

    Args:
       asset_id:int
    Returns:
        AssetsIdTagsResponse
    """

    endpoint = f"/organization/Assets/{asset_id}/Tags"
    response = self._make_request(method="GET", endpoint=endpoint)
    response_model = self._decode_response_to_model(response, AssetsIdTagsResponse)
    return response_model

get_powertrain_by_id(powertrain_id)

Get powertrain by id.

Parameters:

Name Type Description Default
powertrain_id int

int

 required

Returns: Powertrain

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
240
241
242
243
244
245
246
247
248
249
250
251
252
def get_powertrain_by_id(self, powertrain_id: int) -> Powertrain:
    """Get powertrain by id.

    Args:
       powertrain_id:int
    Returns:
        Powertrain
    """

    endpoint = f"/organization/Powertrains/{powertrain_id}"
    response = self._make_request(method="GET", endpoint=endpoint)
    response_model = self._decode_response_to_model(response, Powertrain)
    return response_model

get_site_by_id(site_id)

Get site by id.

Parameters:

Name Type Description Default
site_id int

int

 required

Returns: Site

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
300
301
302
303
304
305
306
307
308
309
310
311
312
def get_site_by_id(self, site_id: int) -> Site:
    """Get site by id.

    Args:
       site_id:int
    Returns:
        Site
    """

    endpoint = f"/organization/Sites/{site_id}"
    response = self._make_request(method="GET", endpoint=endpoint)
    response_model = self._decode_response_to_model(response, Site)
    return response_model

get_the_unique_asset_tag_values_for_a_specific_organization(organization_id)

Returns all the unique asset tag values for a specific organization.

Parameters:

Name Type Description Default
organization_id int

int

 required

Returns: ListOfTagsInfoResponse

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
def get_the_unique_asset_tag_values_for_a_specific_organization(
    self, organization_id: int
) -> ListOfTagsInfoResponse:
    """Returns all the unique asset tag values for a specific organization.

    Args:
       organization_id:int
    Returns:
        ListOfTagsInfoResponse
    """

    endpoint = f"/api/organization/{organization_id}/Tags"
    response = self._make_request(method="GET", endpoint=endpoint)
    response_model = self._decode_response_to_model(response, ListOfTagsInfoResponse)
    return response_model

get_unique_asset_tag_values_for_a_specific_organization(organization_id)

Returns all the unique asset tag values for a specific organization.

Parameters:

Name Type Description Default
organization_id int

int

 required

Returns: ListOfStringsResponse

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
348
349
350
351
352
353
354
355
356
357
358
359
360
def get_unique_asset_tag_values_for_a_specific_organization(self, organization_id: int) -> ListOfStringsResponse:
    """Returns all the unique asset tag values for a specific organization.

    Args:
       organization_id:int
    Returns:
        ListOfStringsResponse
    """

    endpoint = f"/organization/Organizations/{organization_id}/Tags"
    response = self._make_request(method="GET", endpoint=endpoint)
    response_model = self._decode_response_to_model(response, ListOfStringsResponse)
    return response_model

search_for_organization_by_the_specified_filter(data_in)

Search for organization by the specified filter.

Parameters:

Name Type Description Default
data_in GetOrganizationInfoQuery

GetOrganizationInfoQuery

 required

Returns: OrganizationSearchPostResponse

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
def search_for_organization_by_the_specified_filter(
    self, data_in: GetOrganizationInfoQuery
) -> OrganizationSearchPostResponse:
    """Search for organization by the specified filter.

    Args:
        data_in: GetOrganizationInfoQuery
    Returns:
        OrganizationSearchPostResponse
    """

    endpoint = "/api/organization/Search"
    data = data_in.model_dump(by_alias=True)
    response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
    response_model = self._decode_response_to_model(response, OrganizationSearchPostResponse)
    return response_model

search_for_organizations_structures_by_the_specified_filter(data_in)

Search for organizations structures by the specified filter.

Parameters:

Name Type Description Default
data_in GetOrganizationStructureQuery

GetOrganizationStructureQuery

 required

Returns: OrganizationStructurePostResponse

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
def search_for_organizations_structures_by_the_specified_filter(
    self, data_in: GetOrganizationStructureQuery
) -> OrganizationStructurePostResponse:
    """Search for organizations structures by the specified filter.

    Args:
        data_in: GetOrganizationStructureQuery
    Returns:
        OrganizationStructurePostResponse
    """

    endpoint = "/api/organization/Structure"
    data = data_in.model_dump(by_alias=True)
    response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
    response_model = self._decode_response_to_model(response, OrganizationStructurePostResponse)
    return response_model

search_for_powertrains_by_the_specified_filter(data_in)

Search for powertrains by the specified filter.

Parameters:

Name Type Description Default
data_in GetPowertrainInfoQuery

GetPowertrainInfoQuery

 required

Returns: PowertrainSearchPostResponse

Source code in reportconnectors/api_client/powertrain/organization/__init__.py 
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
def search_for_powertrains_by_the_specified_filter(
    self, data_in: GetPowertrainInfoQuery
) -> PowertrainSearchPostResponse:
    """Search for powertrains by the specified filter.

    Args:
        data_in: GetPowertrainInfoQuery
    Returns:
        PowertrainSearchPostResponse
    """

    endpoint = "/api/organization/Powertrain/Search"
    data = data_in.model_dump(by_alias=True)
    response = self._make_request(method="POST", endpoint=endpoint, json_data=data)
    response_model = self._decode_response_to_model(response, PowertrainSearchPostResponse)
    return response_model