REST API for Clinical One Platform

Debug a rule

put

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

Debug a rule for provided subject.

Request

Path Parameters

mode(required): string

Study Mode
studyId(required): string

Study Id

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

ruleId: string
siteId: string
studyId: string
studyName: string
subjectId: string

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "ruleId":{
            "type":"string"
        },
        "studyName":{
            "type":"string"
        },
        "studyId":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Rule execution was successful.

Root Schema : ResponseDebugRuleTO

Type: object

Show Source

debugResult: array debugResult
status: string

{
    "type":"object",
    "properties":{
        "debugResult":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DebugMessageTO"
            }
        },
        "status":{
            "type":"string"
        }
    }
}

Nested Schema : debugResult

Type: array

Show Source

Array of: object DebugMessageTO

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DebugMessageTO"
    }
}

Nested Schema : DebugMessageTO

Type: object

Show Source

debugMessages: array debugMessages
executionPath: object DebugExecutionPathTO

{
    "type":"object",
    "properties":{
        "executionPath":{
            "$ref":"#/components/schemas/DebugExecutionPathTO"
        },
        "debugMessages":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DebugInfoTO"
            }
        }
    }
}

Nested Schema : debugMessages

Type: array

Show Source

Array of: object DebugInfoTO

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DebugInfoTO"
    }
}

Nested Schema : DebugExecutionPathTO

Type: object

Show Source

event: string
eventInstanceNumber: string
formSection: string
tableRow: string

{
    "type":"object",
    "properties":{
        "event":{
            "type":"string"
        },
        "eventInstanceNumber":{
            "type":"string"
        },
        "tableRow":{
            "type":"string"
        },
        "formSection":{
            "type":"string"
        }
    }
}

Nested Schema : DebugInfoTO

Type: object

Show Source

debugMessage: string
messageType: string

{
    "type":"object",
    "properties":{
        "debugMessage":{
            "type":"string"
        },
        "messageType":{
            "type":"string"
        }
    }
}

400 Response

Incorrect payload

Root Schema : ResponseDebugRuleTO

Type: object

Show Source

debugResult: array debugResult
status: string

{
    "type":"object",
    "properties":{
        "debugResult":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DebugMessageTO"
            }
        },
        "status":{
            "type":"string"
        }
    }
}

Nested Schema : debugResult

Type: array

Show Source

Array of: object DebugMessageTO

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DebugMessageTO"
    }
}

Nested Schema : DebugMessageTO

Type: object

Show Source

debugMessages: array debugMessages
executionPath: object DebugExecutionPathTO

{
    "type":"object",
    "properties":{
        "executionPath":{
            "$ref":"#/components/schemas/DebugExecutionPathTO"
        },
        "debugMessages":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DebugInfoTO"
            }
        }
    }
}

Nested Schema : debugMessages

Type: array

Show Source

Array of: object DebugInfoTO

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DebugInfoTO"
    }
}

Nested Schema : DebugExecutionPathTO

Type: object

Show Source

event: string
eventInstanceNumber: string
formSection: string
tableRow: string

{
    "type":"object",
    "properties":{
        "event":{
            "type":"string"
        },
        "eventInstanceNumber":{
            "type":"string"
        },
        "tableRow":{
            "type":"string"
        },
        "formSection":{
            "type":"string"
        }
    }
}

Nested Schema : DebugInfoTO

Type: object

Show Source

debugMessage: string
messageType: string

{
    "type":"object",
    "properties":{
        "debugMessage":{
            "type":"string"
        },
        "messageType":{
            "type":"string"
        }
    }
}

500 Response

An internal error occured

Root Schema : ResponseDebugRuleTO

Type: object

Show Source

debugResult: array debugResult
status: string

{
    "type":"object",
    "properties":{
        "debugResult":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DebugMessageTO"
            }
        },
        "status":{
            "type":"string"
        }
    }
}

Nested Schema : debugResult

Type: array

Show Source

Array of: object DebugMessageTO

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DebugMessageTO"
    }
}

Nested Schema : DebugMessageTO

Type: object

Show Source

debugMessages: array debugMessages
executionPath: object DebugExecutionPathTO

{
    "type":"object",
    "properties":{
        "executionPath":{
            "$ref":"#/components/schemas/DebugExecutionPathTO"
        },
        "debugMessages":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DebugInfoTO"
            }
        }
    }
}

Nested Schema : debugMessages

Type: array

Show Source

Array of: object DebugInfoTO

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DebugInfoTO"
    }
}

Nested Schema : DebugExecutionPathTO

Type: object

Show Source

event: string
eventInstanceNumber: string
formSection: string
tableRow: string

{
    "type":"object",
    "properties":{
        "event":{
            "type":"string"
        },
        "eventInstanceNumber":{
            "type":"string"
        },
        "tableRow":{
            "type":"string"
        },
        "formSection":{
            "type":"string"
        }
    }
}

Nested Schema : DebugInfoTO

Type: object

Show Source

debugMessage: string
messageType: string

{
    "type":"object",
    "properties":{
        "debugMessage":{
            "type":"string"
        },
        "messageType":{
            "type":"string"
        }
    }
}