Jump to

• Request
• Response

[Deprecated]: Update rules in bulk

put

/ec-rule-designer-svc/rest/v3.0/rule/studies/{studyId}/{mode}/bulkupdate

Deprecated: Use latest version instead. Updates rules in bulk for given request payload

Request

Path Parameters

• mode(required): string
  Study Mode. (Test, Training or Active)

  Example:

  test

• studyId(required): string(uuid)
  Study ID.

  Example:

  123e4567-e89b-12d3-a456-426655440000

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• rules: array rules

{
    "type":"object",
    "properties":{
        "rules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UpdateRuleDTOV3"
            }
        }
    }
}

Nested Schema : rules

Type: array

Show Source

• Array of: object UpdateRuleDTOV3
  Title: UpdateRuleDTOV3

  Information for Updating rule

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UpdateRuleDTOV3"
    }
}

Nested Schema : UpdateRuleDTOV3

Type: object

Title: UpdateRuleDTOV3

Information for Updating rule

Show Source

• actions: array actions
• aysnc: number
  Rule Exec Type

  Example: 1
• isLibrary: boolean
  Determines if rules belongs to library

  Example: true
• operands: array operands
• ruleDeleted: number
  Rule enabled flag (0:Not deleted, 1:deleted

  Example: 0
• ruleDescription: string
  Rule description

  Example: some information
• ruleEnabled: number
  Rule enabled flag (0:Not enabled, 1:enabled

  Example: 1
• ruleExpression: string
  User friendly rule expression

  Example: AgeInYears(SMARTITEM_DOB, visitDate)
• ruleId: string (uuid)
  Unique ID of rule
• ruleJSExpression: string
  For internal use only

  Example: For internal use only
• ruleName: string
  Rule name

  Example: rule name
• ruleOriginalType: string
  Maximum Length: 32

  Type of rule

  Example: UI
• ruleRefName: string
  Unique name of rule

  Example: rule_Smart_Age
• ruleState: string
  Rule state

  Example: draft
• ruleValidationMessage: string
  Rule Validation Message

  Example: validation message
• ruleValidationStatus: string
  Rule Validation Status

  Example: validation status
• ruleVersionNumber: number
  Rule Version Number

  Example: 100
• studyVersion: string
  Current study version

  Example: 1.0.0.1

{
    "title":"UpdateRuleDTOV3",
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "description":"Unique ID of rule",
            "format":"uuid"
        },
        "ruleRefName":{
            "type":"string",
            "description":"Unique name of rule",
            "example":"rule_Smart_Age"
        },
        "ruleExpression":{
            "type":"string",
            "description":"User friendly rule expression",
            "example":"AgeInYears(SMARTITEM_DOB, visitDate)"
        },
        "studyVersion":{
            "type":"string",
            "description":"Current study version",
            "example":"1.0.0.1"
        },
        "ruleEnabled":{
            "type":"number",
            "description":"Rule enabled flag (0:Not enabled, 1:enabled",
            "example":1
        },
        "ruleDeleted":{
            "type":"number",
            "description":"Rule enabled flag (0:Not deleted, 1:deleted",
            "example":0
        },
        "actions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RuleActionDTO"
            }
        },
        "operands":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RuleOperandDTO"
            }
        },
        "ruleJSExpression":{
            "type":"string",
            "description":"For internal use only",
            "example":"For internal use only"
        },
        "ruleVersionNumber":{
            "type":"number",
            "description":"Rule Version Number",
            "example":100
        },
        "ruleDescription":{
            "type":"string",
            "description":"Rule description",
            "example":"some information"
        },
        "ruleName":{
            "type":"string",
            "description":"Rule name",
            "example":"rule name"
        },
        "ruleState":{
            "type":"string",
            "description":"Rule state",
            "example":"draft"
        },
        "ruleValidationStatus":{
            "type":"string",
            "description":"Rule Validation Status",
            "example":"validation status"
        },
        "ruleValidationMessage":{
            "type":"string",
            "description":"Rule Validation Message",
            "example":"validation message"
        },
        "aysnc":{
            "type":"number",
            "description":"Rule Exec Type",
            "example":1
        },
        "ruleOriginalType":{
            "maxLength":32,
            "type":"string",
            "description":"Type of rule",
            "example":"UI"
        },
        "isLibrary":{
            "type":"boolean",
            "description":"Determines if rules belongs to library",
            "example":true
        }
    },
    "description":"Information for Updating rule"
}

