1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Rule Designer
  4. Rule Management
  5. Publish a collection of rules in Testing mode

v1.0

put

/ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/publish

Publishes a collection of rules in a study, while in Testing mode.

Request

Path Parameters
  • Study mode determines the data segment being managed. Allowed values: design (draft configuration workspace), test (UAT sandbox), training (sandbox for practice data), production (live subject data).
    Example:
    test
  • Unique study identifier supplied as a UUID. Accepts either a compact 32-character hexadecimal value or a hyphenated 36-character UUID.
    Example:
    36753A48BBA048CB98A5F3278146118D
Query Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Wrapper containing the rule identifiers targeted by a bulk operation.
Show Source
Nested Schema : ruleIds
Type: array
List of rule identifiers expressed as 32 character uppercase hexadecimal strings without separators.
Show Source
  • Minimum Length: 32
    Maximum Length: 32
    Pattern: ^[0-9A-F]{32}$
    Rule identifier expressed as a 32 character uppercase hexadecimal string without separators.
    Example: 938D23FA6B7241CCA41BD627E5DB60DA
Example:
[
    "938D23FA6B7241CCA41BD627E5DB60DA",
    "699EF3745FC545589F186D2198F3C65E"
]
Examples

Back to Top

Response

Supported Media Types

200 Response

Rule published successfully.
Body ()
Root Schema : RDSRestUnifiedResponseDTO
Type: object
Unified response entry returned when bulk operations process multiple rules.
Show Source
  • RDSRestErrorDataDTO
    Standard error structure returned by Rule Designer APIs.
  • Minimum Value: 100
    Maximum Value: 599
    HTTP status code representing the operation result for this rule.
    Example: 200
  • Minimum Length: 2
    Maximum Length: 64
    Status text associated with the HTTP code.
    Example: Success
  • Minimum Length: 32
    Maximum Length: 32
    Pattern: ^[0-9A-F]{32}$
    Identifier of the asynchronous job triggered by the bulk action. Represented as a 32 character uppercase hexadecimal string without separators.
    Example: 123E4567E89B12D3A456426655440001
  • Minimum Length: 4
    Maximum Length: 16
    Allowed Values: [ "Success", "Failed", "Error", "InProgress", "Queued" ]
    Execution state of the job for this rule. `Success` indicates completion, `Failed` signals a validation problem, `Error` represents an unexpected exception, `InProgress` denotes active processing, and `Queued` means the job awaits execution.
    Example: Success
  • RDSRestResponseDTO
    Response from Rule Designer APIs
  • Minimum Length: 32
    Maximum Length: 32
    Pattern: ^[0-9A-F]{32}$
    Identifier of the rule that was processed. The value is provided as a 32 character uppercase hexadecimal string without separators.
    Example: 8E2253D8E53A4A46BAE3E4952CBE9E5A
  • Minimum Length: 3
    Maximum Length: 256
    Display name of the rule.
    Example: Out of Range Visit Date
  • Minimum Length: 1
    Maximum Length: 512
    Validation outcome message generated while processing the rule.
    Example: Rule updated successfully.
  • Allowed Values: [ true, false ]
    `true` indicates that validation succeeded for the rule, while `false` captures warnings or errors.
    Example: true
Nested Schema : RDSRestErrorDataDTO
Type: object
Standard error structure returned by Rule Designer APIs.
Show Source
  • details
    Read Only: true
    Optional diagnostic information when available.
  • Read Only: true
    Minimum Length: 3
    Maximum Length: 64
    Application specific error identifier.
    Example: RuleSvc-030
  • Read Only: true
    Minimum Length: 10
    Maximum Length: 512
    Human-readable summary explaining the error.
    Example: Error encountered during rule execution. Contact your system administrator.
  • Read Only: true
    Minimum Length: 4
    Maximum Length: 4
    Successful payload content when available; remains null for error responses.
    Example: null
  • Read Only: true
    Minimum Length: 6
    Maximum Length: 6
    Allowed Values: [ "failed" ]
    Overall outcome indicator. `failed` means the request could not be fulfilled.
    Example: failed
Example:
{
    "status":"failed",
    "result":null,
    "errorCode":"RuleSvc-030",
    "errorMessage":"Error encountered during rule execution.",
    "details":null
}
Nested Schema : RDSRestResponseDTO
Type: object
Response from Rule Designer APIs
Show Source
  • result
    Read Only: true
    Maximum Number of Properties: 2000
    Result payload when the request succeeds. Structure depends on the endpoint.
  • Read Only: true
    Minimum Length: 6
    Maximum Length: 7
    Allowed Values: [ "success", "failed" ]
    Overall outcome for the call. Allowed values: success, failed.
    Example: success
