Homes data models

Represents a home which contains devices and is managed by one or more users.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
creationTime	string	No	read-only (server-generated); format: date-time	Timestamp of home creation.
deactivated	boolean	No		True if home has been deactivated by project admin.
id	integer	Yes	read-only (server-generated)	Unique ID assigned at time of creation.
name	string	Yes		Display name of home.
projectId	integer	Yes	read-only (server-generated)	Project that this home belongs to.
tenant	object	No		Tenant information associated with a home.
Properties of tenant Property Type Required Constraints Description agencyAdminAccessControlGroupId integer Yes read-only (server-generated) ID of the access control group that serves as the agency admin for this tenant. identifier string Yes read-only (server-generated) Unique identifier for the tenant within the project. tenantAdminAccessControlGroupId integer Yes read-only (server-generated) ID of the access control group that serves as the tenant admin for this tenant.

Represents a data route instance created in a project.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
dataType	string	Yes	read-only (server-generated)	Data type of the data route. It must be one of the supported data types: metrics and locations.
destination	object	Yes		Destination is the definition of the target entity of the data route. The entity must be predefined in the project or a wildcard entityId.
filterIds	array<string>	No		Filter IDs of the data route. Specify exact data filter IDs as values in the array. These filters are applied in the order specified.
filterTypes	array<string>	No		Filter types of the data route. The filter rules matched by the specified filter type are automatically applied to the data route.
homeId	integer	No		Home that this data route belongs to.
name	string	Yes		Display name of data route.
projectId	integer	Yes	read-only (server-generated)	Project that this data route belongs to.
routeId	string	Yes	read-only (server-generated)	Unique Data Route ID.
source	object	Yes		Source is the definition of the data source of the data route. The source must be referred to a Data Source or a wildcard data source.
Properties of source Property Type Required Constraints Description catalogId string No Data Source Catalog ID. deviceId number No The device ID is associated with the catalogId and sourceId. The specified device ID must be attached to a home. The device ID is optional when the sourceId has wildcard notation or the sourceId is a data source of integration module. sourceId string No Data Source ID. The sourceId can be specified with wildcard notation *. This supports prefix-only (pre*), suffix-only (*suf), partial (pre*suf), or full (*) matching. The sourceId can include at most one wildcard notation. When the sourceId has wildcard notation, the entityId in the destination must have the {{sourceId}} tag.

Represents a request to ingest data via file upload.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
catalogId	string	Yes	read-only (server-generated)	Catalog ID of the data source from which the data file originated.
completedTime	string	No	read-only (server-generated); format: date-time	If the data upload is fully processed, the completion time is included here.
deviceId	number	No	read-only (server-generated)	ID of the device/gateway from which the data file originated. Optional.
errorMessage	string	No	read-only (server-generated)	If upload has failed, an error messages will be included here.
fileName	string	Yes	read-only (server-generated)	Name of data file.
homeId	number	Yes	read-only (server-generated)	ID of home targeted by the upload.
id	number	Yes	read-only (server-generated)	Unique ID assigned to upload request.
importedRecords	number	Yes	read-only (server-generated)	Number of data reocrds imported so far.
percentageComplete	number	Yes	read-only (server-generated); min: 0; max: 1	Percentage of the data file that has been imported.
projectId	number	Yes	read-only (server-generated)	ID of the project associated to this request.
sourceId	string	Yes	read-only (server-generated)	ID of the data source from which the data file originated.
state	string	Yes	read-only (server-generated); one of: waiting_for_upload, upload_complete, in_progress, completed, failed_input_error, failed_system_error, cancel_requested, cancel_completed	Current state of the upload request.
uploadUrl	string	No	read-only (server-generated)	The URL for uploading the data file.

Entry in an HTTP access log.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
clientIp	string	No	read-only (server-generated)	IP address of caller.
latency	integer	No	read-only (server-generated)	Elapsed time of call in nanoseconds.
method	string	No	read-only (server-generated)	HTTP method.
path	string	No	read-only (server-generated)	URI path of HTTP request.
statusCode	integer	No	read-only (server-generated)	Returned status code of HTTP request.
timestamp	string	No	read-only (server-generated); format: date-time	Timestamp of entry creation.

Represents an integration module configuration created in a project.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
catalogType	string	Yes		Catalog type of the integration module.
claims	object	No		Claims is the definition of the authentication method and credentials for the integration module.
Properties of claims Property Type Required Constraints Description credentials object No Credentials is the definition of the authentication credentials for the integration module. the properties of the credentials object are dependent on the authentication method. method string No one of: oauth2, httpBasicAuth, httpAPIKey, httpAPIKeyQueryParam, jwtAuth, customHeader Authentication method of the integration module.
configId	string	Yes	read-only (server-generated)	Unique Integration Module ID.
homeId	integer	Yes		Home that this integration module belongs to.
projectId	integer	Yes	read-only (server-generated)	Project that this integration module belongs to.
schedule	object	No		Schedule is the definition of the schedule for the integration module.
Properties of schedule Property Type Required Constraints Description cronSchedule string No cron schedule for the integration module. The format is a standard unix crontab and some extended format such as @everyXs, @hourly, etc. cronTimeZone string No cron time zone for the integration module. operations array<object> No Properties of operations Property Type Required Constraints Description appConfigs object No appConfigs is the configuration for the post processing of the operation response. operationName string No Name of the operation. The operation names are defined in the integration module catalog. parameters array<object> No Parameters for the operation defined in the integration module catalog. Properties of parameters Property Type Required Constraints Description name string No Name of the parameter. value string No Value of the parameter.

Represents an integration module configuration created in a project.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
catalogType	string	Yes		Catalog type of the integration module.
claims	object	No		Claims is the definition of the authentication method and credentials for the integration module.
Properties of claims Property Type Required Constraints Description credentials object No Credentials is the definition of the authentication credentials for the integration module. the properties of the credentials object are dependent on the authentication method. method string No one of: oauth2, httpBasicAuth, httpAPIKey, httpAPIKeyQueryParam, jwtAuth, customHeader Authentication method of the integration module.
configId	string	Yes	read-only (server-generated)	Unique Integration Module ID.
homeId	integer	Yes		Home that this integration module belongs to.
projectId	integer	Yes	read-only (server-generated)	Project that this integration module belongs to.
schedule	object	No		Schedule is the definition of the schedule for the integration module.
Properties of schedule Property Type Required Constraints Description cronSchedule string No cron schedule for the integration module. The format is a standard unix crontab and some extended format such as @everyXs, @hourly, etc. cronTimeZone string No cron time zone for the integration module. operations array<object> No Properties of operations Property Type Required Constraints Description appConfigs object No appConfigs is the configuration for the post processing of the operation response. operationName string No Name of the operation. The operation names are defined in the integration module catalog. parameters array<object> No Parameters for the operation defined in the integration module catalog. Properties of parameters Property Type Required Constraints Description name string No Name of the parameter. value string No Value of the parameter.