Nested Schema : actions

Type: array

Show Source

• Array of: object RuleActionDTO
  Title: RuleActionDTO

  Information about action for rule

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RuleActionDTO"
    }
}

Nested Schema : operands

Type: array

Show Source

• Array of: object RuleOperandDTO
  Title: RuleOperandDTO

  Information about operands for rule

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RuleOperandDTO"
    }
}

Nested Schema : RuleActionDTO

Type: object

Title: RuleActionDTO

Information about action for rule

Show Source

• eventId: string (uuid)
  Unique ID of event
• eventRefName: string
  Visit refName

  Example: V1_Visit
• formId: string (uuid)
  Unique ID of form
• formRefName: string
  form refName

  Example: Dermatology
• itemId: string (uuid)
  Unique ID of item
• itemRefName: string
  item refName

  Example: Verbatim
• ruleActionDescription: string
  Action description

  Example: calculated value
• ruleActionOrder: number
  The order of performing this action after rule execution (0, 1, 2, ...)

  Example: 0
• ruleActionParams: string
  Action params

  Example: calculated value
• ruleActionTypeName: string
  Name of the action type: calculated values, auto query, generic calculations

  Example: calculated values

{
    "title":"RuleActionDTO",
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string",
            "description":"Unique ID of event",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "description":"Unique ID of form",
            "format":"uuid"
        },
        "itemId":{
            "type":"string",
            "description":"Unique ID of item",
            "format":"uuid"
        },
        "ruleActionTypeName":{
            "type":"string",
            "description":"Name of the action type: calculated values, auto query, generic calculations",
            "example":"calculated values"
        },
        "ruleActionOrder":{
            "type":"number",
            "description":"The order of performing this action after rule execution (0, 1, 2, ...)",
            "example":0
        },
        "eventRefName":{
            "type":"string",
            "description":"Visit refName",
            "example":"V1_Visit"
        },
        "formRefName":{
            "type":"string",
            "description":"form refName",
            "example":"Dermatology"
        },
        "itemRefName":{
            "type":"string",
            "description":"item refName",
            "example":"Verbatim"
        },
        "ruleActionDescription":{
            "type":"string",
            "description":"Action description",
            "example":"calculated value"
        },
        "ruleActionParams":{
            "type":"string",
            "description":"Action params",
            "example":"calculated value"
        }
    },
    "description":"Information about action for rule"
}

Nested Schema : RuleOperandDTO

Type: object

Title: RuleOperandDTO

Information about operands for rule

Show Source

• (Optional)eventInstanceNumber: number
  Sequence number (0, 1, 2, ...) of repeating event

  Example: 0
• dataType: string
  Data type of the operand: Date, Number, Boolean, Text, Dropdown

  Example: Date
• eventId: string (uuid)
  Unique ID of event
• eventRefName: string
  Visit refName

  Example: visit
• formId: string (uuid)
  Unique ID of form
• formRefName: string
  form refName

  Example: V1_FORM
• itemId: string (uuid)
  Unique ID of item
• itemRefName: string
  item refName

  Example: TEXT_04
• operandName(required): string
  Name of operand corresponding to the rule expression

  Example: input
• propertyName: string
  Name of study object property

  Example: visitStartDate
• propertyType: string
  Type of study object property

  Example: visit