Example:
{
    "status":"success",
    "result":{
        "message":"Rule updated successfully."
    }
}
Nested Schema : details
Type: object
Read Only: true
Optional diagnostic information when available.
Example:
Validation failed for ruleId 8E2253D8E53A4A46BAE3E4952CBE9E5A.
Nested Schema : result
Type: object
Read Only: true
Maximum Number of Properties: 2000
Result payload when the request succeeds. Structure depends on the endpoint.
Example:
{
    "rules":[
    ]
}
Examples

400 Response

Returned when the request payload is missing required fields, supplies invalid identifiers, or otherwise fails validation.
Body ()
Root Schema : RDSRestUnifiedResponseDTO
Type: object
Unified response entry returned when bulk operations process multiple rules.
Show Source
  • RDSRestErrorDataDTO
    Standard error structure returned by Rule Designer APIs.
  • Minimum Value: 100
    Maximum Value: 599
    HTTP status code representing the operation result for this rule.
    Example: 200
  • Minimum Length: 2
    Maximum Length: 64
    Status text associated with the HTTP code.
    Example: Success
  • Minimum Length: 32
    Maximum Length: 32
    Pattern: ^[0-9A-F]{32}$
    Identifier of the asynchronous job triggered by the bulk action. Represented as a 32 character uppercase hexadecimal string without separators.
    Example: 123E4567E89B12D3A456426655440001
  • Minimum Length: 4
    Maximum Length: 16
    Allowed Values: [ "Success", "Failed", "Error", "InProgress", "Queued" ]
    Execution state of the job for this rule. `Success` indicates completion, `Failed` signals a validation problem, `Error` represents an unexpected exception, `InProgress` denotes active processing, and `Queued` means the job awaits execution.
    Example: Success
  • RDSRestResponseDTO
    Response from Rule Designer APIs
  • Minimum Length: 32
    Maximum Length: 32
    Pattern: ^[0-9A-F]{32}$
    Identifier of the rule that was processed. The value is provided as a 32 character uppercase hexadecimal string without separators.
    Example: 8E2253D8E53A4A46BAE3E4952CBE9E5A
  • Minimum Length: 3
    Maximum Length: 256
    Display name of the rule.
    Example: Out of Range Visit Date
  • Minimum Length: 1
    Maximum Length: 512
    Validation outcome message generated while processing the rule.
    Example: Rule updated successfully.
  • Allowed Values: [ true, false ]
    `true` indicates that validation succeeded for the rule, while `false` captures warnings or errors.
    Example: true
Nested Schema : RDSRestErrorDataDTO
Type: object
Standard error structure returned by Rule Designer APIs.
Show Source
  • details
    Read Only: true
    Optional diagnostic information when available.
  • Read Only: true
    Minimum Length: 3
    Maximum Length: 64
    Application specific error identifier.
    Example: RuleSvc-030
  • Read Only: true
    Minimum Length: 10
    Maximum Length: 512
    Human-readable summary explaining the error.
    Example: Error encountered during rule execution. Contact your system administrator.
  • Read Only: true
    Minimum Length: 4
    Maximum Length: 4
    Successful payload content when available; remains null for error responses.
    Example: null
  • Read Only: true
    Minimum Length: 6
    Maximum Length: 6
    Allowed Values: [ "failed" ]
    Overall outcome indicator. `failed` means the request could not be fulfilled.
    Example: failed
Example:
{
    "status":"failed",
    "result":null,
    "errorCode":"RuleSvc-030",
    "errorMessage":"Error encountered during rule execution.",
    "details":null
}
Nested Schema : RDSRestResponseDTO
Type: object
Response from Rule Designer APIs
Show Source
  • result
    Read Only: true
    Maximum Number of Properties: 2000
    Result payload when the request succeeds. Structure depends on the endpoint.
  • Read Only: true
    Minimum Length: 6
    Maximum Length: 7
    Allowed Values: [ "success", "failed" ]
    Overall outcome for the call. Allowed values: success, failed.
    Example: success
