Skip to main content

Update a data analyzer

PATCH 
/api/v1/orgs/{orgId}/devices/{deviceId}/analyzers/{analyzerId}

Update one or more fields of a specific analyzer. Only provided fields are updated; omitted fields retain their current values. A provided config, inputParameters, outputs or dataAssemblyPolicy replaces the current value as a whole; it is not merged field by field. The analyzer must be disabled first. Use the enable/disable action to change its enabled state.

Responses

  • 200 OK: Analyzer patched successfully.
  • 400 Bad Request: Invalid request, expression, or script; an expression or script that does not name every declared input parameter; a duplicate or self-referencing data stream, or more than ten inputs; a duplicate input parameter name; an unsupported JSONPath, or a JavaScript output without one; a dataAssemblyPolicy value outside its range; or a dependency graph exceeding the maximum chain depth of five analyzers or containing a cycle.
  • 401 Unauthorized: Missing or invalid authentication token.
  • 403 Forbidden: The caller is not permitted to access this organization or device.
  • 404 Not Found: Analyzer, device, or output data stream not found.
  • 409 Conflict: Analyzer is enabled, or an output data stream already has a data source (another analyzer, or a node, subnode, or device).
  • 500 Internal Server Error: An upstream service (device management, data streams, or Data Assembly) was unreachable or failed.

Security

  • This API requires authentication.

Request​

Responses​

OK