Skip to main content

​
OrganizationPortalsApi

class edgeimpulse_api.api.organization_portals_api.OrganizationPortalsApi(
		api_client=None
)
Parameters
  • api_client=None

​
Methods

​
create_organization_portal

edgeimpulse_api.api.organization_portals_api.create_organization_portal(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		create_organization_portal_request: edgeimpulse_api.models.create_organization_portal_request.CreateOrganizationPortalRequest,
		**kwargs
) ‑> edgeimpulse_api.models.create_organization_portal_response.CreateOrganizationPortalResponse
Create upload portal Creates a new upload portal for the organization. Parameters
  • self
  • organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Organization ID’, extra=)]
  • create_organization_portal_request: edgeimpulse_api.models.create_organization_portal_request.CreateOrganizationPortalRequest
  • **kwargs
Return edgeimpulse_api.models.create_organization_portal_response.CreateOrganizationPortalResponse

​
delete_organization_portal

edgeimpulse_api.api.organization_portals_api.delete_organization_portal(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		portal_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse
Delete upload portal Deletes an upload portal for the organization. Parameters
  • self
  • organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Organization ID’, extra=)]
  • portal_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Portal ID’, extra=)]
  • **kwargs
Return edgeimpulse_api.models.generic_api_response.GenericApiResponse

​
get_organization_portal

edgeimpulse_api.api.organization_portals_api.get_organization_portal(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		portal_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_organization_portal_response.GetOrganizationPortalResponse
Retrieve upload portal information Retrieve a single upload portals identified by ID. Parameters
  • self
  • organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Organization ID’, extra=)]
  • portal_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Portal ID’, extra=)]
  • **kwargs
Return edgeimpulse_api.models.get_organization_portal_response.GetOrganizationPortalResponse

​
list_organization_portals

edgeimpulse_api.api.organization_portals_api.list_organization_portals(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.list_organization_portals_response.ListOrganizationPortalsResponse
List upload portals Retrieve all configured upload portals. Parameters
  • self
  • organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Organization ID’, extra=)]
  • **kwargs
Return edgeimpulse_api.models.list_organization_portals_response.ListOrganizationPortalsResponse

​
rotate_organization_portal_token

edgeimpulse_api.api.organization_portals_api.rotate_organization_portal_token(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		portal_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse
Rotate upload portal token Rotates the token for an upload portal. Parameters
  • self
  • organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Organization ID’, extra=)]
  • portal_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Portal ID’, extra=)]
  • **kwargs
Return edgeimpulse_api.models.generic_api_response.GenericApiResponse

​
update_organization_portal

edgeimpulse_api.api.organization_portals_api.update_organization_portal(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		portal_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})],
		create_organization_portal_request: edgeimpulse_api.models.create_organization_portal_request.CreateOrganizationPortalRequest,
		**kwargs
) ‑> edgeimpulse_api.models.update_organization_portal_response.UpdateOrganizationPortalResponse
Update upload portal Updates an upload portal for the organization. Parameters
  • self
  • organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Organization ID’, extra=)]
  • portal_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Portal ID’, extra=)]
  • create_organization_portal_request: edgeimpulse_api.models.create_organization_portal_request.CreateOrganizationPortalRequest
  • **kwargs
Return edgeimpulse_api.models.update_organization_portal_response.UpdateOrganizationPortalResponse

​
verify_organization_portal

edgeimpulse_api.api.organization_portals_api.verify_organization_portal(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		portal_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.verify_organization_bucket_response.VerifyOrganizationBucketResponse
Verify upload portal information Retrieve a subset of files from the portal, to be used in the data source wizard. Parameters
  • self
  • organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Organization ID’, extra=)]
  • portal_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Portal ID’, extra=)]
  • **kwargs
Return edgeimpulse_api.models.verify_organization_bucket_response.VerifyOrganizationBucketResponse
⌘I