import-check
integrate
robocrops

Create a new import check in the organization

Authentication required for this operation.<br>Preconditions:<ul> <li>Authenticated user has to be editor or owner of the organization, or be an admin in the platform.</li> <li>Authenticated user is an owner within the organization or an admin.</li> <li>The check id will be generated and the whole new saved check is returned.</li></ul>

post/import-check/organization/{organizationId}

Request

  • Base URL: https://api.30mhz.com/api
  • URL: https://api.30mhz.com/api/import-check/organization/{organizationId}
  • Auth: API key in header Authorization

Path parameters

organizationIdstring required

Request body

decimalsPerFieldobject

The number of decimals used for each field of the data source.

descriptionstring

Brief description that elaborates on the name

enabledboolean

Whether the data source is enabled.

ingestedForIndicesobject

The data source's indexes for ingested values

integrationTypestring

Integration type.

locationIdstring

Identifier of the site it belongs to, together with the organizationId this is unique.

namestring required

Displayable name.

notificationRelevanceinteger required

The notification relevance for import check hits.

rangePerJsonKeyobject

Min/max ranges for each json key of the data source.

sensorTypestring required

The sensor type.

sourceIdstring

Optional source id.

status'ACTIVE' | 'DEACTIVATED' | 'PAUSED'

The status of the data source, e.g. ACTIVE, DEACTIVATED or PAUSED.

tagsstring[]

The tags associated with the data source.

timezonestring required

An area which observes a uniform standard time.

unitPerFieldobject

Identifier of the preferred unit conversion for each field.

useCollectionsAsRowsboolean

Whether collections should be displayed as rows.

zoneIdstring

Identifier of the zone within a site where the data source belongs.

createdAtstring

Timestamp of when it was created.

cultivationHierarchyIdstring

Cultivation composite identifier of format: <cultivationId>#<plantGroupId>##<plantId>

notificationIdsstring[] required

Ids of the notifications for this check

organizationIdstring

Identifier of the organization this data source belongs to.

statestring

The current state of the data source: UP or DOWN.

checkIdstring

Identifier of the data source

hasNotificationsboolean

Does the data source have any notifications associated with it

maxDecimalsinteger

Max decimals for fields of the data source.

siteIdstring

Identifier of the site it belongs to, together with the organizationId this is unique.

Response

New import check created, including its generated check id

decimalsPerFieldobject

The number of decimals used for each field of the data source.

descriptionstring

Brief description that elaborates on the name

enabledboolean

Whether the data source is enabled.

ingestedForIndicesobject

The data source's indexes for ingested values

integrationTypestring

Integration type.

locationIdstring

Identifier of the site it belongs to, together with the organizationId this is unique.

namestring required

Displayable name.

notificationRelevanceinteger required

The notification relevance for import check hits.

rangePerJsonKeyobject

Min/max ranges for each json key of the data source.

sensorTypestring required

The sensor type.

sourceIdstring

Optional source id.

status'ACTIVE' | 'DEACTIVATED' | 'PAUSED'

The status of the data source, e.g. ACTIVE, DEACTIVATED or PAUSED.

tagsstring[]

The tags associated with the data source.

timezonestring required

An area which observes a uniform standard time.

unitPerFieldobject

Identifier of the preferred unit conversion for each field.

useCollectionsAsRowsboolean

Whether collections should be displayed as rows.

zoneIdstring

Identifier of the zone within a site where the data source belongs.

createdAtstring

Timestamp of when it was created.

cultivationHierarchyIdstring

Cultivation composite identifier of format: <cultivationId>#<plantGroupId>##<plantId>

notificationIdsstring[] required

Ids of the notifications for this check

organizationIdstring

Identifier of the organization this data source belongs to.

statestring

The current state of the data source: UP or DOWN.

checkIdstring

Identifier of the data source

hasNotificationsboolean

Does the data source have any notifications associated with it

maxDecimalsinteger

Max decimals for fields of the data source.

siteIdstring

Identifier of the site it belongs to, together with the organizationId this is unique.

Changes

No recorded changes to this operation across all 1 revision of this API.