Update rules in bulk
put
/ec-rule-designer-svc/rest/v4.0/rule/studies/{studyId}/{mode}/bulkupdate
Updates rules in bulk.
Request
Path Parameters
-
mode(required): string
Study Mode
-
studyId(required): string(uuid)
Study Id
Supported Media Types
- application/json
Nested Schema : rules
Type:
Show Source
array
-
Array of:
object UpdateRuleDTOV3
Title:
UpdateRuleDTOV3
Information for Updating rule
Nested Schema : UpdateRuleDTOV3
Type:
object
Title:
UpdateRuleDTOV3
Information for Updating rule
Show Source
-
actions: array
actions
-
aysnc: number
Rule Exec TypeExample:
1
-
isLibrary: boolean
Determines if rules belongs to libraryExample:
true
-
operands: array
operands
-
ruleDeleted: number
Rule enabled flag (0:Not deleted, 1:deletedExample:
0
-
ruleDescription: string
Rule descriptionExample:
some information
-
ruleEnabled: number
Rule enabled flag (0:Not enabled, 1:enabledExample:
1
-
ruleExpression: string
User friendly rule expressionExample:
AgeInYears(SMARTITEM_DOB, visitDate)
-
ruleId: string
(uuid)
Unique ID of rule
-
ruleJSExpression: string
For internal use onlyExample:
For internal use only
-
ruleName: string
Rule nameExample:
rule name
-
ruleOriginalType: string
Maximum Length:
32
Type of ruleExample:UI
-
ruleRefName: string
Unique name of ruleExample:
rule_Smart_Age
-
ruleState: string
Rule stateExample:
draft
-
ruleValidationMessage: string
Rule Validation MessageExample:
validation message
-
ruleValidationStatus: string
Rule Validation StatusExample:
validation status
-
ruleVersionNumber: number
Rule Version NumberExample:
100
-
studyVersion: string
Current study versionExample:
1.0.0.1
Nested Schema : actions
Type:
Show Source
array
-
Array of:
object RuleActionDTO
Title:
RuleActionDTO
Information about action for rule
Nested Schema : operands
Type:
Show Source
array
-
Array of:
object RuleOperandDTO
Title:
RuleOperandDTO
Information about operands for rule
Nested Schema : RuleActionDTO
Type:
object
Title:
RuleActionDTO
Information about action for rule
Show Source
-
eventId: string
(uuid)
Unique ID of event
-
eventRefName: string
Visit refNameExample:
visit
-
formId: string
(uuid)
Unique ID of form
-
formRefName: string
form refNameExample:
form
-
itemId: string
(uuid)
Unique ID of item
-
itemRefName: string
item refNameExample:
item
-
ruleActionDescription: string
Action descriptionExample:
calculated value
-
ruleActionOrder: number
The order of performing this action after rule execution (0, 1, 2, ...)Example:
0
-
ruleActionParams: string
Action paramsExample:
calculated value
-
ruleActionTypeName: string
Name of the action type: calculated values, auto query, generic calculationsExample:
calculated values
Nested Schema : RuleOperandDTO
Type:
object
Title:
RuleOperandDTO
Information about operands for rule
Show Source
-
dataType: string
Data type of the operand: Date, Number, Boolean, Text, DropdownExample:
Date
-
eventId: string
(uuid)
Unique ID of event
-
eventInstanceNumber: number
Sequence number (0, 1, 2, ...) of repeating eventExample:
0
-
eventRefName: string
Visit refNameExample:
visit
-
formId: string
(uuid)
Unique ID of form
-
formRefName: string
form refNameExample:
form
-
itemId: string
(uuid)
Unique ID of item
-
itemRefName: string
item refNameExample:
item
-
operandName(required): string
Name of operand corresponding to the rule expressionExample:
visitDate
-
propertyName: string
Name of study object propertyExample:
visitStartDate
-
propertyType: string
Type of study object propertyExample:
visit
Response
Supported Media Types
- application/json
200 Response
Bulk rule update was successful.
Root Schema : RDSRestUnifiedResponseDTO
Type:
object
Error details from Rule Designer APIs for bulk operations
Show Source
-
error: object
RDSRestErrorDataDTO
Read Only:
true
Error details from Rule Designer APIs -
httpErrorCode: integer
(int32)
Read Only:
true
Http Error Code -
httpErrorMessage: string
Read Only:
true
Http Error Message -
jobId: string
(uuid)
Read Only:
true
Job Id -
jobStatus: string
Read Only:
true
Job Status -
result: object
RDSRestResponseDTO
Read Only:
true
Response from Rule Designer APIs -
Rule Validation Message: string
Read Only:
true
Rule Validation Message -
Rule Validation Status: boolean
Read Only:
true
Rule Validation State -
ruleId: string
(uuid)
Read Only:
true
Rule Id -
ruleName: string
Read Only:
true
Rule Name
Nested Schema : RDSRestErrorDataDTO
Type:
object
Read Only:
true
Error details from Rule Designer APIs
Show Source
-
details: object
details
Read Only:
true
Error Details -
errorCode: string
Read Only:
true
Error Code -
errorMessage: string
Read Only:
true
Error Message -
result: string
Read Only:
true
Result -
status: string
Read Only:
true
Status
Nested Schema : RDSRestResponseDTO
Type:
object
Read Only:
true
Response from Rule Designer APIs
Show Source
-
result: object
result
Read Only:
true
Result Object -
status: string
Read Only:
true
Allowed Values:[ "success, failed" ]
Status
Nested Schema : details
Type:
object
Read Only:
true
Error Details
Nested Schema : result
Type:
object
Read Only:
true
Result Object
400 Response
Incorrect payload.
Root Schema : RDSRestUnifiedResponseDTO
Type:
object
Error details from Rule Designer APIs for bulk operations
Show Source
-
error: object
RDSRestErrorDataDTO
Read Only:
true
Error details from Rule Designer APIs -
httpErrorCode: integer
(int32)
Read Only:
true
Http Error Code -
httpErrorMessage: string
Read Only:
true
Http Error Message -
jobId: string
(uuid)
Read Only:
true
Job Id -
jobStatus: string
Read Only:
true
Job Status -
result: object
RDSRestResponseDTO
Read Only:
true
Response from Rule Designer APIs -
Rule Validation Message: string
Read Only:
true
Rule Validation Message -
Rule Validation Status: boolean
Read Only:
true
Rule Validation State -
ruleId: string
(uuid)
Read Only:
true
Rule Id -
ruleName: string
Read Only:
true
Rule Name
Nested Schema : RDSRestErrorDataDTO
Type:
object
Read Only:
true
Error details from Rule Designer APIs
Show Source
-
details: object
details
Read Only:
true
Error Details -
errorCode: string
Read Only:
true
Error Code -
errorMessage: string
Read Only:
true
Error Message -
result: string
Read Only:
true
Result -
status: string
Read Only:
true
Status
Nested Schema : RDSRestResponseDTO
Type:
object
Read Only:
true
Response from Rule Designer APIs
Show Source
-
result: object
result
Read Only:
true
Result Object -
status: string
Read Only:
true
Allowed Values:[ "success, failed" ]
Status
Nested Schema : details
Type:
object
Read Only:
true
Error Details
Nested Schema : result
Type:
object
Read Only:
true
Result Object
500 Response
An internal error occured.
Root Schema : RDSRestUnifiedResponseDTO
Type:
object
Error details from Rule Designer APIs for bulk operations
Show Source
-
error: object
RDSRestErrorDataDTO
Read Only:
true
Error details from Rule Designer APIs -
httpErrorCode: integer
(int32)
Read Only:
true
Http Error Code -
httpErrorMessage: string
Read Only:
true
Http Error Message -
jobId: string
(uuid)
Read Only:
true
Job Id -
jobStatus: string
Read Only:
true
Job Status -
result: object
RDSRestResponseDTO
Read Only:
true
Response from Rule Designer APIs -
Rule Validation Message: string
Read Only:
true
Rule Validation Message -
Rule Validation Status: boolean
Read Only:
true
Rule Validation State -
ruleId: string
(uuid)
Read Only:
true
Rule Id -
ruleName: string
Read Only:
true
Rule Name
Nested Schema : RDSRestErrorDataDTO
Type:
object
Read Only:
true
Error details from Rule Designer APIs
Show Source
-
details: object
details
Read Only:
true
Error Details -
errorCode: string
Read Only:
true
Error Code -
errorMessage: string
Read Only:
true
Error Message -
result: string
Read Only:
true
Result -
status: string
Read Only:
true
Status
Nested Schema : RDSRestResponseDTO
Type:
object
Read Only:
true
Response from Rule Designer APIs
Show Source
-
result: object
result
Read Only:
true
Result Object -
status: string
Read Only:
true
Allowed Values:[ "success, failed" ]
Status
Nested Schema : details
Type:
object
Read Only:
true
Error Details
Nested Schema : result
Type:
object
Read Only:
true
Result Object