{
    "title":"RuleOperandDTO",
    "required":[
        "operandName"
    ],
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string",
            "description":"Unique ID of event",
            "format":"uuid"
        },
        "(Optional)eventInstanceNumber":{
            "type":"number",
            "description":"Sequence number (0, 1, 2, ...) of repeating event",
            "example":0
        },
        "formId":{
            "type":"string",
            "description":"Unique ID of form",
            "format":"uuid"
        },
        "itemId":{
            "type":"string",
            "description":"Unique ID of item",
            "format":"uuid"
        },
        "propertyType":{
            "type":"string",
            "description":"Type of study object property",
            "example":"visit"
        },
        "propertyName":{
            "type":"string",
            "description":"Name of study object property",
            "example":"visitStartDate"
        },
        "operandName":{
            "type":"string",
            "description":"Name of operand corresponding to the rule expression",
            "example":"input"
        },
        "dataType":{
            "type":"string",
            "description":"Data type of the operand: Date, Number, Boolean, Text, Dropdown",
            "example":"Date"
        },
        "eventRefName":{
            "type":"string",
            "description":"Visit refName",
            "example":"visit"
        },
        "formRefName":{
            "type":"string",
            "description":"form refName",
            "example":"V1_FORM"
        },
        "itemRefName":{
            "type":"string",
            "description":"item refName",
            "example":"TEXT_04"
        }
    },
    "description":"Information about operands for rule"
}

Examples

Select an example BulkUpdateRulesDTOV3Example

Back to Top

Response

Supported Media Types

• application/json

200 Response

Bulk rule update was successful.

Body ()

Root Schema : RDSRestUnifiedResponseDTO

Type: object

Error details from Rule Designer APIs for bulk operations

Show Source

• error: object RDSRestErrorDataDTO
  Error details from Rule Designer APIs
• httpErrorCode: integer (int32)
  Http Error Code

  Example: 400
• httpErrorMessage: string
  Http Error Message

  Example: Bad Request
• jobId: string (uuid)
  Job Id
• jobStatus: string
  Job Status

  Example: IN_PROGRESS
• result: object RDSRestResponseDTO
  Response from Rule Designer APIs
• Rule Validation Message: string
  Rule Validation Message

  Example: Rule is valid
• Rule Validation Status: boolean
  Rule Validation State

  Example: true
• ruleId: string (uuid)
  Rule Id
• ruleName: string
  Rule Name

  Example: My Rule

{
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "description":"Rule Id",
            "format":"uuid"
        },
        "ruleName":{
            "type":"string",
            "description":"Rule Name",
            "example":"My Rule"
        },
        "jobId":{
            "type":"string",
            "description":"Job Id",
            "format":"uuid"
        },
        "jobStatus":{
            "type":"string",
            "description":"Job Status",
            "example":"IN_PROGRESS"
        },
        "Rule Validation Message":{
            "type":"string",
            "description":"Rule Validation Message",
            "example":"Rule is valid"
        },
        "Rule Validation Status":{
            "type":"boolean",
            "description":"Rule Validation State",
            "example":true
        },
        "result":{
            "$ref":"#/components/schemas/RDSRestResponseDTO"
        },
        "error":{
            "$ref":"#/components/schemas/RDSRestErrorDataDTO"
        },
        "httpErrorCode":{
            "type":"integer",
            "description":"Http Error Code",
            "format":"int32",
            "example":400
        },
        "httpErrorMessage":{
            "type":"string",
            "description":"Http Error Message",
            "example":"Bad Request"
        }
    },
    "description":"Error details from Rule Designer APIs for bulk operations"
}

Nested Schema : RDSRestErrorDataDTO

Type: object

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

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true
        },
        "result":{
            "type":"string",
            "description":"Result",
            "readOnly":true
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "readOnly":true
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "readOnly":true
        },
        "details":{
            "type":"object",
            "description":"Error Details",
            "readOnly":true
        }
    },
    "description":"Error details from Rule Designer APIs",
    "example":{
        "errorCode":"RULE_ERROR",
        "errorMessage":"Rule execution failed"
    }
}

Example:

{
    "errorCode":"RULE_ERROR",
    "errorMessage":"Rule execution failed"
}