Example:
{
    "status":"success",
    "result":{
        "message":"Rule updated successfully."
    }
}
Nested Schema : details
Type: object
Read Only: true
Optional diagnostic information when available.
Example:
Validation failed for ruleId 8E2253D8E53A4A46BAE3E4952CBE9E5A.
Nested Schema : result
Type: object
Read Only: true
Maximum Number of Properties: 2000
Result payload when the request succeeds. Structure depends on the endpoint.
Example:
{
    "rules":[
    ]
}
Examples

500 Response

Returned when the service encounters an unexpected server-side error while processing the request.
Body ()
Root Schema : RDSRestUnifiedResponseDTO
Type: object
Unified response entry returned when bulk operations process multiple rules.
Show Source
  • RDSRestErrorDataDTO
    Standard error structure returned by Rule Designer APIs.
  • Minimum Value: 100
    Maximum Value: 599
    HTTP status code representing the operation result for this rule.
    Example: 200
  • Minimum Length: 2
    Maximum Length: 64
    Status text associated with the HTTP code.
    Example: Success
  • Minimum Length: 32
    Maximum Length: 32
    Pattern: ^[0-9A-F]{32}$
    Identifier of the asynchronous job triggered by the bulk action. Represented as a 32 character uppercase hexadecimal string without separators.
    Example: 123E4567E89B12D3A456426655440001
  • Minimum Length: 4
    Maximum Length: 16
    Allowed Values: [ "Success", "Failed", "Error", "InProgress", "Queued" ]
    Execution state of the job for this rule. `Success` indicates completion, `Failed` signals a validation problem, `Error` represents an unexpected exception, `InProgress` denotes active processing, and `Queued` means the job awaits execution.
    Example: Success
  • RDSRestResponseDTO
    Response from Rule Designer APIs
  • Minimum Length: 32
    Maximum Length: 32
    Pattern: ^[0-9A-F]{32}$
    Identifier of the rule that was processed. The value is provided as a 32 character uppercase hexadecimal string without separators.
    Example: 8E2253D8E53A4A46BAE3E4952CBE9E5A
  • Minimum Length: 3
    Maximum Length: 256
    Display name of the rule.
    Example: Out of Range Visit Date
  • Minimum Length: 1
    Maximum Length: 512
    Validation outcome message generated while processing the rule.
    Example: Rule updated successfully.
  • Allowed Values: [ true, false ]
    `true` indicates that validation succeeded for the rule, while `false` captures warnings or errors.
    Example: true
Nested Schema : RDSRestErrorDataDTO
Type: object
Standard error structure returned by Rule Designer APIs.
Show Source
  • details
    Read Only: true
    Optional diagnostic information when available.
  • Read Only: true
    Minimum Length: 3
    Maximum Length: 64
    Application specific error identifier.
    Example: RuleSvc-030
  • Read Only: true
    Minimum Length: 10
    Maximum Length: 512
    Human-readable summary explaining the error.
    Example: Error encountered during rule execution. Contact your system administrator.
  • Read Only: true
    Minimum Length: 4
    Maximum Length: 4
    Successful payload content when available; remains null for error responses.
    Example: null
  • Read Only: true
    Minimum Length: 6
    Maximum Length: 6
    Allowed Values: [ "failed" ]
    Overall outcome indicator. `failed` means the request could not be fulfilled.
    Example: failed
Example:
{
    "status":"failed",
    "result":null,
    "errorCode":"RuleSvc-030",
    "errorMessage":"Error encountered during rule execution.",
    "details":null
}
Nested Schema : RDSRestResponseDTO
Type: object
Response from Rule Designer APIs
Show Source
  • result
    Read Only: true
    Maximum Number of Properties: 2000
    Result payload when the request succeeds. Structure depends on the endpoint.
  • Read Only: true
    Minimum Length: 6
    Maximum Length: 7
    Allowed Values: [ "success", "failed" ]
    Overall outcome for the call. Allowed values: success, failed.
    Example: success
Example:
{
    "status":"success",
    "result":{
        "message":"Rule updated successfully."
    }
}
Nested Schema : details
Type: object
Read Only: true
Optional diagnostic information when available.
Example:
Validation failed for ruleId 8E2253D8E53A4A46BAE3E4952CBE9E5A.
Nested Schema : result
Type: object
Read Only: true
Maximum Number of Properties: 2000
Result payload when the request succeeds. Structure depends on the endpoint.
Example:
{
    "rules":[
    ]
}
Examples

Back to Top