Retrieve a global ruleset

GET 
https://demo.openremote.io/api/master/rules/:id

Retrieve a global ruleset

Request

Path Parameters

id int64required

Header Parameters

Authorization string
X-Forwarded-Proto string
X-Forwarded-Host string

Responses

default

default response

application/json

Schema

Schema

idint64
versionint64
createdOndate-time
lastModifieddate-time
namestringrequired

Possible values: >= 3 characters and <= 255 characters

enabledboolean
rulesstring
langstringrequired

Possible values: [JAVASCRIPT, GROOVY, JSON, FLOW]

meta

object
statusstring

Possible values: [READY, DEPLOYED, COMPILATION_ERROR, VALIDITY_PERIOD_ERROR, EXECUTION_ERROR, LOOP_ERROR, DISABLED, PAUSED, EXPIRED, REMOVED, EMPTY]

errorstring

Example (from schema)

{
  "id": 0,
  "version": 0,
  "createdOn": "2024-07-29T15:51:28.071Z",
  "lastModified": "2024-07-29T15:51:28.071Z",
  "name": "string",
  "enabled": true,
  "rules": "string",
  "lang": "JAVASCRIPT",
  "meta": {},
  "status": "READY",
  "error": "string"
}

Authorization: oauth2

name: openidtype: oauth2flows: {
  "clientCredentials": {
    "tokenUrl": "/auth/realms/master/protocol/openid-connect/token",
    "refreshUrl": "/auth/realms/master/protocol/openid-connect/token",
    "scopes": {
      "profile": "profile"
    }
  },
  "authorizationCode": {
    "authorizationUrl": "/auth/realms/master/protocol/openid-connect/auth",
    "tokenUrl": "/auth/realms/master/protocol/openid-connect/token",
    "refreshUrl": "/auth/realms/master/protocol/openid-connect/token",
    "scopes": {
      "profile": "profile"
    }
  }
}

• curl
• nodejs
• java
• python
• ruby
• csharp
• go
• php
• powershell

• CURL

curl -L 'https://demo.openremote.io/api/master/rules/:id' \
-H 'Authorization: Bearer <token>'

Request Collapse all

Base URL

https://demo.openremote.io/api/master

Auth

Bearer Token

Parameters

id — pathrequired

Authorization — header

X-Forwarded-Proto — header

X-Forwarded-Host — header

ResponseClear

Click the Send API Request button above and see the response here!