DaaS API
Docs & Playground
Reference (Get)/Get Rule

Get Ruletoken required

The rules ExceptionEvents refer to.

Try in playground
POST/daas/apiv1— method = "Get", params.typeName = "Rule"

Parameters

typeName is "Rule".

NameTypeRequiredDescription
search.idstringoptionalOnly the entity with this id.
resultsLimitnumberoptionalRecords per call. Default and maximum 5,000.e.g. 100
sort.sortBystringoptionalPage through results: id.e.g. id
sort.offsetstringoptionalid of the last record of the previous page.

Notes

baseType is Stock for built-in rules and Custom for a customer's own.

Request

curl
curl -X POST 'https://private.develop-1.questar.io/v2/private-questar-units/daas/apiv1' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  --data '{"method":"Get","params":{"typeName":"Rule","resultsLimit":100,"sort":{"sortBy":"id"}}}'
Body
{
  "method": "Get",
  "params": {
    "typeName": "Rule",
    "resultsLimit": 100,
    "sort": {
      "sortBy": "id"
    }
  }
}

Response

200 OK
{
  "jsonrpc": "2.0",
  "result": [
    {
      "id": "1-72",
      "name": "Speeding",
      "comment": "",
      "baseType": "Stock",
      "version": "000001a153afae85"
    }
  ]
}

Errors also come back as HTTP 200, with an error instead of a result. error.data.type says what went wrong: ArgumentException (a bad parameter), MissingMethodException (unknown method) or InvalidOperationException. With no or an invalid token the gateway answers HTTP 401 / 403.

200 OK
{
  "jsonrpc": "2.0",
  "error": {
    "code": -32000,
    "message": "Get does not support typeName 'Media'",
    "name": "JSONRPCError",
    "data": {
      "type": "ArgumentException"
    },
    "errors": [
      {
        "message": "Get does not support typeName 'Media'",
        "name": "ArgumentException"
      }
    ]
  }
}