organization_allow_guest_access_api

edgeimpulse_api v1.0.0

edgeimpulse_api.api.organization_allow_guest_access_api module

class edgeimpulse_api.api.organization_allow_guest_access_api.OrganizationAllowGuestAccessApi(api_client=None)

Bases: object

add_organization_data_file(organization_id: StrictInt, data_id: StrictInt, files: List[StrictBytes], **kwargs)

Add files

Add a new file to an existing data item.

• Parameters

  • organization_id (int) – Organization ID (required)

  • data_id (int) – Data ID (required)

  • files (List*[str]*) – (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

  GenericApiResponse

delete_organization_data_file(organization_id: StrictInt, data_id: StrictInt, file_name: StrictStr, **kwargs)

Delete file

Delete a single file from a data item.

• Parameters

  • organization_id (int) – Organization ID (required)

  • data_id (int) – Data ID (required)

  • file_name (str) – File name (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

  GenericApiResponse

delete_organization_data_item(organization_id: StrictInt, data_id: StrictInt, **kwargs)

Delete data

Delete a data item. This does not remove the items from the underlying storage.

• Parameters

  • organization_id (int) – Organization ID (required)

  • data_id (int) – Data 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

  GenericApiResponse

download_organization_data_file(organization_id: StrictInt, data_id: StrictInt, file_name: StrictStr, **kwargs)

Download file

Download a single file from a data item.

• Parameters

  • organization_id (int) – Organization ID (required)

  • data_id (int) – Data ID (required)

  • file_name (str) – File name (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

  str

download_organization_data_item(organization_id: StrictInt, data_ids: StrictStr, dataset: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, **kwargs)

Download data

Download all data for selected data items. This function does not query the underlying bucket.

• Parameters

  • organization_id (int) – Organization ID (required)

  • data_ids (str) – Data IDs as an Array (required)

  • dataset (str) – Selected dataset

  • filter (str) – Data filter in SQL WHERE format, where you can reference ‘dataset’, ‘bucket’, ‘name’, ‘total_file_count’, ‘total_file_size’, ‘created’ and any metadata label through ‘metadata->’ (dots are replaced by underscore).

  • 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

  str

download_organization_single_data_item(organization_id: StrictInt, data_id: StrictInt, filter: Optional[StrictStr] = None, **kwargs)

Download data

Download all data for this data item.

• Parameters

  • organization_id (int) – Organization ID (required)

  • data_id (int) – Data ID (required)

  • filter (str) – Data filter in SQL WHERE format, where you can reference ‘dataset’, ‘bucket’, ‘name’, ‘total_file_count’, ‘total_file_size’, ‘created’ and any metadata label through ‘metadata->’ (dots are replaced by underscore).

  • 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

  str

get_organization_data_item(organization_id: StrictInt, data_id: StrictInt, filter: Optional[StrictStr] = None, **kwargs)

Get data metadata

Get a data item. This will HEAD the underlying bucket to retrieve the last file information.

• Parameters

  • organization_id (int) – Organization ID (required)

  • data_id (int) – Data ID (required)

  • filter (str) – Data filter in SQL WHERE format, where you can reference ‘dataset’, ‘bucket’, ‘name’, ‘total_file_count’, ‘total_file_size’, ‘created’ and any metadata label through ‘metadata->’ (dots are replaced by underscore).

  • 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

  GetOrganizationDataItemResponse

preview_organization_data_file(organization_id: StrictInt, data_id: StrictInt, file_name: StrictStr, **kwargs)

Preview file

Preview a single file from a data item (same as downloadOrganizationDataFile but w/ content-disposition inline).

• Parameters

  • organization_id (int) – Organization ID (required)

  • data_id (int) – Data ID (required)

  • file_name (str) – File name (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

  str

update_organization_data_item(organization_id: StrictInt, data_id: StrictInt, update_organization_data_item_request: UpdateOrganizationDataItemRequest, **kwargs)

Update data metadata

Update the data item metadata.

• Parameters

  • organization_id (int) – Organization ID (required)

  • data_id (int) – Data ID (required)

  • update_organization_data_item_request (UpdateOrganizationDataItemRequest) – (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

  GenericApiResponse