organization_portals_api
edgeimpulse_api v1.0.0
edgeimpulse_api.api.organization_portals_api module
class edgeimpulse_api.api.organization_portals_api.OrganizationPortalsApi(api_client=None)Bases:
object
create_organization_portal(organization_id: StrictInt, create_organization_portal_request: CreateOrganizationPortalRequest, **kwargs)Create upload portal
Creates a new upload portal for the organization.
Parameters
organization_id (int) – Organization ID (required)
create_organization_portal_request (CreateOrganizationPortalRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
delete_organization_portal(organization_id: StrictInt, portal_id: StrictInt, **kwargs)Delete upload portal
Deletes an upload portal for the organization.
Parameters
organization_id (int) – Organization ID (required)
portal_id (int) – Portal ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
get_organization_portal(organization_id: StrictInt, portal_id: StrictInt, **kwargs)Retrieve upload portal information
Retrieve a single upload portals identified by ID.
Parameters
organization_id (int) – Organization ID (required)
portal_id (int) – Portal ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
list_organization_portals(organization_id: StrictInt, **kwargs)List upload portals
Retrieve all configured upload portals.
Parameters
organization_id (int) – Organization ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
rotate_organization_portal_token(organization_id: StrictInt, portal_id: StrictInt, **kwargs)Rotate upload portal token
Rotates the token for an upload portal.
Parameters
organization_id (int) – Organization ID (required)
portal_id (int) – Portal ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
update_organization_portal(organization_id: StrictInt, portal_id: StrictInt, create_organization_portal_request: CreateOrganizationPortalRequest, **kwargs)Update upload portal
Updates an upload portal for the organization.
Parameters
organization_id (int) – Organization ID (required)
portal_id (int) – Portal ID (required)
create_organization_portal_request (CreateOrganizationPortalRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
verify_organization_portal(organization_id: StrictInt, portal_id: StrictInt, **kwargs)Verify upload portal information
Retrieve a subset of files from the portal, to be used in the data source wizard.
Parameters
organization_id (int) – Organization ID (required)
portal_id (int) – Portal ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
Last updated
Was this helpful?