REST API for Clinical One Platform

Allow rules to run on All or Future data

put

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

Updates rules in a study to execute, when published, for either all or future data only.

Request

Path Parameters

mode(required): string

Study Mode
publishRun(required): string

AllData:alldata / FutureData:futuredata
studyId(required): string(uuid)

Study Id

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

ruleIds(required): array ruleIds

list of Rule Unique GUIDs

{
    "required":[
        "ruleIds"
    ],
    "type":"object",
    "properties":{
        "ruleIds":{
            "type":"array",
            "description":"list of Rule Unique GUIDs",
            "format":"uuid",
            "example":[
                "938D23FA6B7241CCA41BD627E5DB60DA",
                "699EF3745FC545589F186D2198F3C65E"
            ],
            "items":{
                "type":"string",
                "description":"list of Rule Unique GUIDs",
                "format":"uuid"
            }
        }
    }
}

Nested Schema : ruleIds

Type: array

list of Rule Unique GUIDs

Show Source

Array of: string(uuid)

list of Rule Unique GUIDs

{
    "type":"array",
    "description":"list of Rule Unique GUIDs",
    "format":"uuid",
    "example":[
        "938D23FA6B7241CCA41BD627E5DB60DA",
        "699EF3745FC545589F186D2198F3C65E"
    ],
    "items":{
        "type":"string",
        "description":"list of Rule Unique GUIDs",
        "format":"uuid"
    }
}

Example:

[
    "938D23FA6B7241CCA41BD627E5DB60DA",
    "699EF3745FC545589F186D2198F3C65E"
]

Response

Supported Media Types

application/json

200 Response

Rule enable/disable was successful.

Root Schema : RDSRestUnifiedResponseDTO

Type: object

Error details from Rule Designer APIs for bulk operations

Show Source

error: object RDSRestErrorDataDTO

Read Only: true

Error details from Rule Designer APIs
httpErrorCode: integer (int32)

Read Only: true

Http Error Code
httpErrorMessage: string

Read Only: true

Http Error Message
jobId: string (uuid)

Read Only: true

Job Id
jobStatus: string

Read Only: true

Job Status
result: object RDSRestResponseDTO

Read Only: true

Response from Rule Designer APIs
Rule Validation Message: string

Read Only: true

Rule Validation Message
Rule Validation Status: boolean

Read Only: true

Rule Validation State
ruleId: string (uuid)

Read Only: true

Rule Id
ruleName: string

Read Only: true

Rule Name

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

Nested Schema : RDSRestErrorDataDTO

Type: object

Read Only: true

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",
    "readOnly":true
}

Nested Schema : RDSRestResponseDTO

Type: object

Read Only: true

Response from Rule Designer APIs

Show Source

result: object result

Read Only: true

Result Object
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",
            "readOnly":true
        }
    },
    "description":"Response from Rule Designer APIs",
    "readOnly":true
}

Nested Schema : details

Type: object

Read Only: true

Error Details

Nested Schema : result

Type: object

Read Only: true

Result Object

400 Response

Incorrect payload.

Root Schema : RDSRestUnifiedResponseDTO

Type: object

Error details from Rule Designer APIs for bulk operations

Show Source

error: object RDSRestErrorDataDTO

Read Only: true

Error details from Rule Designer APIs
httpErrorCode: integer (int32)

Read Only: true

Http Error Code
httpErrorMessage: string

Read Only: true

Http Error Message
jobId: string (uuid)

Read Only: true

Job Id
jobStatus: string

Read Only: true

Job Status
result: object RDSRestResponseDTO

Read Only: true

Response from Rule Designer APIs
Rule Validation Message: string

Read Only: true

Rule Validation Message
Rule Validation Status: boolean

Read Only: true

Rule Validation State
ruleId: string (uuid)

Read Only: true

Rule Id
ruleName: string

Read Only: true

Rule Name

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

Nested Schema : RDSRestErrorDataDTO

Type: object

Read Only: true

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",
    "readOnly":true
}

Nested Schema : RDSRestResponseDTO

Type: object

Read Only: true

Response from Rule Designer APIs

Show Source

result: object result

Read Only: true

Result Object
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",
            "readOnly":true
        }
    },
    "description":"Response from Rule Designer APIs",
    "readOnly":true
}

Nested Schema : details

Type: object

Read Only: true

Error Details

Nested Schema : result

Type: object

Read Only: true

Result Object

500 Response

An internal error occured.

Root Schema : RDSRestUnifiedResponseDTO

Type: object

Error details from Rule Designer APIs for bulk operations

Show Source

error: object RDSRestErrorDataDTO

Read Only: true

Error details from Rule Designer APIs
httpErrorCode: integer (int32)

Read Only: true

Http Error Code
httpErrorMessage: string

Read Only: true

Http Error Message
jobId: string (uuid)

Read Only: true

Job Id
jobStatus: string

Read Only: true

Job Status
result: object RDSRestResponseDTO

Read Only: true

Response from Rule Designer APIs
Rule Validation Message: string

Read Only: true

Rule Validation Message
Rule Validation Status: boolean

Read Only: true

Rule Validation State
ruleId: string (uuid)

Read Only: true

Rule Id
ruleName: string

Read Only: true

Rule Name

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

Nested Schema : RDSRestErrorDataDTO

Type: object

Read Only: true

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",
    "readOnly":true
}

Nested Schema : RDSRestResponseDTO

Type: object

Read Only: true

Response from Rule Designer APIs

Show Source

result: object result

Read Only: true

Result Object
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",
            "readOnly":true
        }
    },
    "description":"Response from Rule Designer APIs",
    "readOnly":true
}

Nested Schema : details

Type: object

Read Only: true

Error Details

Nested Schema : result

Type: object

Read Only: true

Result Object