REST API for Clinical One Cloud Service

v1.0

put

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

Disables all notification rules for a given study. The rules in all the study modes are disabled.

Request

Path Parameters

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:
```
36753A48BBA048CB98A5F3278146118D
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Rule copy was successful.

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 the service encounters an unexpected server-side error while processing the request.

Root Schema : RDSRestErrorDataDTO

Type: object

Standard error structure returned by Rule Designer APIs.

Show Source

details: object details

Read Only: true

Optional diagnostic information when available.
errorCode: string

Read Only: true

Minimum Length: 3

Maximum Length: 64

Application specific error identifier.

Example: RuleSvc-030
errorMessage: string

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.
result: string

Read Only: true

Minimum Length: 4

Maximum Length: 4

Successful payload content when available; remains null for error responses.

Example: null
status: string

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

{
    "type":"object",
    "properties":{
        "status":{
            "maxLength":6,
            "minLength":6,
            "type":"string",
            "description":"Overall outcome indicator. `failed` means the request could not be fulfilled.",
            "readOnly":true,
            "example":"failed",
            "enum":[
                "failed"
            ]
        },
        "result":{
            "maxLength":4,
            "minLength":4,
            "type":"string",
            "description":"Successful payload content when available; remains null for error responses.",
            "nullable":true,
            "readOnly":true,
            "example":"null"
        },
        "errorCode":{
            "maxLength":64,
            "minLength":3,
            "type":"string",
            "description":"Application specific error identifier.",
            "readOnly":true,
            "example":"RuleSvc-030"
        },
        "errorMessage":{
            "maxLength":512,
            "minLength":10,
            "type":"string",
            "description":"Human-readable summary explaining the error.",
            "readOnly":true,
            "example":"Error encountered during rule execution. Contact your system administrator."
        },
        "details":{
            "type":"object",
            "description":"Optional diagnostic information when available.",
            "nullable":true,
            "readOnly":true,
            "example":"Validation failed for ruleId 8E2253D8E53A4A46BAE3E4952CBE9E5A."
        }
    },
    "description":"Standard error structure returned by Rule Designer APIs.",
    "nullable":true,
    "example":{
        "status":"failed",
        "result":null,
        "errorCode":"RuleSvc-030",
        "errorMessage":"Error encountered during rule execution.",
        "details":null
    }
}

Example:

{
    "status":"failed",
    "result":null,
    "errorCode":"RuleSvc-030",
    "errorMessage":"Error encountered during rule execution.",
    "details":null
}

Nested Schema : details

Type: object

Read Only: true

Optional diagnostic information when available.

Example:

Validation failed for ruleId 8E2253D8E53A4A46BAE3E4952CBE9E5A.

Examples