Search Webservice

Search objects by color

Search for objects by color

post/api/search/searchObjectsByColor

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/search/searchObjectsByColor
  • 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

colorFilterColorEnum[] nullable

Set of colors to filter by

deviceFilterstring[] nullable

List of device facet UUIDs to filter by

endTimeMsinteger nullable

End time in milliseconds for the search period

objectTypeFilterActivityEnum[] nullable

Set of activity types to filter by

startTimeMsinteger nullable

Start time in milliseconds for the search period

Example request

{
  "deviceFilter": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "endTimeMs": 1640998800000,
  "startTimeMs": 1640995200000
}

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.