1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Rule Designer
  4. Rule Management
  5. Copy Rules to newly copied study

v2.0

post

/ec-rule-designer-svc/rest/v2.0/rule/studies/{studyId}/copyrules

Copies all active rules from the specified source study to the target study. Compared to v1.0, v2.0 records asynchronous job identifiers, validates new UUID conversion helpers, and supports the enhanced Audit payload returned by the designer service. This benefits users by providing deterministic tracking for cross-study copy operations.

Request

Path Parameters
  • Unique study identifier supplied as a UUID. Accepts either a compact 32-character hexadecimal value or a hyphenated 36-character UUID.
    Example:
    36753A48BBA048CB98A5F3278146118D
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Version 3 study mapping definition used for rule copy operations.
Show Source
Nested Schema : forms
Type: array
Form mappings used during the version 3 copy.
Show Source
Example:
[
    {
        "fromFormId":"39903D6C042D4D9E89773160488E6D3D",
        "fromFormRefName":"SCR_VISIT",
        "toFormId":"5A8E2C7D6B4F439AA3BD1E0F8C6A9D34",
        "toFormRefName":"SCR_VISIT_V2"
    }
]
Nested Schema : FormMapDTO
Type: object
Defines how a source form maps to a target form during rule copy operations.
Show Source
  • Minimum Length: 32
    Maximum Length: 32
    Pattern: ^[0-9A-F]{32}$
    Source form identifier expressed as a 32-character uppercase hexadecimal UUID without separators.
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: ^[A-Z0-9_]+$
    Reference name of the source form. Use uppercase letters, numbers, and underscores.
    Example: SCR_VISIT
  • items
    Item mappings for operands and targets associated with the form.
  • Minimum Length: 32
    Maximum Length: 32
    Pattern: ^[0-9A-F]{32}$
    Target form identifier expressed as a 32-character uppercase hexadecimal UUID without separators.
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: ^[A-Z0-9_]+$
    Reference name of the target form. Use uppercase letters, numbers, and underscores.
    Example: SCR_VISIT_V2
Example:
{
    "fromFormId":"39903D6C042D4D9E89773160488E6D3D",
    "toFormId":"5A8E2C7D6B4F439AA3BD1E0F8C6A9D34"
}
Nested Schema : items
Type: array
Item mappings for operands and targets associated with the form.
Show Source
Example:
[
    {
        "fromItemId":"90C7669C40BF4371B71E8EB26851B8AD",
        "fromItemRefName":"VISIT_DATE",
        "toItemId":"1C9E4A6B8D2F43E7A1B0C5D6F8A9E321",
        "toItemRefName":"VISIT_DATE_V2"
    }
]
Nested Schema : ItemMapDTO
Type: object
Describes how a source item maps to a target item when copying rules.
Show Source
  • Minimum Length: 32
    Maximum Length: 32
    Pattern: ^[0-9A-F]{32}$
    Source item identifier expressed as a 32-character uppercase hexadecimal UUID without separators.
  • Minimum Length: 3
    Maximum Length: 128
    Pattern: ^[A-Z0-9_]+$
    Source item reference name. Use uppercase letters, numbers, and underscores.
    Example: VISIT_DATE
  • Minimum Length: 32
    Maximum Length: 32
    Pattern: ^[0-9A-F]{32}$
    Target item identifier expressed as a 32-character uppercase hexadecimal UUID without separators.
  • Minimum Length: 3
    Maximum Length: 128
    Pattern: ^[A-Z0-9_]+$
    Target item reference name. Use uppercase letters, numbers, and underscores.
    Example: VISIT_DATE_V2
Example:
{
    "fromItemId":"90C7669C40BF4371B71E8EB26851B8AD",
    "toItemId":"1C9E4A6B8D2F43E7A1B0C5D6F8A9E321"
}
Examples

Back to Top

Response

Supported Media Types

202 Response

Success.
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