REST API for Clinical One Platform

v1.0 REST Endpoints

Rules/Rule Management/v1.0

The operations from the Rules/Rule Management/v1.0 category.

~~[Deprecated]: Copy rules in bulk~~: Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/bulkcopy
~~[Deprecated]: Copy Rules to newly copied study~~: Method: post
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/copyrules
~~[Deprecated]: Get all rules based on given parameters~~: Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/simple
~~[Deprecated]: Get rule by item ID~~: Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/item/{itemId}
~~[Deprecated]: Get rule by property~~: Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/propertyType/{propertyType}
~~[Deprecated]: Get rule by rule ID~~: Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/ruleId/{ruleId}
~~[Deprecated]: Job Status rules~~: Method: put
Path: /ec-rule-svc/rest/v1.0/studies/{studyId}/{mode}/jobStatus
~~[Deprecated]: Update rules in bulk~~: Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/bulkupdate
Allow rules to run on All or Future data: Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rulemgt/studies/{studyId}/{mode}/{publishRun}
Cancel rule jobs: Method: put
Path: /ec-rule-svc/rest/v1.0/studies/{studyId}/{mode}/cancelRuleJob
Copy all rules from one study mode to another: Method: post
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/copy
Debug a rule: Method: put
Path: /ec-rule-svc/rest/v1.0/studies/{studyId}/{mode}/debugRule
Delete rules in bulk: Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/bulkdelete
Delete UI rules by form ID: Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/delete/form/{formId}
Disable All notification rules: Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/disableAllNotificationRules
Enable or disable rule: Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/{ruleStatus}
Get all rule states: Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/rulestates
Get all rules based on filter parameters: Method: post
Path: /ec-rule-designer-svc/rest/v1.0/rulemgt/studies/{studyId}/{mode}/filteredlist
Get multiple parameters of all rules in a study: Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/rulenames
Get rule by form ID: Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/form/{formId}
Get rule history by study ID, ruleid and optionally study mode: Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rulemgt/studies/{studyId}/{ruleId}/rulehistory
Get rule Operands list by rule IDs: Method: post
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/ruleIds/operands
Get rule re-run history: Method: get
Path: /ec-rule-svc/rest/v1.0/studies/{studyId}/{mode}/rerunhistory/{ruleId}
Get rules by form ID which are in both valid and enabled states: Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/form/{formId}/valid
Get rules by study ID and study mode: Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}
Get visits and forms actions information: Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/versions/{version}/formId/{formId}
Publish a collection of rules in Testing mode: Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/publish
Update rule states in bulk: Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/from/{fromState}/to/{toState}/bulkstateupdate
Validate copied rules: Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/validateCopiedRules