REST API for Clinical One Cloud Service

v6.0

get

/ec-rule-designer-svc/rest/v6.0/rule/studies/{studyId}/{mode}/ruleId/{ruleId}

Retrieves the rule identified by the supplied rule ID, including the execution summary required by the orchestration service. Compared to v5.0, v6.0 adds job tracking fields and the origin metadata required by the asynchronous publish pipeline. This benefits users by improving publish-tracking visibility during operational support.

Request

Path Parameters

mode(required): string
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
```
ruleId(required): string(uuid)
Rule identifier. Required for path parameters targeting a single rule; optional when used as a query filter.
Example:
```
8E2253D8E53A4A46BAE3E4952CBE9E5A
```
studyId(required): string(uuid)
Unique study identifier supplied as a UUID. Accepts either a compact 32-character hexadecimal value or a hyphenated 36-character UUID.
Example:
```
123E4567E89B12D3A456426655440000
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Success.

Root Schema : RDSRestResponseDTO

Type: object

Response from Rule Designer APIs

Show Source

result: object result

Read Only: true

Maximum Number of Properties: 2000

Result payload when the request succeeds. Structure depends on the endpoint.
status: string

Read Only: true

Minimum Length: 6

Maximum Length: 7

Allowed Values: [ "success", "failed" ]

Overall outcome for the call. Allowed values: success, failed.

Example: success

{
    "type":"object",
    "properties":{
        "status":{
            "maxLength":7,
            "minLength":6,
            "type":"string",
            "description":"Overall outcome for the call. Allowed values: success, failed.",
            "readOnly":true,
            "example":"success",
            "enum":[
                "success",
                "failed"
            ]
        },
        "result":{
            "maxProperties":2000,
            "type":"object",
            "description":"Result payload when the request succeeds. Structure depends on the endpoint.",
            "readOnly":true,
            "example":{
                "rules":[
                ]
            }
        }
    },
    "description":"Response from Rule Designer APIs",
    "nullable":true,
    "example":{
        "status":"success",
        "result":{
            "message":"Rule updated successfully."
        }
    }
}

Example:

{
    "status":"success",
    "result":{
        "message":"Rule updated successfully."
    }
}

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 supplied parameters fail validation or use an unsupported combination of filter values.

Root Schema : RDSRestResponseDTO

Type: object

Response from Rule Designer APIs

Show Source

result: object result

Read Only: true

Maximum Number of Properties: 2000

Result payload when the request succeeds. Structure depends on the endpoint.
status: string

Read Only: true

Minimum Length: 6

Maximum Length: 7

Allowed Values: [ "success", "failed" ]

Overall outcome for the call. Allowed values: success, failed.

Example: success

{
    "type":"object",
    "properties":{
        "status":{
            "maxLength":7,
            "minLength":6,
            "type":"string",
            "description":"Overall outcome for the call. Allowed values: success, failed.",
            "readOnly":true,
            "example":"success",
            "enum":[
                "success",
                "failed"
            ]
        },
        "result":{
            "maxProperties":2000,
            "type":"object",
            "description":"Result payload when the request succeeds. Structure depends on the endpoint.",
            "readOnly":true,
            "example":{
                "rules":[
                ]
            }
        }
    },
    "description":"Response from Rule Designer APIs",
    "nullable":true,
    "example":{
        "status":"success",
        "result":{
            "message":"Rule updated successfully."
        }
    }
}

Example:

{
    "status":"success",
    "result":{
        "message":"Rule updated successfully."
    }
}

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 no data is available for the supplied study context or identifiers.

Root Schema : RDSRestResponseDTO

Type: object

Response from Rule Designer APIs

Show Source

result: object result

Read Only: true

Maximum Number of Properties: 2000

Result payload when the request succeeds. Structure depends on the endpoint.
status: string

Read Only: true

Minimum Length: 6

Maximum Length: 7

Allowed Values: [ "success", "failed" ]

Overall outcome for the call. Allowed values: success, failed.

Example: success

{
    "type":"object",
    "properties":{
        "status":{
            "maxLength":7,
            "minLength":6,
            "type":"string",
            "description":"Overall outcome for the call. Allowed values: success, failed.",
            "readOnly":true,
            "example":"success",
            "enum":[
                "success",
                "failed"
            ]
        },
        "result":{
            "maxProperties":2000,
            "type":"object",
            "description":"Result payload when the request succeeds. Structure depends on the endpoint.",
            "readOnly":true,
            "example":{
                "rules":[
                ]
            }
        }
    },
    "description":"Response from Rule Designer APIs",
    "nullable":true,
    "example":{
        "status":"success",
        "result":{
            "message":"Rule updated successfully."
        }
    }
}

Example:

{
    "status":"success",
    "result":{
        "message":"Rule updated successfully."
    }
}

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