Skip to main content

Seer rule (seer-rule:v.2.10.4.fc18f5c8)

Download OpenAPI specification:Download

Seer rule.

rules

Create multiple RuleEntities

Request Body schema: application/json
required
bulk
required
Array of objects (RuleEntity)

Responses

Response Schema: application/json
Array
object (RuleEntity)

Request samples

Content type
application/json
{
  • "bulk": [
    ]
}

Response samples

Content type
application/json
[
  • { }
]

RulesController_getRulePaginate

Responses

RulesController_getDeviceRuleResp

Responses

RulesController_cronExpressionRun

Responses

RulesController_getWSRule[0]

path Parameters
ruleId
required
number

Responses

new a rule

Request Body schema: application/json
required
object (RuleEntity)

Responses

Request samples

Content type
application/json
{ }

RulesController_delWSRules

Responses

RulesController_getWSRule[1]

path Parameters
ruleId
required
number

Responses

RulesController_patchWSRule

path Parameters
ruleId
required
number

Responses

RulesController_delWSRule

path Parameters
ruleId
required
number

Responses

RulesController_addTag

path Parameters
ruleId
required
number

Responses

RulesController_addAction

path Parameters
ruleId
required
number

Responses

RulesController_updateTag

path Parameters
ruleId
required
number

Responses

RulesController_updateAction

path Parameters
ruleId
required
number

Responses

RulesController_patchRule

path Parameters
id
required
number

Responses

Retrieve a single RuleEntity

path Parameters
id
required
number
query Parameters
fields
Array of strings

Selects resource fields. Docs

join
Array of strings

Adds relational resources. Docs

cache
integer [ 0 .. 1 ]

Reset cache (if was enabled). Docs

Responses

Response Schema: application/json
object (RuleEntity)

Response samples

Content type
application/json
{ }

Update a single RuleEntity

path Parameters
id
required
number
Request Body schema: application/json
required
object (RuleEntity)

Responses

Response Schema: application/json
object (RuleEntity)

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Replace a single RuleEntity

path Parameters
id
required
number
Request Body schema: application/json
required
object (RuleEntity)

Responses

Response Schema: application/json
object (RuleEntity)

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Delete a single RuleEntity

path Parameters
id
required
number

Responses

RulesController_queryState

Responses

RulesController_setState

path Parameters
stateId
required
string

Responses

Retrieve multiple RuleEntities

query Parameters
fields
Array of strings

Selects resource fields. Docs

s
string

Adds search condition. Docs

filter
Array of strings

Adds filter condition. Docs

or
Array of strings

Adds OR condition. Docs

sort
Array of strings

Adds sort by field. Docs

join
Array of strings

Adds relational resources. Docs

limit
integer

Limit amount of resources. Docs

offset
integer

Offset amount of resources. Docs

page
integer

Page portion of resources. Docs

cache
integer [ 0 .. 1 ]

Reset cache (if was enabled). Docs

Responses

Response Schema: application/json
One of
data
required
Array of objects (RuleEntity)
count
required
number
total
required
number
page
required
number
pageCount
required
number

Response samples

Content type
application/json
Example
{
  • "data": [
    ],
  • "count": 0,
  • "total": 0,
  • "page": 0,
  • "pageCount": 0
}

Create a single RuleEntity

Request Body schema: application/json
required
object (RuleEntity)

Responses

Response Schema: application/json
object (RuleEntity)

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }