Help Center> ROMA Connect> API Reference> Device Integration APIs> Rule Engine> Creating a Rule
View PDF

Creating a Rule

Function

This API is used to create a rule.

URI

POST /v2/{project_id}/link/instances/{instance_id}/rules

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

Minimum: 0

Maximum: 32

instance_id

Yes

String

Instance ID.

Minimum: 0

Maximum: 36

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Rule name, which is a string of 1 to 64 characters containing case-sensitive letters, digits, underscores (_), and hyphens (-).

Minimum: 1

Maximum: 64

app_id

Yes

String

Application ID.

Minimum: 0

Maximum: 64

description

No

String

Description, which contains a maximum of 200 characters.

Minimum: 0

Maximum: 200

status

No

Integer

Rule status. The options are as follows: 0: enabled; 1: disabled. If this parameter is left empty, the default value 0 is used.

Minimum: 0

Maximum: 10

data_parsing_status

No

Integer

Data parsing status. The options are as follows: 0: enabled; 1: disabled. If this parameter is left empty, the default value is 1.

Minimum: 0

Maximum: 10

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

permissions

Array of strings

Permission.

rule_id

Integer

Rule ID.

Minimum: 1

Maximum: 99999999999999999

name

String

Rule name, which is a string of 1 to 64 characters containing case-sensitive letters, digits, underscores (_), and hyphens (-).

Minimum: 1

Maximum: 64

app_id

String

Application ID.

Minimum: 0

Maximum: 64

app_name

String

Application name.

Minimum: 0

Maximum: 256

description

String

Description.

Minimum: 0

Maximum: 200

status

Integer

Rule status. The options are as follows: 0: enabled; 1: disabled.

Minimum: 0

Maximum: 10

data_parsing_status

Integer

Data parsing status. If status is set to 0, this parameter is mandatory and must be set to 0 (indicating that data parsing is enabled) or 1 (indicating that data parsing is disabled).

Minimum: 0

Maximum: 10

sql_field

String

SQL query field.

Minimum: 0

Maximum: 2000

sql_where

String

SQL query condition.

Minimum: 0

Maximum: 2000

rule_express

String

Complete rule expression.

Minimum: 0

Maximum: 2000

created_user

CreatedUser object

Name of the user who created the attribute.

last_updated_user

LastUpdatedUser object

User who performed the last update.

created_datetime

Long

Creation start time. The format is timestamp(ms) and the UTC time zone is used.

Minimum: 1

Maximum: 99999999999999999

last_updated_datetime

Long

Last modification time (timestamp, in milliseconds). The UTC time zone is used.

Minimum: 1

Maximum: 99999999999999999
Table 4 CreatedUser

Parameter

Type

Description

user_id

String

User ID (reserved).

Minimum: 0

Maximum: 64

user_name

String

Username.

Minimum: 0

Maximum: 64
Table 5 LastUpdatedUser

Parameter

Type

Description

user_id

String

User ID (reserved).

Minimum: 0

Maximum: 64

user_name

String

Username.

Minimum: 0

Maximum: 64

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

System error code, which is the detailed error code of HTTP error codes 4xx and 5xx.

Minimum: 0

Maximum: 64

error_msg

String

Error description.

Minimum: 0

Maximum: 200

request_id

String

Message ID.

Minimum: 0

Maximum: 64

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

System error code, which is the detailed error code of HTTP error codes 4xx and 5xx.

Minimum: 0

Maximum: 64

error_msg

String

Error description.

Minimum: 0

Maximum: 200

request_id

String

Message ID.

Minimum: 0

Maximum: 64

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

System error code, which is the detailed error code of HTTP error codes 4xx and 5xx.

Minimum: 0

Maximum: 64

error_msg

String

Error description.

Minimum: 0

Maximum: 200

request_id

String

Message ID.

Minimum: 0

Maximum: 64

Example Requests

{
  "name" : "rule",
  "app_id" : "ef3845be-091a-4ab5-869a-9de0025e2165",
  "description" : "rule",
  "status" : 0,
  "data_parsing_status" : 0
}

Example Responses

Status code: 200

Created

{
  "permissions" : [ "read", "access", "delete", "modify" ],
  "rule_id" : 702244,
  "name" : "rule",
  "app_id" : "a1503e51-46f7-4d23-8617-7cb2d28dde98",
  "app_name" : "app-link",
  "description" : null,
  "status" : 0,
  "data_parsing_status" : 1,
  "sql_field" : null,
  "sql_where" : null,
  "rule_express" : null,
  "created_user" : {
    "user_id" : null,
    "user_name" : "user"
  },
  "last_updated_user" : {
    "user_id" : null,
    "user_name" : "user"
  },
  "created_datetime" : 1607598152997,
  "last_updated_datetime" : 1607598152997
}

Status code: 400

Bad Request

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Parameter is not valid for operation [romalink.link-rule.save]. Parameter is [request]. Processor is [body].",
  "requestId" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01"
}

Status code: 404

Not Found

{
  "error_code" : "ROMA.00110006",
  "error_msg" : "The resource does not exist. Check whether the resource ID ff38023c-0854-4779-847d-72528e1f5da5 is correct.",
  "requestId" : "72b07918-f6a2-4721-81bf-f3fd5486025e-1619663576836-cnnorth7a-P-romalink-service01"
}

Status code: 500

Internal Server Error

{
  "error_code" : "ROMA.00110002",
  "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611",
  "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01"
}

Status Codes

Status Code

Description

200

Created

400

Bad Request

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Rule Engine