Nested Schema : RDSRestResponseDTO

Type: object

Response from Rule Designer APIs

Show Source

• result: object result
  Read Only: true

  Result Object. Refer to example response for more details.
• status: string
  Read Only: true

  Allowed Values: [ "success, failed" ]

  Status

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true,
            "enum":[
                "success, failed"
            ]
        },
        "result":{
            "type":"object",
            "description":"Result Object. Refer to example response for more details.",
            "readOnly":true
        }
    },
    "description":"Response from Rule Designer APIs",
    "example":{
        "status":"success",
        "result":"Rule executed successfully"
    }
}

Example:

{
    "status":"success",
    "result":"Rule executed successfully"
}

Nested Schema : details

Type: object

Read Only: true

Error Details

Nested Schema : result

Type: object

Read Only: true

Result Object. Refer to example response for more details.

Examples

Select an example Example response for a successful bulk update rules request

400 Response

Incorrect payload.

Body ()

Root Schema : RDSRestUnifiedResponseDTO

Type: object

Error details from Rule Designer APIs for bulk operations

Show Source

• error: object RDSRestErrorDataDTO
  Error details from Rule Designer APIs
• httpErrorCode: integer (int32)
  Http Error Code

  Example: 400
• httpErrorMessage: string
  Http Error Message

  Example: Bad Request
• jobId: string (uuid)
  Job Id
• jobStatus: string
  Job Status

  Example: IN_PROGRESS
• result: object RDSRestResponseDTO
  Response from Rule Designer APIs
• Rule Validation Message: string
  Rule Validation Message

  Example: Rule is valid
• Rule Validation Status: boolean
  Rule Validation State

  Example: true
• ruleId: string (uuid)
  Rule Id
• ruleName: string
  Rule Name

  Example: My Rule

{
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "description":"Rule Id",
            "format":"uuid"
        },
        "ruleName":{
            "type":"string",
            "description":"Rule Name",
            "example":"My Rule"
        },
        "jobId":{
            "type":"string",
            "description":"Job Id",
            "format":"uuid"
        },
        "jobStatus":{
            "type":"string",
            "description":"Job Status",
            "example":"IN_PROGRESS"
        },
        "Rule Validation Message":{
            "type":"string",
            "description":"Rule Validation Message",
            "example":"Rule is valid"
        },
        "Rule Validation Status":{
            "type":"boolean",
            "description":"Rule Validation State",
            "example":true
        },
        "result":{
            "$ref":"#/components/schemas/RDSRestResponseDTO"
        },
        "error":{
            "$ref":"#/components/schemas/RDSRestErrorDataDTO"
        },
        "httpErrorCode":{
            "type":"integer",
            "description":"Http Error Code",
            "format":"int32",
            "example":400
        },
        "httpErrorMessage":{
            "type":"string",
            "description":"Http Error Message",
            "example":"Bad Request"
        }
    },
    "description":"Error details from Rule Designer APIs for bulk operations"
}

Nested Schema : RDSRestErrorDataDTO

Type: object

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

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true
        },
        "result":{
            "type":"string",
            "description":"Result",
            "readOnly":true
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "readOnly":true
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "readOnly":true
        },
        "details":{
            "type":"object",
            "description":"Error Details",
            "readOnly":true
        }
    },
    "description":"Error details from Rule Designer APIs",
    "example":{
        "errorCode":"RULE_ERROR",
        "errorMessage":"Rule execution failed"
    }
}

Example:

{
    "errorCode":"RULE_ERROR",
    "errorMessage":"Rule execution failed"
}

Nested Schema : RDSRestResponseDTO

Type: object

Response from Rule Designer APIs

Show Source

• result: object result
  Read Only: true

  Result Object. Refer to example response for more details.
