Delete collection data

DELETE/homes/{homeId}/smartModules/{moduleId}/collections/{collectionId}/data

Base URL: https://api.tinkermode.com

Delete data entries of a geospatial collection that fall within a given time range. If only the begin parameter is specified, all entries timestamped after begin will be deleted. If only the end parameter is specified, all entries timestamped before end will be deleted. This API supports the bucket-level deletion only.

Authentication

Send an Authorization header of the form ModeCloud <AUTH_CODE>.

Must contain a user, service account, or project API key.

Path parameters

NameTypeRequiredConstraintsDescription
homeIdintegerYesThe unique ID for a home.
moduleIdstringYesThe unique ID for a smart module.
collectionIdstringYesCollection ID. It must be unique per home.

Query parameters

NameTypeRequiredConstraintsDescription
beginstringNoThe beginning of the time range. The format follows RFC3339.
endstringNoThe end of the time range. The format follows RFC3339.
searchKeysstringYesSpecify keywords to delete specific objects in the GeoTSDB storage. The searchKeys parameter allows multiple values, separated by commas (","). For example, if you specify the searchKeys as "building::st_ave,worker::john_smith", objects with searchKey such as "building::st_ave" and "worker::john_smith" will be returned.

Responses

204 The data entries have been successfully deleted.

401 Authorization is required to access this resource.

403 Request failed because of invalid data or denied permission.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

404 The required data entry does not exist or is not accessible.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

409 The data entry cannot be deleted because it is being used by another part of the system.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

500 An unexpected error has occurred.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

503 The service is temporarily unavailable.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.