Virima API Specification - RuleService Services

The requests documented in this section are directed to RuleService resources, which represent .

Contents

1 addRule POST Interface
2 editRule POST Interface
3 getRule GET Interface
4 archiveRule POST Interface

addRule POST Interface

Method: POST

Relative URL: rule/add

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
rule	Rule

Response Structure:

Field Name	Type	Description
rule	UpdateRule

Example Request:

ADDRULE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "applyOnExisting":"?",
   "applyOnFuter":"?",
   "action":[
      {
         "action":"?",
         "actionProperty":"?",
         "actionValue":"?"
      }   ],
   "criteria":[
      {
         "filterOn":"?",
         "filterOnProperty":"?",
         "filterOnValue":"?"
      }   ]
}

Example Response:

{
   "id":1938012289,
   "ruleId":"?",
   "applyOnExisting":"?",
   "applyOnFuter":"?",
   "action":[
      {
         "id":2147483647,
         "action":"?",
         "actionProperty":"?",
         "actionValue":"?"
      }   ],
   "criteria":[
      {
         "id":2147483647,
         "filterOn":"?",
         "filterOnProperty":"?",
         "filterOnValue":"?"
      }   ]
}

editRule POST Interface

Method: POST

Relative URL: rule/edit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
rule	UpdateRule

Response Structure:

Field Name	Type	Description
rule	UpdateRule

Example Request:

EDITRULE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "ruleId":"?",
   "applyOnExisting":"?",
   "applyOnFuter":"?",
   "action":[
      {
         "action":"?",
         "actionProperty":"?",
         "actionValue":"?"
      }   ],
   "criteria":[
      {
         "filterOn":"?",
         "filterOnProperty":"?",
         "filterOnValue":"?"
      }   ]
}

Example Response:

{
   "id":2147483647,
   "ruleId":"?",
   "applyOnExisting":"?",
   "applyOnFuter":"?",
   "action":[
      {
         "id":2147483647,
         "action":"?",
         "actionProperty":"?",
         "actionValue":"?"
      }   ],
   "criteria":[
      {
         "id":2147483647,
         "filterOn":"?",
         "filterOnProperty":"?",
         "filterOnValue":"?"
      }   ]
}

getRule GET Interface

Method: GET

Relative URL: rule/get

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
rules	ArrayOfRules

Example Request:

Example Response:

{
   "id":1797706925,
   "rules":[
      {
         "id":2147483647,
         "ruleId":"?",
         "applyOnExisting":"?",
         "applyOnFuter":"?",
         "action":[
            {
               "id":599287799,
               "action":"?",
               "actionProperty":"?",
               "actionValue":"?"
            }         ],
         "criteria":[
            {
               "id":2147483647,
               "filterOn":"?",
               "filterOnProperty":"?",
               "filterOnValue":"?"
            }         ]
      }   ]
}

archiveRule POST Interface

Method: POST

Relative URL: rule/archive

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
ruleId	RecordID

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ARCHIVERULE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "recordId":"?"
}

Example Response:

{
   "id":972990367,
   "response":"?"
}