Scene Query Webservice

Selective update prompt configuration

Selectively update a scene query configuration

post/api/scenequery/selectiveUpdatePromptConfiguration

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/scenequery/selectiveUpdatePromptConfiguration
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

activeboolean nullable

Optional active status for the prompt configuration

descriptionstring nullable

Optional description for the prompt configuration

minuteTriggerRateinteger nullable

Optional minute trigger rate for the configuration

namestring nullable

Optional name for the prompt configuration

orgUuidstring RUUID nullable

base 64 (url-safe) uuid string

promptstring nullable

Optional prompt text for the configuration

promptType'COUNT' | 'PERCENT' | 'BOOLEAN' | 'TEXT'

Optional prompt type for the configuration

scheduleUuidstring RUUID nullable

base 64 (url-safe) uuid string

shortNamestring nullable

Optional short name for the prompt configuration

uuidstring RUUID nullable

base 64 (url-safe) uuid string

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Changes

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