• status: string
  Read Only: true

  Allowed Values: [ "success, failed" ]

  Status

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true,
            "enum":[
                "success, failed"
            ]
        },
        "result":{
            "type":"object",
            "description":"Result Object. Refer to example response for more details.",
            "readOnly":true
        }
    },
    "description":"Response from Rule Designer APIs",
    "example":{
        "status":"success",
        "result":"Rule executed successfully"
    }
}

Example:

{
    "status":"success",
    "result":"Rule executed successfully"
}

Nested Schema : details

Type: object

Read Only: true

Error Details

Nested Schema : result

Type: object

Read Only: true

Result Object. Refer to example response for more details.

500 Response

An internal error occurred.

Body ()

Root Schema : RDSRestUnifiedResponseDTO

Type: object

Error details from Rule Designer APIs for bulk operations

Show Source

• error: object RDSRestErrorDataDTO
  Error details from Rule Designer APIs
• httpErrorCode: integer (int32)
  Http Error Code

  Example: 400
• httpErrorMessage: string
  Http Error Message

  Example: Bad Request
• jobId: string (uuid)
  Job Id
• jobStatus: string
  Job Status

  Example: IN_PROGRESS
• result: object RDSRestResponseDTO
  Response from Rule Designer APIs
• Rule Validation Message: string
  Rule Validation Message

  Example: Rule is valid
• Rule Validation Status: boolean
  Rule Validation State

  Example: true
• ruleId: string (uuid)
  Rule Id
• ruleName: string
  Rule Name

  Example: My Rule

{
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "description":"Rule Id",
            "format":"uuid"
        },
        "ruleName":{
            "type":"string",
            "description":"Rule Name",
            "example":"My Rule"
        },
        "jobId":{
            "type":"string",
            "description":"Job Id",
            "format":"uuid"
        },
        "jobStatus":{
            "type":"string",
            "description":"Job Status",
            "example":"IN_PROGRESS"
        },
        "Rule Validation Message":{
            "type":"string",
            "description":"Rule Validation Message",
            "example":"Rule is valid"
        },
        "Rule Validation Status":{
            "type":"boolean",
            "description":"Rule Validation State",
            "example":true
        },
        "result":{
            "$ref":"#/components/schemas/RDSRestResponseDTO"
        },
        "error":{
            "$ref":"#/components/schemas/RDSRestErrorDataDTO"
        },
        "httpErrorCode":{
            "type":"integer",
            "description":"Http Error Code",
            "format":"int32",
            "example":400
        },
        "httpErrorMessage":{
            "type":"string",
            "description":"Http Error Message",
            "example":"Bad Request"
        }
    },
    "description":"Error details from Rule Designer APIs for bulk operations"
}

Nested Schema : RDSRestErrorDataDTO

Type: object

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

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true
        },
        "result":{
            "type":"string",
            "description":"Result",
            "readOnly":true
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "readOnly":true
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "readOnly":true
        },
        "details":{
            "type":"object",
            "description":"Error Details",
            "readOnly":true
        }
    },
    "description":"Error details from Rule Designer APIs",
    "example":{
        "errorCode":"RULE_ERROR",
        "errorMessage":"Rule execution failed"
    }
}

Example:

{
    "errorCode":"RULE_ERROR",
    "errorMessage":"Rule execution failed"
}

Nested Schema : RDSRestResponseDTO

Type: object

Response from Rule Designer APIs

Show Source

• result: object result
  Read Only: true

  Result Object. Refer to example response for more details.
• status: string
  Read Only: true

  Allowed Values: [ "success, failed" ]

  Status

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true,
            "enum":[
                "success, failed"
            ]
        },
        "result":{
            "type":"object",
            "description":"Result Object. Refer to example response for more details.",
            "readOnly":true
        }
    },
    "description":"Response from Rule Designer APIs",
    "example":{
        "status":"success",
        "result":"Rule executed successfully"
    }
}

Example:

{
    "status":"success",
    "result":"Rule executed successfully"
}

Nested Schema : details

Type: object

Read Only: true

Error Details

Nested Schema : result

Type: object

Read Only: true

Result Object. Refer to example response for more details.

Back to Top